XdkWrl: spheresensor.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# spheresensor.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_SPHERESENSOR_H
    00002 #define XDKWRL_SPHERESENSOR_H
    00003
    00004 #include <xdkwrl/config.h>
    00005 #include <xdkwrl/node.h>
    00006 #include <xdkwrl/fieldtypes/sfbool.h>
    00007 #include <xdkwrl/fieldtypes/sfrotation.h>
    00008 #include <xdkwrl/fieldtypes/sfvec3f.h>
    00009
    00010 namespace wrl
    00011 {
    00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00013   // Interface of SphereSensor
    00014   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00015   class XDKWRL_EXPORT SphereSensor : public Node
    00016   {
    00017    public:
    00018      SphereSensor(const char* name="");
    00019      virtual ~SphereSensor();
    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        autoOffset = true;
    00045        \endcode
    00046        */
    00047        SFBool     autoOffset;
    00048       /*!
    00049        * See <a href="#_details" class="md">Detailed Description</a>
    00050        * for meaning of this field.
    00051        * Default value is set to
    00052        \code
    00053        enabled = true;
    00054        \endcode
    00055        */
    00056        SFBool     enabled;
    00057       /*!
    00058        * See <a href="#_details" class="md">Detailed Description</a>
    00059        * for meaning of this field.
    00060        * Default value is set to
    00061        \code
    00062        offset.setAxisAndAngle(0,1,0,0);
    00063        \endcode
    00064        */
    00065        SFRotation offset;
    00066      //!@}
    00067      /*!@name Fields
    00068       * A property or attribute of a node. Each node type has a fixed set
    00069       * of fields. Fields may contain various kinds of data and one or many
    00070       * values. Each field has a default value.
    00071       */
    00072       //!@{
    00073      //!@}
    00074      /*!@name Events In
    00075       *
    00076       */
    00077       //!@{
    00078       /*!
    00079        * Set event associated to exposedField autoOffset
    00080        */
    00081        EventIn<SFBool>     set_autoOffset;
    00082       /*!
    00083        * Set event associated to exposedField enabled
    00084        */
    00085        EventIn<SFBool>     set_enabled;
    00086       /*!
    00087        * Set event associated to exposedField offset
    00088        */
    00089        EventIn<SFRotation> set_offset;
    00090   //!@}
    00091      /*!@name Events Out
    00092       *
    00093       */
    00094       //!@{
    00095       /*!
    00096        * See <a href="#_details" class="md">Detailed Description</a>
    00097        * for meaning of this event.
    00098        */
    00099        EventOut<SFBool>     isActive;
    00100       /*!
    00101        * See <a href="#_details" class="md">Detailed Description</a>
    00102        * for meaning of this event.
    00103        */
    00104        EventOut<SFRotation> rotation_changed;
    00105       /*!
    00106        * See <a href="#_details" class="md">Detailed Description</a>
    00107        * for meaning of this event.
    00108        */
    00109        EventOut<SFVec3f>    trackPoint_changed;
    00110       /*!
    00111        * Changed event associated to exposedField autoOffset
    00112        */
    00113        EventOut<SFBool>     autoOffset_changed;
    00114       /*!
    00115        * Changed event associated to exposedField enabled
    00116        */
    00117        EventOut<SFBool>     enabled_changed;
    00118       /*!
    00119        * Changed event associated to exposedField offset
    00120        */
    00121        EventOut<SFRotation> offset_changed;
    00122   //!@}
    00123   };
    00124 };
    00125 //************************************************************
    00126 // Implementation of SphereSensor
    00127 //************************************************************
    00128 /*!
    00129  * Returns <code>"SphereSensor"</code>. Useful for printing.
    00130  */
    00131 inline const char*
    00132 wrl::SphereSensor::typeName() const
    00133 {
    00134   return "SphereSensor";
    00135 }
    00136 /*!
    00137  * Returns the number of fields (exposed or not) for this node type.
    00138  */
    00139 inline unsigned int
    00140 wrl::SphereSensor::nbFields() const
    00141 {
    00142    return 3;
    00143 }
    00144 /*!
    00145  * Returns the number of events in for this node type.
    00146  */
    00147 inline unsigned int
    00148 wrl::SphereSensor::nbEventsIn() const
    00149 {
    00150    return 0;
    00151 }
    00152 /*!
    00153  * Returns the number of events out for this node type.
    00154  */
    00155 inline unsigned int
    00156 wrl::SphereSensor::nbEventsOut() const
    00157 {
    00158    return 3;
    00159 }
    00160 #endif // XDKWRL_SPHERESENSOR_H
    00161
    00162 // Local variables section.
    00163 // This is only used by emacs!
    00164 // Local Variables:
    00165 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00166 // End:

Generated on 5 Jan 2007 with version 1.5.1. |