Home Hierarchy Members Alphabetical Related Pages

nurbsgroup.h

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

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