Home Hierarchy Members Alphabetical Related Pages

DirectionalLight Class Reference
[Standard Node Types]

#include <directionallight.h>

Inherits Node.

Inheritance diagram for DirectionalLight:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 DirectionalLight (const char *name="")
virtual ~DirectionalLight ()
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
SFColor color
SFVec3f direction
SFFloat intensity
SFBool on
Events In
EventIn< SFFloat > set_ambientIntensity
EventIn< SFColor > set_color
EventIn< SFVec3f > set_direction
EventIn< SFFloat > set_intensity
EventIn< SFBool > set_on
Events Out
EventOut< SFFloat > ambientIntensity_changed
EventOut< SFColor > color_changed
EventOut< SFVec3f > direction_changed
EventOut< SFFloat > intensity_changed
EventOut< SFBool > on_changed

Detailed Description

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

+6.18 DirectionalLight

The DirectionalLight node defines a directional light source that illuminates along rays parallel to a given 3-dimensional vector. A description of the ambientIntensity, color, intensity, and on fields is in 4.6.6, Light sources.

The direction field specifies the direction vector of the illumination emanating from the light source in the local coordinate system. Light is emitted along parallel rays from an infinite distance away. A directional light source illuminates only the objects in its enclosing parent group. The light may illuminate everything within this coordinate system, including all children and descendants of its parent group. The accumulated transformations of the parent nodes affect the light.

DirectionalLight nodes do not attenuate with distance. A precise description of VRML's lighting equations is contained in 4.14, Lighting model.

--- VRML separator bar ---

Constructor & Destructor Documentation

DirectionalLight (  const char *  name = ""  ) 
 

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

  ambientIntensity = 0;
  color.setRGB(1,1,1);
  direction.setXYZ(0,0,-1);
  intensity = 1;
  on = true;

~DirectionalLight (   )  [virtual]
 

Virtual destructor, does nothing

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_color
  • set_direction
  • set_intensity
  • set_on

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 : color_changed
  • 2 : direction_changed
  • 3 : intensity_changed
  • 4 : on_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
  • color_changed
  • direction_changed
  • intensity_changed
  • on_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 : color
  • 2 : direction
  • 3 : intensity
  • 4 : on 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
  • color
  • direction
  • intensity
  • on

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 "DirectionalLight". Useful for printing.

Implements Node.

Member Data Documentation

SFFloat ambientIntensity
 

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

       ambientIntensity = 0;

EventOut<SFFloat> ambientIntensity_changed
 

Changed event associated to exposedField ambientIntensity

SFColor color
 

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

       color.setRGB(1,1,1);

EventOut<SFColor> color_changed
 

Changed event associated to exposedField color

SFVec3f direction
 

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

       direction.setXYZ(0,0,-1);

EventOut<SFVec3f> direction_changed
 

Changed event associated to exposedField direction

SFFloat intensity
 

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

       intensity = 1;

EventOut<SFFloat> intensity_changed
 

Changed event associated to exposedField intensity

SFBool on
 

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

       on = true;

EventOut<SFBool> on_changed
 

Changed event associated to exposedField on

EventIn<SFFloat> set_ambientIntensity
 

Set event associated to exposedField ambientIntensity

EventIn<SFColor> set_color
 

Set event associated to exposedField color

EventIn<SFVec3f> set_direction
 

Set event associated to exposedField direction

EventIn<SFFloat> set_intensity
 

Set event associated to exposedField intensity

EventIn<SFBool> set_on
 

Set event associated to exposedField on

Generated on 24 Feb 2005 with doxygen version 1.3.9.1. Valid HTML 4.0! Valid CSS!