Home Hierarchy Members Alphabetical Related Pages

contour2d.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_CONTOUR2D_H
00002 #define XDKWRL_CONTOUR2D_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mfnode.h>
00007 
00008 namespace wrl
00009 {
00010   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00011   // Interface of Contour2D
00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00013   class XDKWRL_EXPORT Contour2D : public Node
00014   {
00015    public:
00016      Contour2D(const char* name="");
00017      virtual ~Contour2D();
00018      virtual inline unsigned int nbFields() const;
00019      virtual FieldHandle field(const std::string& n);
00020      virtual FieldHandle field(unsigned int i);
00021      virtual bool isSetToDefaultValue(unsigned int i) const;
00022      virtual inline unsigned int nbEventsIn() const;
00023      virtual EventInHandle eventIn(const std::string& n);
00024      virtual EventInHandle eventIn(unsigned int i);
00025      virtual inline unsigned int nbEventsOut() const;
00026      virtual EventOutHandle eventOut(const std::string& n);
00027      virtual EventOutHandle eventOut(unsigned int i);
00028      inline const char* typeName() const;
00029      virtual Node* duplicate() const;
00030      virtual Node* duplicate(std::map<const Node*,Node*>&) const;
00031      /*!@name Exposed Fields
00032       * A field that is capable of receiving events via an eventIn to 
00033       * change its value(s), and generating events via an eventOut 
00034       * when its value(s) change.
00035       */
00036       //!@{
00037       /*!
00038        * See <a href="#_details" class="md">Detailed Description</a>
00039        * for meaning of this field.
00040        * Default value is set to MFNode default value
00041        */
00042        MFNode     children;
00043      //!@}
00044      /*!@name Fields
00045       * A property or attribute of a node. Each node type has a fixed set
00046       * of fields. Fields may contain various kinds of data and one or many
00047       * values. Each field has a default value.
00048       */
00049       //!@{
00050      //!@}
00051      /*!@name Events In
00052       * 
00053       */
00054       //!@{
00055       /*!
00056        * See <a href="#_details" class="md">Detailed Description</a>
00057        * for meaning of this event.
00058        */
00059        EventIn<MFNode>     addChildren;
00060       /*!
00061        * See <a href="#_details" class="md">Detailed Description</a>
00062        * for meaning of this event.
00063        */
00064        EventIn<MFNode>     removeChildren;
00065       /*!
00066        * Set event associated to exposedField children
00067        */
00068        EventIn<MFNode>     set_children;
00069   //!@}
00070      /*!@name Events Out
00071       * 
00072       */
00073       //!@{
00074       /*!
00075        * Changed event associated to exposedField children
00076        */
00077        EventOut<MFNode>     children_changed;
00078   //!@}
00079   };
00080 };
00081 //************************************************************
00082 // Implementation of Contour2D
00083 //************************************************************
00084 /*!
00085  * Returns <code>"Contour2D"</code>. Useful for printing.
00086  */
00087 inline const char*
00088 wrl::Contour2D::typeName() const
00089 {
00090   return "Contour2D";
00091 }
00092 /*!
00093  * Returns the number of fields (exposed or not) for this node type.
00094  */
00095 inline unsigned int
00096 wrl::Contour2D::nbFields() const
00097 {
00098    return 1;
00099 }
00100 /*!
00101  * Returns the number of events in for this node type.
00102  */
00103 inline unsigned int
00104 wrl::Contour2D::nbEventsIn() const
00105 {
00106    return 2;
00107 }
00108 /*!
00109  * Returns the number of events out for this node type.
00110  */
00111 inline unsigned int
00112 wrl::Contour2D::nbEventsOut() const
00113 {
00114    return 0;
00115 }
00116 #endif // XDKWRL_CONTOUR2D_H
00117 
00118 // Local variables section.
00119 // This is only used by emacs!
00120 // Local Variables:
00121 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00122 // End:

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