Home Hierarchy Members Alphabetical Related Pages

color.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_COLOR_H
00002 #define XDKWRL_COLOR_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mfcolor.h>
00007 
00008 namespace wrl
00009 {
00010   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00011   // Interface of Color
00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00013   class XDKWRL_EXPORT Color : public Node
00014   {
00015    public:
00016      Color(const char* name="");
00017      virtual ~Color();
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 MFColor default value
00041        */
00042        MFColor    color;
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        * Set event associated to exposedField color
00057        */
00058        EventIn<MFColor>    set_color;
00059   //!@}
00060      /*!@name Events Out
00061       * 
00062       */
00063       //!@{
00064       /*!
00065        * Changed event associated to exposedField color
00066        */
00067        EventOut<MFColor>    color_changed;
00068   //!@}
00069   };
00070 };
00071 //************************************************************
00072 // Implementation of Color
00073 //************************************************************
00074 /*!
00075  * Returns <code>"Color"</code>. Useful for printing.
00076  */
00077 inline const char*
00078 wrl::Color::typeName() const
00079 {
00080   return "Color";
00081 }
00082 /*!
00083  * Returns the number of fields (exposed or not) for this node type.
00084  */
00085 inline unsigned int
00086 wrl::Color::nbFields() const
00087 {
00088    return 1;
00089 }
00090 /*!
00091  * Returns the number of events in for this node type.
00092  */
00093 inline unsigned int
00094 wrl::Color::nbEventsIn() const
00095 {
00096    return 0;
00097 }
00098 /*!
00099  * Returns the number of events out for this node type.
00100  */
00101 inline unsigned int
00102 wrl::Color::nbEventsOut() const
00103 {
00104    return 0;
00105 }
00106 #endif // XDKWRL_COLOR_H
00107 
00108 // Local variables section.
00109 // This is only used by emacs!
00110 // Local Variables:
00111 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00112 // End:

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