XdkWrl: cone.h Source File

Home | Hierarchy | Members | Alphabetical | Related Pages

# cone.h

Go to the documentation of this file.

    00001 #ifndef XDKWRL_CONE_H
    00002 #define XDKWRL_CONE_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 Cone
    00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    00014   class XDKWRL_EXPORT Cone : public Node
    00015   {
    00016    public:
    00017      Cone(const char* name="");
    00018      virtual ~Cone();
    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        bottomRadius = 1.0f;
    00051         \endcode
    00052        */
    00053        SFFloat    bottomRadius;
    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        side = true;
    00069         \endcode
    00070        */
    00071        SFBool     side;
    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        bottom = true;
    00078         \endcode
    00079        */
    00080        SFBool     bottom;
    00081      //!@}
    00082      /*!@name Events In
    00083       *
    00084       */
    00085       //!@{
    00086   //!@}
    00087      /*!@name Events Out
    00088       *
    00089       */
    00090       //!@{
    00091   //!@}
    00092   };
    00093 };
    00094 //************************************************************
    00095 // Implementation of Cone
    00096 //************************************************************
    00097 /*!
    00098  * Returns <code>"Cone"</code>. Useful for printing.
    00099  */
    00100 inline const char*
    00101 wrl::Cone::typeName() const
    00102 {
    00103   return "Cone";
    00104 }
    00105 /*!
    00106  * Returns the number of fields (exposed or not) for this node type.
    00107  */
    00108 inline unsigned int
    00109 wrl::Cone::nbFields() const
    00110 {
    00111    return 4;
    00112 }
    00113 /*!
    00114  * Returns the number of events in for this node type.
    00115  */
    00116 inline unsigned int
    00117 wrl::Cone::nbEventsIn() const
    00118 {
    00119    return 0;
    00120 }
    00121 /*!
    00122  * Returns the number of events out for this node type.
    00123  */
    00124 inline unsigned int
    00125 wrl::Cone::nbEventsOut() const
    00126 {
    00127    return 0;
    00128 }
    00129 #endif // XDKWRL_CONE_H
    00130
    00131 // Local variables section.
    00132 // This is only used by emacs!
    00133 // Local Variables:
    00134 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
    00135 // End:

Generated on 5 Jan 2007 with version 1.5.1. |