XdkWrl: geocoordinate.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# geocoordinate.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_GEOCOORDINATE_H
    00002 #define XDKWRL_GEOCOORDINATE_H
    00003
    00004 #include <xdkwrl/node.h>
    00005 #include <xdkwrl/fieldtypes/mfstring.h>
    00006 #include <xdkwrl/fieldtypes/sfnode.h>
    00007
    00008 namespace wrl
    00009 {
    00010   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00011   // Interface of GeoCoordinate
    00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00013   class GeoCoordinate : public Node
    00014   {
    00015    public:
    00016      GeoCoordinate(const char* name="");
    00017      virtual ~GeoCoordinate();
    00018      virtual inline unsigned int nbFields() const;
    00019      virtual FieldHandle field(const std::string& n);
    00020      virtual FieldHandle field(unsigned int i);
    00021      virtual bool isSetToDefaultValue(unsigned int i) const;
    00022      virtual inline unsigned int nbEventsIn() const;
    00023      virtual EventInHandle eventIn(const std::string& n);
    00024      virtual EventInHandle eventIn(unsigned int i);
    00025      virtual inline unsigned int nbEventsOut() const;
    00026      virtual EventOutHandle eventOut(const std::string& n);
    00027      virtual EventOutHandle eventOut(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 SFNode default value
    00048        */
    00049        SFNode     geoOrigin;
    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
    00056         \endcode
    00057        */
    00058        MFString   geoSystem;
    00059       /*!
    00060        * See <a href="#_details" class="md">Detailed Description</a>
    00061        * for meaning of this field.
    00062        * Default value is set to MFString default value
    00063        */
    00064        MFString   point;
    00065      //!@}
    00066      /*!@name Events In
    00067       *
    00068       */
    00069       //!@{
    00070   //!@}
    00071      /*!@name Events Out
    00072       *
    00073       */
    00074       //!@{
    00075   //!@}
    00076   };
    00077 };
    00078 //************************************************************
    00079 // Implementation of GeoCoordinate
    00080 //************************************************************
    00081 /*!
    00082  * Returns <code>"GeoCoordinate"</code>. Useful for printing.
    00083  */
    00084 inline const char*
    00085 wrl::GeoCoordinate::typeName() const
    00086 {
    00087   return "GeoCoordinate";
    00088 }
    00089 /*!
    00090  * Returns the number of fields (exposed or not) for this node type.
    00091  */
    00092 inline unsigned int
    00093 wrl::GeoCoordinate::nbFields() const
    00094 {
    00095    return 3;
    00096 }
    00097 /*!
    00098  * Returns the number of events in for this node type.
    00099  */
    00100 inline unsigned int
    00101 wrl::GeoCoordinate::nbEventsIn() const
    00102 {
    00103    return 0;
    00104 }
    00105 /*!
    00106  * Returns the number of events out for this node type.
    00107  */
    00108 inline unsigned int
    00109 wrl::GeoCoordinate::nbEventsOut() const
    00110 {
    00111    return 0;
    00112 }
    00113 #endif // XDKWRL_GEOCOORDINATE_H
    00114
    00115 // Local variables section.
    00116 // This is only used by emacs!
    00117 // Local Variables:
    00118 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00119 // End:

Generated on 28 Jun 2006 with version 1.4.4. |