Home Hierarchy Members Alphabetical Related Pages

pixeltexture.h

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

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