Home Hierarchy Members Alphabetical Related Pages

group.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_GROUP_H
00002 #define XDKWRL_GROUP_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 Group
00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00014   class XDKWRL_EXPORT Group : public Node
00015   {
00016    public:
00017      Group(const char* name="");
00018      virtual ~Group();
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 MFNode default value
00042        */
00043        MFNode     children;
00044      //!@}
00045      /*!@name Fields
00046       * A property or attribute of a node. Each node type has a fixed set
00047       * of fields. Fields may contain various kinds of data and one or many
00048       * values. Each field has a default value.
00049       */
00050       //!@{
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        bboxCenter.setXYZ(0,0,0);
00057         \endcode
00058        */
00059        SFVec3f    bboxCenter;
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        bboxSize.setXYZ(-1,-1,-1);
00066         \endcode
00067        */
00068        SFVec3f    bboxSize;
00069      //!@}
00070      /*!@name Events In
00071       * 
00072       */
00073       //!@{
00074       /*!
00075        * See <a href="#_details" class="md">Detailed Description</a>
00076        * for meaning of this event.
00077        */
00078        EventIn<MFNode>     addChildren;
00079       /*!
00080        * See <a href="#_details" class="md">Detailed Description</a>
00081        * for meaning of this event.
00082        */
00083        EventIn<MFNode>     removeChildren;
00084       /*!
00085        * Set event associated to exposedField children
00086        */
00087        EventIn<MFNode>     set_children;
00088   //!@}
00089      /*!@name Events Out
00090       * 
00091       */
00092       //!@{
00093       /*!
00094        * Changed event associated to exposedField children
00095        */
00096        EventOut<MFNode>     children_changed;
00097   //!@}
00098   };
00099 };
00100 //************************************************************
00101 // Implementation of Group
00102 //************************************************************
00103 /*!
00104  * Returns <code>"Group"</code>. Useful for printing.
00105  */
00106 inline const char*
00107 wrl::Group::typeName() const
00108 {
00109   return "Group";
00110 }
00111 /*!
00112  * Returns the number of fields (exposed or not) for this node type.
00113  */
00114 inline unsigned int
00115 wrl::Group::nbFields() const
00116 {
00117    return 3;
00118 }
00119 /*!
00120  * Returns the number of events in for this node type.
00121  */
00122 inline unsigned int
00123 wrl::Group::nbEventsIn() const
00124 {
00125    return 2;
00126 }
00127 /*!
00128  * Returns the number of events out for this node type.
00129  */
00130 inline unsigned int
00131 wrl::Group::nbEventsOut() const
00132 {
00133    return 0;
00134 }
00135 #endif // XDKWRL_GROUP_H
00136 
00137 // Local variables section.
00138 // This is only used by emacs!
00139 // Local Variables:
00140 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00141 // End:

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