H3D::X3DLightNode Class Reference
[Abstract nodes.]

The X3DLightNode abstract node type is the base type from which all node types that serve as light sources are derived. More...

#include <X3DLightNode.h>

Inheritance diagram for H3D::X3DLightNode:

List of all members.

Public Member Functions
	X3DLightNode (Inst< SFNode > _metadata=0, Inst< SFFloat > _ambientIntensity=0, Inst< SFColor > _color=0, Inst< SFFloat > _intensity=0, Inst< SFBool > _on=0)
	Constructor.
virtual void	enableGraphicsState ()
	Turn the light on.
virtual void	disableGraphicsState ()
	Turn the light off.
Public Attributes
auto_ptr< SFFloat >	ambientIntensity
	Specifies the intensity of the ambient emission from the light.
auto_ptr< SFColor >	color
	The color field specifies the spectral colour properties of both the direct and ambient light emission as an RGB value.
auto_ptr< SFFloat >	intensity
	The intensity field specifies the brightness of the direct emission from the light.
auto_ptr< SFBool >	on
	The on field specifies whether the light is enabled or disabled.
Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.
Protected Attributes
GLuint	light_index
GLint	max_lights
Static Protected Attributes
static GLuint	global_light_index = 0

---

Detailed Description

The X3DLightNode abstract node type is the base type from which all node types that serve as light sources are derived.

Any node used as a source of illumination is derived from X3DLightNode. All light sources contain an intensity, a color, and an ambientIntensity field. The intensity field specifies the brightness of the direct emission from the light, and the ambientIntensity specifies the intensity of the ambient emission from the light. Light intensity may range from 0.0 (no light emission) to 1.0 (full intensity). The color field specifies the spectral colour properties of both the direct and ambient light emission as an RGB value. The on field specifies whether the light is enabled or disabled. If the value is FALSE, then the light is disabled and will not affect any nodes in the scene. If the value is TRUE, then the light will affect other nodes.

Internal routes:

---

Member Data Documentation

auto_ptr< SFFloat > H3D::X3DLightNode::ambientIntensity

Specifies the intensity of the ambient emission from the light. Access type: inputOutput Default value: 0 Valid range: [0-1]

auto_ptr< SFColor > H3D::X3DLightNode::color

The color field specifies the spectral colour properties of both the direct and ambient light emission as an RGB value. Access type: inputOutput Default value: RGB( 1, 1, 1 ) Valid range: [0-1]

auto_ptr< SFFloat > H3D::X3DLightNode::intensity

The intensity field specifies the brightness of the direct emission from the light. Access type: inputOutput Default value: 1 Valid range: [0-1]

auto_ptr< SFBool > H3D::X3DLightNode::on

The on field specifies whether the light is enabled or disabled. If the value is FALSE, then the light is disabled and will not affect any nodes in the scene. Access type: inputOutput Default value: TRUE

---