Home Hierarchy Members Alphabetical Related Pages

billboard.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_BILLBOARD_H
00002 #define XDKWRL_BILLBOARD_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mfnode.h>
00007 #include <xdkwrl/fieldtypes/sfvec3f.h>
00008 
00009 namespace wrl
00010 {
00011   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00012   // Interface of Billboard
00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00014   class XDKWRL_EXPORT Billboard : public Node
00015   {
00016    public:
00017      Billboard(const char* name="");
00018      virtual ~Billboard();
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        * See <a href="#_details" class="md">Detailed Description</a>
00040        * for meaning of this field.
00041        * Default value is set to 
00042        \code
00043        axisOfRotation.setXYZ(0,1,0);
00044        \endcode
00045        */
00046        SFVec3f    axisOfRotation;
00047       /*!
00048        * See <a href="#_details" class="md">Detailed Description</a>
00049        * for meaning of this field.
00050        * Default value is set to MFNode default value
00051        */
00052        MFNode     children;
00053      //!@}
00054      /*!@name Fields
00055       * A property or attribute of a node. Each node type has a fixed set
00056       * of fields. Fields may contain various kinds of data and one or many
00057       * values. Each field has a default value.
00058       */
00059       //!@{
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        bboxCenter.setXYZ(0,0,0);
00066         \endcode
00067        */
00068        SFVec3f    bboxCenter;
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        bboxSize.setXYZ(-1,-1,-1);
00075         \endcode
00076        */
00077        SFVec3f    bboxSize;
00078      //!@}
00079      /*!@name Events In
00080       * 
00081       */
00082       //!@{
00083       /*!
00084        * See <a href="#_details" class="md">Detailed Description</a>
00085        * for meaning of this event.
00086        */
00087        EventIn<MFNode>     addChildren;
00088       /*!
00089        * See <a href="#_details" class="md">Detailed Description</a>
00090        * for meaning of this event.
00091        */
00092        EventIn<MFNode>     removeChildren;
00093       /*!
00094        * Set event associated to exposedField axisOfRotation
00095        */
00096        EventIn<SFVec3f>    set_axisOfRotation;
00097       /*!
00098        * Set event associated to exposedField children
00099        */
00100        EventIn<MFNode>     set_children;
00101   //!@}
00102      /*!@name Events Out
00103       * 
00104       */
00105       //!@{
00106       /*!
00107        * Changed event associated to exposedField axisOfRotation
00108        */
00109        EventOut<SFVec3f>    axisOfRotation_changed;
00110       /*!
00111        * Changed event associated to exposedField children
00112        */
00113        EventOut<MFNode>     children_changed;
00114   //!@}
00115   };
00116 };
00117 //************************************************************
00118 // Implementation of Billboard
00119 //************************************************************
00120 /*!
00121  * Returns <code>"Billboard"</code>. Useful for printing.
00122  */
00123 inline const char*
00124 wrl::Billboard::typeName() const
00125 {
00126   return "Billboard";
00127 }
00128 /*!
00129  * Returns the number of fields (exposed or not) for this node type.
00130  */
00131 inline unsigned int
00132 wrl::Billboard::nbFields() const
00133 {
00134    return 4;
00135 }
00136 /*!
00137  * Returns the number of events in for this node type.
00138  */
00139 inline unsigned int
00140 wrl::Billboard::nbEventsIn() const
00141 {
00142    return 2;
00143 }
00144 /*!
00145  * Returns the number of events out for this node type.
00146  */
00147 inline unsigned int
00148 wrl::Billboard::nbEventsOut() const
00149 {
00150    return 0;
00151 }
00152 #endif // XDKWRL_BILLBOARD_H
00153 
00154 // Local variables section.
00155 // This is only used by emacs!
00156 // Local Variables:
00157 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00158 // End:

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