XdkWrl: PointLight Class Reference

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]×r², 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.

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;
  attenuation.setXYZ(1,0,0);
  color.setRGB(1,1,1);
  intensity = 1;
  location.setXYZ(0,0,0);
  on = true;
  radius = 100;

Member Function Documentation

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

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.

wrl::Node::EventInHandle eventIn ( const 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.

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:

set_ambientIntensity
set_attenuation
set_color
set_intensity
set_location
set_on
set_radius

Implements Node.

wrl::Node::EventOutHandle eventOut ( const 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:

0 : ambientIntensity_changed
1 : attenuation_changed
2 : color_changed
3 : intensity_changed
4 : location_changed
5 : on_changed
6 : radius_changed This function is useful, with nbEventsOut() if you want to traverse all events in of a Node.

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:

ambientIntensity_changed
attenuation_changed
color_changed
intensity_changed
location_changed
on_changed
radius_changed

Implements Node.

wrl::Node::FieldHandle field ( const 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:

0 : ambientIntensity
1 : attenuation
2 : color
3 : intensity
4 : location
5 : on
6 : radius This function is useful, with nbFields() if you want to traverse all fields of a Node.

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:

ambientIntensity
attenuation
color
intensity
location
on
radius

Implements Node.

bool isSetToDefaultValue ( const 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.

unsigned int nbEventsOut ( ) const [inline, virtual]

Returns the number of events out for this node type.

Implements Node.

unsigned int nbFields ( ) const [inline, virtual]

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

Implements Node.

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

Returns "PointLight". Useful for printing.

Implements Node.


Public Member Functions
	PointLight (const char *name="")
virtual	~PointLight ()
virtual 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 unsigned int	nbEventsIn () const
virtual EventInHandle	eventIn (const std::string &n)
virtual EventInHandle	eventIn (const unsigned int i)
virtual unsigned int	nbEventsOut () const
virtual EventOutHandle	eventOut (const std::string &n)
virtual EventOutHandle	eventOut (const unsigned int i)
const char *	typeName () const
virtual Node *	duplicate () const
virtual Node *	duplicate (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< SFFloat >	set_ambientIntensity
EventIn< SFVec3f >	set_attenuation
EventIn< SFColor >	set_color
EventIn< SFFloat >	set_intensity
EventIn< SFVec3f >	set_location
EventIn< SFBool >	set_on
EventIn< SFFloat >	set_radius
Events Out
EventOut< SFFloat >	ambientIntensity_changed
EventOut< SFVec3f >	attenuation_changed
EventOut< SFColor >	color_changed
EventOut< SFFloat >	intensity_changed
EventOut< SFVec3f >	location_changed
EventOut< SFBool >	on_changed
EventOut< SFFloat >	radius_changed

PointLight Class Reference
[Standard Node Types]

Public Member Functions

Public Attributes

Detailed Description

6.53 PointLight

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

PointLight Class Reference [Standard Node Types]

Public Member Functions

Public Attributes

Detailed Description

6.53 PointLight

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

PointLight Class Reference
[Standard Node Types]