Home Hierarchy Members Alphabetical Related Pages

PointLight Class Reference
[Standard Node Types]

#include <pointlight.h>

Inherits Node.

List of all members.

Public Member Functions

 PointLight (const char *name="")
virtual ~PointLight ()
virtual unsigned int nbFields () const
virtual FieldHandle field (const std::string &n)
virtual FieldHandle field (unsigned int i)
virtual bool isSetToDefaultValue (unsigned int i) const
virtual unsigned int nbEventsIn () const
virtual EventInHandle eventIn (const std::string &n)
virtual EventInHandle eventIn (unsigned int i)
virtual unsigned int nbEventsOut () const
virtual EventOutHandle eventOut (const std::string &n)
virtual EventOutHandle eventOut (unsigned int i)
const char * typeName () const
virtual Nodeduplicate () const
virtual Nodeduplicate (std::map< const Node *, Node * > &) const

Public Attributes

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.

SFFloat ambientIntensity
SFVec3f attenuation
SFColor color
SFFloat intensity
SFVec3f location
SFBool on
SFFloat radius
Events In
EventIn< SFFloatset_ambientIntensity
EventIn< SFVec3fset_attenuation
EventIn< SFColorset_color
EventIn< SFFloatset_intensity
EventIn< SFVec3fset_location
EventIn< SFBoolset_on
EventIn< SFFloatset_radius
Events Out
EventOut< SFFloatambientIntensity_changed
EventOut< SFVec3fattenuation_changed
EventOut< SFColorcolor_changed
EventOut< SFFloatintensity_changed
EventOut< SFVec3flocation_changed
EventOut< SFBoolon_changed
EventOut< SFFloatradius_changed


Detailed Description

Here is the documentation for this node type, from the ISO standard.

+6.53 PointLight

The PointLight node specifies a point light source at a 3D location in the local coordinate system. A point light source emits light equally in all directions; that is, it is omnidirectional. PointLight nodes are specified in the local coordinate system and are affected by ancestor transformations.

Subclause 4.6.6, Light sources, contains a detailed description of the ambientIntensity, color, and intensity fields.

A PointLight node illuminates geometry within radius metres of its location. Both radius and location are affected by ancestors' transformations (scales affect radius and transformations affect location). The radius field shall be greater than or equal to zero.

PointLight node's illumination falls off with distance as specified by three attenuation coefficients. The attenuation factor is 1/max(attenuation[0] + attenuation[1]×r + attenuation[2]×r2, 1), where r is the distance from the light to the surface being illuminated. The default is no attenuation. An attenuation value of (0, 0, 0) is identical to (1, 0, 0). Attenuation values shall be greater than or equal to zero. A detailed description of VRML's lighting equations is contained in 4.14, Lighting model.

--- VRML separator bar ---


Constructor & Destructor Documentation

PointLight ( const char *  name = ""  ) 

Construct a node with all its fields set to default value, which is equivalent to the code below:

  ambientIntensity = 0.0f;
  attenuation.setXYZ(1,0,0);
  color.setRGB(1,1,1);
  intensity = 1.0f;
  location.setXYZ(0,0,0);
  on = true;
  radius = 100.0f;

~PointLight (  )  [virtual]

Virtual destructor, does nothing


Member Function Documentation

unsigned int nbFields (  )  const [inline, virtual]

Returns the number of fields (exposed or not) for this node type.

Implements Node.

wrl::Node::FieldHandle field ( const std::string &  n  )  [virtual]

Return a handle on the field named n of the node or a "unknown" typed handle if there is no such field. Valid names are:

Implements Node.

wrl::Node::FieldHandle field ( unsigned int  n  )  [virtual]

Return a handle on the i th field of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

Implements Node.

bool isSetToDefaultValue ( unsigned int  i  )  const [virtual]

Implements Node.

unsigned int nbEventsIn (  )  const [inline, virtual]

Returns the number of events in for this node type.

Implements Node.

wrl::Node::EventInHandle eventIn ( const std::string &  n  )  [virtual]

Return a handle on the event in named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

Implements Node.

wrl::Node::EventInHandle eventIn ( unsigned int  n  )  [virtual]

Return a handle on the i th event in of the node or a "unknown" typed handle if there is no such node. emarks This class has no eventIn. This function is useful, with nbEventsIn() if you want to traverse all events in of a Node.

Implements Node.

unsigned int nbEventsOut (  )  const [inline, virtual]

Returns the number of events out for this node type.

Implements Node.

wrl::Node::EventOutHandle eventOut ( const std::string &  n  )  [virtual]

Return a handle on the event out named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

Implements Node.

wrl::Node::EventOutHandle eventOut ( unsigned int  n  )  [virtual]

Return a handle on the i th event out of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

Implements Node.

const char * typeName (  )  const [inline, virtual]

Returns "PointLight". Useful for printing.

Implements Node.

wrl::Node * duplicate (  )  const [virtual]

Returns a deep copy of this node, that is a fully independant node with all children (if any) also copied. This is mainly useful for instanciating protos.

Implements Node.

virtual Node* duplicate ( std::map< const Node *, Node * > &   )  const [virtual]

Implements Node.


Member Data Documentation

SFFloat ambientIntensity

See Detailed Description for meaning of this field. Default value is set to

SFVec3f attenuation

See Detailed Description for meaning of this field. Default value is set to

       attenuation.setXYZ(1,0,0);

SFColor color

See Detailed Description for meaning of this field. Default value is set to

       color.setRGB(1,1,1);

SFFloat intensity

See Detailed Description for meaning of this field. Default value is set to

       intensity = 1.0f;

SFVec3f location

See Detailed Description for meaning of this field. Default value is set to

       location.setXYZ(0,0,0);

SFBool on

See Detailed Description for meaning of this field. Default value is set to

       on = true;

SFFloat radius

See Detailed Description for meaning of this field. Default value is set to

       radius = 100.0f;

EventIn<SFFloat> set_ambientIntensity

Set event associated to exposedField ambientIntensity

EventIn<SFVec3f> set_attenuation

Set event associated to exposedField attenuation

EventIn<SFColor> set_color

Set event associated to exposedField color

EventIn<SFFloat> set_intensity

Set event associated to exposedField intensity

EventIn<SFVec3f> set_location

Set event associated to exposedField location

EventIn<SFBool> set_on

Set event associated to exposedField on

EventIn<SFFloat> set_radius

Set event associated to exposedField radius

EventOut<SFFloat> ambientIntensity_changed

Changed event associated to exposedField ambientIntensity

EventOut<SFVec3f> attenuation_changed

Changed event associated to exposedField attenuation

EventOut<SFColor> color_changed

Changed event associated to exposedField color

EventOut<SFFloat> intensity_changed

Changed event associated to exposedField intensity

EventOut<SFVec3f> location_changed

Changed event associated to exposedField location

EventOut<SFBool> on_changed

Changed event associated to exposedField on

EventOut<SFFloat> radius_changed

Changed event associated to exposedField radius


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