Home Hierarchy Members Alphabetical Related Pages

shape.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_SHAPE_H
00002 #define XDKWRL_SHAPE_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/sfnode.h>
00007 
00008 namespace wrl
00009 {
00010   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00011   // Interface of Shape
00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00013   class XDKWRL_EXPORT Shape : public Node
00014   {
00015    public:
00016      Shape(const char* name="");
00017      virtual ~Shape();
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 SFNode default value
00041        */
00042        SFNode     appearance;
00043       /*!
00044        * See <a href="#_details" class="md">Detailed Description</a>
00045        * for meaning of this field.
00046        * Default value is set to SFNode default value
00047        */
00048        SFNode     geometry;
00049      //!@}
00050      /*!@name Fields
00051       * A property or attribute of a node. Each node type has a fixed set
00052       * of fields. Fields may contain various kinds of data and one or many
00053       * values. Each field has a default value.
00054       */
00055       //!@{
00056      //!@}
00057      /*!@name Events In
00058       * 
00059       */
00060       //!@{
00061       /*!
00062        * Set event associated to exposedField appearance
00063        */
00064        EventIn<SFNode>     set_appearance;
00065       /*!
00066        * Set event associated to exposedField geometry
00067        */
00068        EventIn<SFNode>     set_geometry;
00069   //!@}
00070      /*!@name Events Out
00071       * 
00072       */
00073       //!@{
00074       /*!
00075        * Changed event associated to exposedField appearance
00076        */
00077        EventOut<SFNode>     appearance_changed;
00078       /*!
00079        * Changed event associated to exposedField geometry
00080        */
00081        EventOut<SFNode>     geometry_changed;
00082   //!@}
00083   };
00084 };
00085 //************************************************************
00086 // Implementation of Shape
00087 //************************************************************
00088 /*!
00089  * Returns <code>"Shape"</code>. Useful for printing.
00090  */
00091 inline const char*
00092 wrl::Shape::typeName() const
00093 {
00094   return "Shape";
00095 }
00096 /*!
00097  * Returns the number of fields (exposed or not) for this node type.
00098  */
00099 inline unsigned int
00100 wrl::Shape::nbFields() const
00101 {
00102    return 2;
00103 }
00104 /*!
00105  * Returns the number of events in for this node type.
00106  */
00107 inline unsigned int
00108 wrl::Shape::nbEventsIn() const
00109 {
00110    return 0;
00111 }
00112 /*!
00113  * Returns the number of events out for this node type.
00114  */
00115 inline unsigned int
00116 wrl::Shape::nbEventsOut() const
00117 {
00118    return 0;
00119 }
00120 #endif // XDKWRL_SHAPE_H
00121 
00122 // Local variables section.
00123 // This is only used by emacs!
00124 // Local Variables:
00125 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00126 // End:

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