XdkWrl: geolocation.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# geolocation.h

Go to the documentation of this file.

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

Generated on 28 Jun 2006 with version 1.4.4. |