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

Generated on 5 Jan 2007 with version 1.5.1. |