spotlight.h

Go to the documentation of this file.

#ifndef XDKWRL_SPOTLIGHT_H
#define XDKWRL_SPOTLIGHT_H

#include <xdkwrl/node.h>
#include <xdkwrl/fieldtypes/sfbool.h>
#include <xdkwrl/fieldtypes/sfcolor.h>
#include <xdkwrl/fieldtypes/sffloat.h>
#include <xdkwrl/fieldtypes/sfvec3f.h>

namespace wrl
{
  //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  // Interface of SpotLight
  //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  class SpotLight : public Node
  {
   public:
     SpotLight(const char* name="");
     virtual ~SpotLight();
     virtual inline unsigned int nbFields() const;
     virtual FieldHandle field(const std::string& n);
     virtual FieldHandle field(const unsigned int i);
     virtual bool isSetToDefaultValue(const unsigned int i) const;
     virtual inline unsigned int nbEventsIn() const;
     virtual EventInHandle eventIn(const std::string& n);
     virtual EventInHandle eventIn(const unsigned int i);
     virtual inline unsigned int nbEventsOut() const;
     virtual EventOutHandle eventOut(const std::string& n);
     virtual EventOutHandle eventOut(const unsigned int i);
     inline const char* typeName() const;
     virtual Node* duplicate() const;
     virtual Node* duplicate(std::map<const Node*,Node*>&) const;
     /*!@name Exposed Fields
      * A field that is capable of receiving events via an eventIn to 
      * change its value(s), and generating events via an eventOut 
      * when its value(s) change.
      */
      //!@{
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       ambientIntensity = 0;
       \endcode
       */
       SFFloat    ambientIntensity;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       attenuation.setXYZ(1,0,0);
       \endcode
       */
       SFVec3f    attenuation;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       beamWidth = 1.5708;
       \endcode
       */
       SFFloat    beamWidth;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       color.setRGB(1,1,1);
       \endcode
       */
       SFColor    color;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       cutOffAngle = 0.785398;
       \endcode
       */
       SFFloat    cutOffAngle;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       direction.setXYZ(0,0,-1);
       \endcode
       */
       SFVec3f    direction;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       intensity = 1;
       \endcode
       */
       SFFloat    intensity;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       location.setXYZ(0,0,0);
       \endcode
       */
       SFVec3f    location;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       on = true;
       \endcode
       */
       SFBool     on;
      /*!
       * See <a href="#_details" class="md">Detailed Description</a>
       * for meaning of this field.
       * Default value is set to 
       \code
       radius = 100;
       \endcode
       */
       SFFloat    radius;
     //!@}
     /*!@name Fields
      * A property or attribute of a node. Each node type has a fixed set
      * of fields. Fields may contain various kinds of data and one or many
      * values. Each field has a default value.
      */
      //!@{
     //!@}
     /*!@name Events In
      * 
      */
      //!@{
      /*!
       * Set event associated to exposedField ambientIntensity
       */
       EventIn<SFFloat>    set_ambientIntensity;
      /*!
       * Set event associated to exposedField attenuation
       */
       EventIn<SFVec3f>    set_attenuation;
      /*!
       * Set event associated to exposedField beamWidth
       */
       EventIn<SFFloat>    set_beamWidth;
      /*!
       * Set event associated to exposedField color
       */
       EventIn<SFColor>    set_color;
      /*!
       * Set event associated to exposedField cutOffAngle
       */
       EventIn<SFFloat>    set_cutOffAngle;
      /*!
       * Set event associated to exposedField direction
       */
       EventIn<SFVec3f>    set_direction;
      /*!
       * Set event associated to exposedField intensity
       */
       EventIn<SFFloat>    set_intensity;
      /*!
       * Set event associated to exposedField location
       */
       EventIn<SFVec3f>    set_location;
      /*!
       * Set event associated to exposedField on
       */
       EventIn<SFBool>     set_on;
      /*!
       * Set event associated to exposedField radius
       */
       EventIn<SFFloat>    set_radius;
  //!@}
     /*!@name Events Out
      * 
      */
      //!@{
      /*!
       * Changed event associated to exposedField ambientIntensity
       */
       EventOut<SFFloat>    ambientIntensity_changed;
      /*!
       * Changed event associated to exposedField attenuation
       */
       EventOut<SFVec3f>    attenuation_changed;
      /*!
       * Changed event associated to exposedField beamWidth
       */
       EventOut<SFFloat>    beamWidth_changed;
      /*!
       * Changed event associated to exposedField color
       */
       EventOut<SFColor>    color_changed;
      /*!
       * Changed event associated to exposedField cutOffAngle
       */
       EventOut<SFFloat>    cutOffAngle_changed;
      /*!
       * Changed event associated to exposedField direction
       */
       EventOut<SFVec3f>    direction_changed;
      /*!
       * Changed event associated to exposedField intensity
       */
       EventOut<SFFloat>    intensity_changed;
      /*!
       * Changed event associated to exposedField location
       */
       EventOut<SFVec3f>    location_changed;
      /*!
       * Changed event associated to exposedField on
       */
       EventOut<SFBool>     on_changed;
      /*!
       * Changed event associated to exposedField radius
       */
       EventOut<SFFloat>    radius_changed;
  //!@}
  };
};
//************************************************************
// Implementation of SpotLight
//************************************************************
/*!
 * Returns <code>"SpotLight"</code>. Useful for printing.
 */
inline const char*
wrl::SpotLight::typeName() const
{
  return "SpotLight";
}
/*!
 * Returns the number of fields (exposed or not) for this node type.
 */
inline unsigned int
wrl::SpotLight::nbFields() const
{
   return 10;
}
/*!
 * Returns the number of events in for this node type.
 */
inline unsigned int
wrl::SpotLight::nbEventsIn() const
{
   return 0;
}
/*!
 * Returns the number of events out for this node type.
 */
inline unsigned int
wrl::SpotLight::nbEventsOut() const
{
   return 0;
}
#endif // XDKWRL_SPOTLIGHT_H

// Local variables section.
// This is only used by emacs!
// Local Variables:
// ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
// End:

---

Generated on 24 Feb 2005 with version 1.3.9.1.