Home Hierarchy Members Alphabetical Related Pages

lod.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_LOD_H
00002 #define XDKWRL_LOD_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mffloat.h>
00007 #include <xdkwrl/fieldtypes/mfnode.h>
00008 #include <xdkwrl/fieldtypes/sfvec3f.h>
00009 
00010 namespace wrl
00011 {
00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00013   // Interface of LOD
00014   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00015   class XDKWRL_EXPORT LOD : public Node
00016   {
00017    public:
00018      LOD(const char* name="");
00019      virtual ~LOD();
00020      virtual inline unsigned int nbFields() const;
00021      virtual FieldHandle field(const std::string& n);
00022      virtual FieldHandle field(unsigned int i);
00023      virtual bool isSetToDefaultValue(unsigned int i) const;
00024      virtual inline unsigned int nbEventsIn() const;
00025      virtual EventInHandle eventIn(const std::string& n);
00026      virtual EventInHandle eventIn(unsigned int i);
00027      virtual inline unsigned int nbEventsOut() const;
00028      virtual EventOutHandle eventOut(const std::string& n);
00029      virtual EventOutHandle eventOut(unsigned int i);
00030      inline const char* typeName() const;
00031      virtual Node* duplicate() const;
00032      virtual Node* duplicate(std::map<const Node*,Node*>&) const;
00033      /*!@name Exposed Fields
00034       * A field that is capable of receiving events via an eventIn to 
00035       * change its value(s), and generating events via an eventOut 
00036       * when its value(s) change.
00037       */
00038       //!@{
00039       /*!
00040        * See <a href="#_details" class="md">Detailed Description</a>
00041        * for meaning of this field.
00042        * Default value is set to MFNode default value
00043        */
00044        MFNode     level;
00045      //!@}
00046      /*!@name Fields
00047       * A property or attribute of a node. Each node type has a fixed set
00048       * of fields. Fields may contain various kinds of data and one or many
00049       * values. Each field has a default value.
00050       */
00051       //!@{
00052       /*!
00053        * See <a href="#_details" class="md">Detailed Description</a>
00054        * for meaning of this field.
00055        * Default value is set to 
00056        \code
00057        center.setXYZ(0,0,0);
00058         \endcode
00059        */
00060        SFVec3f    center;
00061       /*!
00062        * See <a href="#_details" class="md">Detailed Description</a>
00063        * for meaning of this field.
00064        * Default value is set to MFFloat default value
00065        */
00066        MFFloat    range;
00067      //!@}
00068      /*!@name Events In
00069       * 
00070       */
00071       //!@{
00072       /*!
00073        * Set event associated to exposedField level
00074        */
00075        EventIn<MFNode>     set_level;
00076   //!@}
00077      /*!@name Events Out
00078       * 
00079       */
00080       //!@{
00081       /*!
00082        * Changed event associated to exposedField level
00083        */
00084        EventOut<MFNode>     level_changed;
00085   //!@}
00086   };
00087 };
00088 //************************************************************
00089 // Implementation of LOD
00090 //************************************************************
00091 /*!
00092  * Returns <code>"LOD"</code>. Useful for printing.
00093  */
00094 inline const char*
00095 wrl::LOD::typeName() const
00096 {
00097   return "LOD";
00098 }
00099 /*!
00100  * Returns the number of fields (exposed or not) for this node type.
00101  */
00102 inline unsigned int
00103 wrl::LOD::nbFields() const
00104 {
00105    return 3;
00106 }
00107 /*!
00108  * Returns the number of events in for this node type.
00109  */
00110 inline unsigned int
00111 wrl::LOD::nbEventsIn() const
00112 {
00113    return 0;
00114 }
00115 /*!
00116  * Returns the number of events out for this node type.
00117  */
00118 inline unsigned int
00119 wrl::LOD::nbEventsOut() const
00120 {
00121    return 0;
00122 }
00123 #endif // XDKWRL_LOD_H
00124 
00125 // Local variables section.
00126 // This is only used by emacs!
00127 // Local Variables:
00128 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00129 // End:

Generated on 5 Jan 2007 with doxygen version 1.5.1. Valid HTML 4.0! Valid CSS!