XdkWrl: worldinfo.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# worldinfo.h

Go to the documentation of this file.

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

Generated on 5 Jan 2007 with version 1.5.1. |