Home Hierarchy Members Alphabetical Related Pages

navigationinfo.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_NAVIGATIONINFO_H
00002 #define XDKWRL_NAVIGATIONINFO_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mffloat.h>
00007 #include <xdkwrl/fieldtypes/mfstring.h>
00008 #include <xdkwrl/fieldtypes/sfbool.h>
00009 #include <xdkwrl/fieldtypes/sffloat.h>
00010 
00011 namespace wrl
00012 {
00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00014   // Interface of NavigationInfo
00015   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00016   class XDKWRL_EXPORT NavigationInfo : public Node
00017   {
00018    public:
00019      NavigationInfo(const char* name="");
00020      virtual ~NavigationInfo();
00021      virtual inline unsigned int nbFields() const;
00022      virtual FieldHandle field(const std::string& n);
00023      virtual FieldHandle field(unsigned int i);
00024      virtual bool isSetToDefaultValue(unsigned int i) const;
00025      virtual inline unsigned int nbEventsIn() const;
00026      virtual EventInHandle eventIn(const std::string& n);
00027      virtual EventInHandle eventIn(unsigned int i);
00028      virtual inline unsigned int nbEventsOut() const;
00029      virtual EventOutHandle eventOut(const std::string& n);
00030      virtual EventOutHandle eventOut(unsigned int i);
00031      inline const char* typeName() const;
00032      virtual Node* duplicate() const;
00033      virtual Node* duplicate(std::map<const Node*,Node*>&) const;
00034      /*!@name Exposed Fields
00035       * A field that is capable of receiving events via an eventIn to 
00036       * change its value(s), and generating events via an eventOut 
00037       * when its value(s) change.
00038       */
00039       //!@{
00040       /*!
00041        * See <a href="#_details" class="md">Detailed Description</a>
00042        * for meaning of this field.
00043        * Default value is set to 
00044        \code
00045            avatarSize.push_back(SFFloat(0.25f));
00046     avatarSize.push_back(SFFloat(1.6f));
00047     avatarSize.push_back(SFFloat(0.75f));
00048        \endcode
00049        */
00050        MFFloat    avatarSize;
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        headlight = true;
00057        \endcode
00058        */
00059        SFBool     headlight;
00060       /*!
00061        * See <a href="#_details" class="md">Detailed Description</a>
00062        * for meaning of this field.
00063        * Default value is set to 
00064        \code
00065        speed = 1.0f;
00066        \endcode
00067        */
00068        SFFloat    speed;
00069       /*!
00070        * See <a href="#_details" class="md">Detailed Description</a>
00071        * for meaning of this field.
00072        * Default value is set to 
00073        \code
00074        
00075        \endcode
00076        */
00077        MFString   type;
00078       /*!
00079        * See <a href="#_details" class="md">Detailed Description</a>
00080        * for meaning of this field.
00081        * Default value is set to 
00082        \code
00083        visibilityLimit = 0.0f;
00084        \endcode
00085        */
00086        SFFloat    visibilityLimit;
00087      //!@}
00088      /*!@name Fields
00089       * A property or attribute of a node. Each node type has a fixed set
00090       * of fields. Fields may contain various kinds of data and one or many
00091       * values. Each field has a default value.
00092       */
00093       //!@{
00094      //!@}
00095      /*!@name Events In
00096       * 
00097       */
00098       //!@{
00099       /*!
00100        * See <a href="#_details" class="md">Detailed Description</a>
00101        * for meaning of this event.
00102        */
00103        EventIn<SFBool>     set_bind;
00104       /*!
00105        * Set event associated to exposedField avatarSize
00106        */
00107        EventIn<MFFloat>    set_avatarSize;
00108       /*!
00109        * Set event associated to exposedField headlight
00110        */
00111        EventIn<SFBool>     set_headlight;
00112       /*!
00113        * Set event associated to exposedField speed
00114        */
00115        EventIn<SFFloat>    set_speed;
00116       /*!
00117        * Set event associated to exposedField type
00118        */
00119        EventIn<MFString>   set_type;
00120       /*!
00121        * Set event associated to exposedField visibilityLimit
00122        */
00123        EventIn<SFFloat>    set_visibilityLimit;
00124   //!@}
00125      /*!@name Events Out
00126       * 
00127       */
00128       //!@{
00129       /*!
00130        * See <a href="#_details" class="md">Detailed Description</a>
00131        * for meaning of this event.
00132        */
00133        EventOut<SFBool>     isBound;
00134       /*!
00135        * Changed event associated to exposedField avatarSize
00136        */
00137        EventOut<MFFloat>    avatarSize_changed;
00138       /*!
00139        * Changed event associated to exposedField headlight
00140        */
00141        EventOut<SFBool>     headlight_changed;
00142       /*!
00143        * Changed event associated to exposedField speed
00144        */
00145        EventOut<SFFloat>    speed_changed;
00146       /*!
00147        * Changed event associated to exposedField type
00148        */
00149        EventOut<MFString>   type_changed;
00150       /*!
00151        * Changed event associated to exposedField visibilityLimit
00152        */
00153        EventOut<SFFloat>    visibilityLimit_changed;
00154   //!@}
00155   };
00156 };
00157 //************************************************************
00158 // Implementation of NavigationInfo
00159 //************************************************************
00160 /*!
00161  * Returns <code>"NavigationInfo"</code>. Useful for printing.
00162  */
00163 inline const char*
00164 wrl::NavigationInfo::typeName() const
00165 {
00166   return "NavigationInfo";
00167 }
00168 /*!
00169  * Returns the number of fields (exposed or not) for this node type.
00170  */
00171 inline unsigned int
00172 wrl::NavigationInfo::nbFields() const
00173 {
00174    return 5;
00175 }
00176 /*!
00177  * Returns the number of events in for this node type.
00178  */
00179 inline unsigned int
00180 wrl::NavigationInfo::nbEventsIn() const
00181 {
00182    return 1;
00183 }
00184 /*!
00185  * Returns the number of events out for this node type.
00186  */
00187 inline unsigned int
00188 wrl::NavigationInfo::nbEventsOut() const
00189 {
00190    return 1;
00191 }
00192 #endif // XDKWRL_NAVIGATIONINFO_H
00193 
00194 // Local variables section.
00195 // This is only used by emacs!
00196 // Local Variables:
00197 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00198 // End:

Generated on 5 Jan 2007 with doxygen version 1.5.1. Valid HTML 4.0! Valid CSS!