Home Hierarchy Members Alphabetical Related Pages

inlineloadcontrol.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_INLINELOADCONTROL_H
00002 #define XDKWRL_INLINELOADCONTROL_H
00003 
00004 #include <xdkwrl/config.h>
00005 #include <xdkwrl/node.h>
00006 #include <xdkwrl/fieldtypes/mfnode.h>
00007 #include <xdkwrl/fieldtypes/mfstring.h>
00008 #include <xdkwrl/fieldtypes/sfbool.h>
00009 #include <xdkwrl/fieldtypes/sfvec3f.h>
00010 
00011 namespace wrl
00012 {
00013   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00014   // Interface of InlineLoadControl
00015   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00016   class XDKWRL_EXPORT InlineLoadControl : public Node
00017   {
00018    public:
00019      InlineLoadControl(const char* name="");
00020      virtual ~InlineLoadControl();
00021      virtual inline unsigned int nbFields() const;
00022      virtual FieldHandle field(const std::string& n);
00023      virtual FieldHandle field(unsigned int i);
00024      virtual bool isSetToDefaultValue(unsigned int i) const;
00025      virtual inline unsigned int nbEventsIn() const;
00026      virtual EventInHandle eventIn(const std::string& n);
00027      virtual EventInHandle eventIn(unsigned int i);
00028      virtual inline unsigned int nbEventsOut() const;
00029      virtual EventOutHandle eventOut(const std::string& n);
00030      virtual EventOutHandle eventOut(unsigned int i);
00031      inline const char* typeName() const;
00032      virtual Node* duplicate() const;
00033      virtual Node* duplicate(std::map<const Node*,Node*>&) const;
00034      /*!@name Exposed Fields
00035       * A field that is capable of receiving events via an eventIn to 
00036       * change its value(s), and generating events via an eventOut 
00037       * when its value(s) change.
00038       */
00039       //!@{
00040       /*!
00041        * See <a href="#_details" class="md">Detailed Description</a>
00042        * for meaning of this field.
00043        * Default value is set to 
00044        \code
00045        load = true;
00046        \endcode
00047        */
00048        SFBool     load;
00049       /*!
00050        * See <a href="#_details" class="md">Detailed Description</a>
00051        * for meaning of this field.
00052        * Default value is set to MFString default value
00053        */
00054        MFString   url;
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        * See <a href="#_details" class="md">Detailed Description</a>
00064        * for meaning of this field.
00065        * Default value is set to 
00066        \code
00067        bboxCenter.setXYZ(0,0,0);
00068         \endcode
00069        */
00070        SFVec3f    bboxCenter;
00071       /*!
00072        * See <a href="#_details" class="md">Detailed Description</a>
00073        * for meaning of this field.
00074        * Default value is set to 
00075        \code
00076        bboxSize.setXYZ(-1,-1,-1);
00077         \endcode
00078        */
00079        SFVec3f    bboxSize;
00080      //!@}
00081      /*!@name Events In
00082       * 
00083       */
00084       //!@{
00085       /*!
00086        * Set event associated to exposedField load
00087        */
00088        EventIn<SFBool>     set_load;
00089       /*!
00090        * Set event associated to exposedField url
00091        */
00092        EventIn<MFString>   set_url;
00093   //!@}
00094      /*!@name Events Out
00095       * 
00096       */
00097       //!@{
00098       /*!
00099        * See <a href="#_details" class="md">Detailed Description</a>
00100        * for meaning of this event.
00101        */
00102        EventOut<MFNode>     children;
00103       /*!
00104        * Changed event associated to exposedField load
00105        */
00106        EventOut<SFBool>     load_changed;
00107       /*!
00108        * Changed event associated to exposedField url
00109        */
00110        EventOut<MFString>   url_changed;
00111   //!@}
00112   };
00113 };
00114 //************************************************************
00115 // Implementation of InlineLoadControl
00116 //************************************************************
00117 /*!
00118  * Returns <code>"InlineLoadControl"</code>. Useful for printing.
00119  */
00120 inline const char*
00121 wrl::InlineLoadControl::typeName() const
00122 {
00123   return "InlineLoadControl";
00124 }
00125 /*!
00126  * Returns the number of fields (exposed or not) for this node type.
00127  */
00128 inline unsigned int
00129 wrl::InlineLoadControl::nbFields() const
00130 {
00131    return 4;
00132 }
00133 /*!
00134  * Returns the number of events in for this node type.
00135  */
00136 inline unsigned int
00137 wrl::InlineLoadControl::nbEventsIn() const
00138 {
00139    return 0;
00140 }
00141 /*!
00142  * Returns the number of events out for this node type.
00143  */
00144 inline unsigned int
00145 wrl::InlineLoadControl::nbEventsOut() const
00146 {
00147    return 1;
00148 }
00149 #endif // XDKWRL_INLINELOADCONTROL_H
00150 
00151 // Local variables section.
00152 // This is only used by emacs!
00153 // Local Variables:
00154 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00155 // End:

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