XdkWrl: contour2d.h Source File

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

Generated on 28 Jun 2006 with version 1.4.4. |