XdkWrl: cylinder.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# cylinder.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_CYLINDER_H
    00002 #define XDKWRL_CYLINDER_H
    00003
    00004 #include <xdkwrl/config.h>
    00005 #include <xdkwrl/node.h>
    00006 #include <xdkwrl/fieldtypes/sfbool.h>
    00007 #include <xdkwrl/fieldtypes/sffloat.h>
    00008
    00009 namespace wrl
    00010 {
    00011   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00012   // Interface of Cylinder
    00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00014   class XDKWRL_EXPORT Cylinder : public Node
    00015   {
    00016    public:
    00017      Cylinder(const char* name="");
    00018      virtual ~Cylinder();
    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      /*!@name Fields
    00040       * A property or attribute of a node. Each node type has a fixed set
    00041       * of fields. Fields may contain various kinds of data and one or many
    00042       * values. Each field has a default value.
    00043       */
    00044       //!@{
    00045       /*!
    00046        * See <a href="#_details" class="md">Detailed Description</a>
    00047        * for meaning of this field.
    00048        * Default value is set to
    00049        \code
    00050        bottom = true;
    00051         \endcode
    00052        */
    00053        SFBool     bottom;
    00054       /*!
    00055        * See <a href="#_details" class="md">Detailed Description</a>
    00056        * for meaning of this field.
    00057        * Default value is set to
    00058        \code
    00059        height = 2.0f;
    00060         \endcode
    00061        */
    00062        SFFloat    height;
    00063       /*!
    00064        * See <a href="#_details" class="md">Detailed Description</a>
    00065        * for meaning of this field.
    00066        * Default value is set to
    00067        \code
    00068        radius = 1.0f;
    00069         \endcode
    00070        */
    00071        SFFloat    radius;
    00072       /*!
    00073        * See <a href="#_details" class="md">Detailed Description</a>
    00074        * for meaning of this field.
    00075        * Default value is set to
    00076        \code
    00077        side = true;
    00078         \endcode
    00079        */
    00080        SFBool     side;
    00081       /*!
    00082        * See <a href="#_details" class="md">Detailed Description</a>
    00083        * for meaning of this field.
    00084        * Default value is set to
    00085        \code
    00086        top = true;
    00087         \endcode
    00088        */
    00089        SFBool     top;
    00090      //!@}
    00091      /*!@name Events In
    00092       *
    00093       */
    00094       //!@{
    00095   //!@}
    00096      /*!@name Events Out
    00097       *
    00098       */
    00099       //!@{
    00100   //!@}
    00101   };
    00102 };
    00103 //************************************************************
    00104 // Implementation of Cylinder
    00105 //************************************************************
    00106 /*!
    00107  * Returns <code>"Cylinder"</code>. Useful for printing.
    00108  */
    00109 inline const char*
    00110 wrl::Cylinder::typeName() const
    00111 {
    00112   return "Cylinder";
    00113 }
    00114 /*!
    00115  * Returns the number of fields (exposed or not) for this node type.
    00116  */
    00117 inline unsigned int
    00118 wrl::Cylinder::nbFields() const
    00119 {
    00120    return 5;
    00121 }
    00122 /*!
    00123  * Returns the number of events in for this node type.
    00124  */
    00125 inline unsigned int
    00126 wrl::Cylinder::nbEventsIn() const
    00127 {
    00128    return 0;
    00129 }
    00130 /*!
    00131  * Returns the number of events out for this node type.
    00132  */
    00133 inline unsigned int
    00134 wrl::Cylinder::nbEventsOut() const
    00135 {
    00136    return 0;
    00137 }
    00138 #endif // XDKWRL_CYLINDER_H
    00139
    00140 // Local variables section.
    00141 // This is only used by emacs!
    00142 // Local Variables:
    00143 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00144 // End:

Generated on 5 Jan 2007 with version 1.5.1. |