Home Hierarchy Members Alphabetical Related Pages

orientationinterpolator.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_ORIENTATIONINTERPOLATOR_H
00002 #define XDKWRL_ORIENTATIONINTERPOLATOR_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mffloat.h>
00007 #include <xdkwrl/fieldtypes/mfrotation.h>
00008 #include <xdkwrl/fieldtypes/sffloat.h>
00009 #include <xdkwrl/fieldtypes/sfrotation.h>
00010 
00011 namespace wrl
00012 {
00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00014   // Interface of OrientationInterpolator
00015   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00016   class XDKWRL_EXPORT OrientationInterpolator : public Node
00017   {
00018    public:
00019      OrientationInterpolator(const char* name="");
00020      virtual ~OrientationInterpolator();
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 MFFloat default value
00044        */
00045        MFFloat    key;
00046       /*!
00047        * See <a href="#_details" class="md">Detailed Description</a>
00048        * for meaning of this field.
00049        * Default value is set to MFRotation default value
00050        */
00051        MFRotation keyValue;
00052      //!@}
00053      /*!@name Fields
00054       * A property or attribute of a node. Each node type has a fixed set
00055       * of fields. Fields may contain various kinds of data and one or many
00056       * values. Each field has a default value.
00057       */
00058       //!@{
00059      //!@}
00060      /*!@name Events In
00061       * 
00062       */
00063       //!@{
00064       /*!
00065        * See <a href="#_details" class="md">Detailed Description</a>
00066        * for meaning of this event.
00067        */
00068        EventIn<SFFloat>    set_fraction;
00069       /*!
00070        * Set event associated to exposedField key
00071        */
00072        EventIn<MFFloat>    set_key;
00073       /*!
00074        * Set event associated to exposedField keyValue
00075        */
00076        EventIn<MFRotation> set_keyValue;
00077   //!@}
00078      /*!@name Events Out
00079       * 
00080       */
00081       //!@{
00082       /*!
00083        * See <a href="#_details" class="md">Detailed Description</a>
00084        * for meaning of this event.
00085        */
00086        EventOut<SFRotation> value_changed;
00087       /*!
00088        * Changed event associated to exposedField key
00089        */
00090        EventOut<MFFloat>    key_changed;
00091       /*!
00092        * Changed event associated to exposedField keyValue
00093        */
00094        EventOut<MFRotation> keyValue_changed;
00095   //!@}
00096   };
00097 };
00098 //************************************************************
00099 // Implementation of OrientationInterpolator
00100 //************************************************************
00101 /*!
00102  * Returns <code>"OrientationInterpolator"</code>. Useful for printing.
00103  */
00104 inline const char*
00105 wrl::OrientationInterpolator::typeName() const
00106 {
00107   return "OrientationInterpolator";
00108 }
00109 /*!
00110  * Returns the number of fields (exposed or not) for this node type.
00111  */
00112 inline unsigned int
00113 wrl::OrientationInterpolator::nbFields() const
00114 {
00115    return 2;
00116 }
00117 /*!
00118  * Returns the number of events in for this node type.
00119  */
00120 inline unsigned int
00121 wrl::OrientationInterpolator::nbEventsIn() const
00122 {
00123    return 1;
00124 }
00125 /*!
00126  * Returns the number of events out for this node type.
00127  */
00128 inline unsigned int
00129 wrl::OrientationInterpolator::nbEventsOut() const
00130 {
00131    return 1;
00132 }
00133 #endif // XDKWRL_ORIENTATIONINTERPOLATOR_H
00134 
00135 // Local variables section.
00136 // This is only used by emacs!
00137 // Local Variables:
00138 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00139 // End:

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