XdkWrl: geoorigin.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# geoorigin.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_GEOORIGIN_H
    00002 #define XDKWRL_GEOORIGIN_H
    00003
    00004 #include <xdkwrl/config.h>
    00005 #include <xdkwrl/node.h>
    00006 #include <xdkwrl/fieldtypes/mfstring.h>
    00007 #include <xdkwrl/fieldtypes/sfbool.h>
    00008 #include <xdkwrl/fieldtypes/sfstring.h>
    00009
    00010 namespace wrl
    00011 {
    00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00013   // Interface of GeoOrigin
    00014   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00015   class XDKWRL_EXPORT GeoOrigin : public Node
    00016   {
    00017    public:
    00018      GeoOrigin(const char* name="");
    00019      virtual ~GeoOrigin();
    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
    00043        \code
    00044
    00045        \endcode
    00046        */
    00047        MFString   geoSystem;
    00048       /*!
    00049        * See <a href="#_details" class="md">Detailed Description</a>
    00050        * for meaning of this field.
    00051        * Default value is set to
    00052        \code
    00053        geoCoords = string("");
    00054        \endcode
    00055        */
    00056        SFString   geoCoords;
    00057      //!@}
    00058      /*!@name Fields
    00059       * A property or attribute of a node. Each node type has a fixed set
    00060       * of fields. Fields may contain various kinds of data and one or many
    00061       * values. Each field has a default value.
    00062       */
    00063       //!@{
    00064       /*!
    00065        * See <a href="#_details" class="md">Detailed Description</a>
    00066        * for meaning of this field.
    00067        * Default value is set to
    00068        \code
    00069        rotateYUp = false;
    00070         \endcode
    00071        */
    00072        SFBool     rotateYUp;
    00073      //!@}
    00074      /*!@name Events In
    00075       *
    00076       */
    00077       //!@{
    00078       /*!
    00079        * Set event associated to exposedField geoSystem
    00080        */
    00081        EventIn<MFString>   set_geoSystem;
    00082       /*!
    00083        * Set event associated to exposedField geoCoords
    00084        */
    00085        EventIn<SFString>   set_geoCoords;
    00086   //!@}
    00087      /*!@name Events Out
    00088       *
    00089       */
    00090       //!@{
    00091       /*!
    00092        * Changed event associated to exposedField geoSystem
    00093        */
    00094        EventOut<MFString>   geoSystem_changed;
    00095       /*!
    00096        * Changed event associated to exposedField geoCoords
    00097        */
    00098        EventOut<SFString>   geoCoords_changed;
    00099   //!@}
    00100   };
    00101 };
    00102 //************************************************************
    00103 // Implementation of GeoOrigin
    00104 //************************************************************
    00105 /*!
    00106  * Returns <code>"GeoOrigin"</code>. Useful for printing.
    00107  */
    00108 inline const char*
    00109 wrl::GeoOrigin::typeName() const
    00110 {
    00111   return "GeoOrigin";
    00112 }
    00113 /*!
    00114  * Returns the number of fields (exposed or not) for this node type.
    00115  */
    00116 inline unsigned int
    00117 wrl::GeoOrigin::nbFields() const
    00118 {
    00119    return 3;
    00120 }
    00121 /*!
    00122  * Returns the number of events in for this node type.
    00123  */
    00124 inline unsigned int
    00125 wrl::GeoOrigin::nbEventsIn() const
    00126 {
    00127    return 0;
    00128 }
    00129 /*!
    00130  * Returns the number of events out for this node type.
    00131  */
    00132 inline unsigned int
    00133 wrl::GeoOrigin::nbEventsOut() const
    00134 {
    00135    return 0;
    00136 }
    00137 #endif // XDKWRL_GEOORIGIN_H
    00138
    00139 // Local variables section.
    00140 // This is only used by emacs!
    00141 // Local Variables:
    00142 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00143 // End:

Generated on 5 Jan 2007 with version 1.5.1. |