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

Generated on 24 Feb 2005 with doxygen version 1.3.9.1. Valid HTML 4.0! Valid CSS!