XdkWrl: worldinfo.h Source File

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