XdkWrl: appearance.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# appearance.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_APPEARANCE_H
    00002 #define XDKWRL_APPEARANCE_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 Appearance
    00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00013   class XDKWRL_EXPORT Appearance : public Node
    00014   {
    00015    public:
    00016      Appearance(const char* name="");
    00017      virtual ~Appearance();
    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     material;
    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     texture;
    00049       /*!
    00050        * See <a href="#_details" class="md">Detailed Description</a>
    00051        * for meaning of this field.
    00052        * Default value is set to SFNode default value
    00053        */
    00054        SFNode     textureTransform;
    00055      //!@}
    00056      /*!@name Fields
    00057       * A property or attribute of a node. Each node type has a fixed set
    00058       * of fields. Fields may contain various kinds of data and one or many
    00059       * values. Each field has a default value.
    00060       */
    00061       //!@{
    00062      //!@}
    00063      /*!@name Events In
    00064       *
    00065       */
    00066       //!@{
    00067       /*!
    00068        * Set event associated to exposedField material
    00069        */
    00070        EventIn<SFNode>     set_material;
    00071       /*!
    00072        * Set event associated to exposedField texture
    00073        */
    00074        EventIn<SFNode>     set_texture;
    00075       /*!
    00076        * Set event associated to exposedField textureTransform
    00077        */
    00078        EventIn<SFNode>     set_textureTransform;
    00079   //!@}
    00080      /*!@name Events Out
    00081       *
    00082       */
    00083       //!@{
    00084       /*!
    00085        * Changed event associated to exposedField material
    00086        */
    00087        EventOut<SFNode>     material_changed;
    00088       /*!
    00089        * Changed event associated to exposedField texture
    00090        */
    00091        EventOut<SFNode>     texture_changed;
    00092       /*!
    00093        * Changed event associated to exposedField textureTransform
    00094        */
    00095        EventOut<SFNode>     textureTransform_changed;
    00096   //!@}
    00097   };
    00098 };
    00099 //************************************************************
    00100 // Implementation of Appearance
    00101 //************************************************************
    00102 /*!
    00103  * Returns <code>"Appearance"</code>. Useful for printing.
    00104  */
    00105 inline const char*
    00106 wrl::Appearance::typeName() const
    00107 {
    00108   return "Appearance";
    00109 }
    00110 /*!
    00111  * Returns the number of fields (exposed or not) for this node type.
    00112  */
    00113 inline unsigned int
    00114 wrl::Appearance::nbFields() const
    00115 {
    00116    return 3;
    00117 }
    00118 /*!
    00119  * Returns the number of events in for this node type.
    00120  */
    00121 inline unsigned int
    00122 wrl::Appearance::nbEventsIn() const
    00123 {
    00124    return 0;
    00125 }
    00126 /*!
    00127  * Returns the number of events out for this node type.
    00128  */
    00129 inline unsigned int
    00130 wrl::Appearance::nbEventsOut() const
    00131 {
    00132    return 0;
    00133 }
    00134 #endif // XDKWRL_APPEARANCE_H
    00135
    00136 // Local variables section.
    00137 // This is only used by emacs!
    00138 // Local Variables:
    00139 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00140 // End:

Generated on 5 Jan 2007 with version 1.5.1. |