Package org.web3d.vrml.renderer.ogl.nodes.lighting

Class OGLDirectionalLight

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseLightNode

org.web3d.vrml.renderer.common.nodes.lighting.BaseDirectionalLight

org.web3d.vrml.renderer.ogl.nodes.lighting.OGLDirectionalLight

All Implemented Interfaces:

org.j3d.aviatrix3d.NodeUpdateListener, VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLLightNodeType, VRMLNodeType, VRMLWorldRootChildNodeType, OGLLightNodeType, OGLVRMLNode

public class OGLDirectionalLight
extends BaseDirectionalLight
implements OGLLightNodeType, org.j3d.aviatrix3d.NodeUpdateListener

OpenGL implementation of a directional light.

Version:

$Revision: 1.8 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.lighting.BaseDirectionalLight

FIELD_DIRECTION, LAST_DIRECTIONALLIGHT_INDEX, NUM_FIELDS, vfDirection

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseLightNode

FIELD_AMBIENT_INTENSITY, FIELD_COLOR, FIELD_GLOBAL, FIELD_INTENSITY, FIELD_ON, GLOBAL_VERSION_ERR, LAST_LIGHT_INDEX, vfAmbientIntensity, vfColor, vfGlobal, vfIntensity, vfOn

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Constructor	Description
OGLDirectionalLight()	Construct a new default instance of this class.
OGLDirectionalLight(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
org.j3d.aviatrix3d.Light	getLight()	Get the light making up this LightNode.
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the Java3D scene graph object representation of this node.
void	setAmbientIntensity(float intensity)	Accessor method to get current value of field ambientIntensity.
void	setColor(float[] newColor)	Accessor method to get current value of field color.
protected void	setDirection(float[] dir)	Set the direction ofthe spot light.
void	setGlobal(boolean global)	Set the current value of the global field.
void	setIntensity(float intensity)	Accessor method to get current value of field Intensity.
void	setOn(boolean state)	Turn the light on or off.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	updateNodeBoundsChanges(Object src)	Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.
void	updateNodeDataChanges(Object src)	Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.lighting.BaseDirectionalLight

getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, sendRoute, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseLightNode

copy, getAmbientIntensity, getColor, getGlobal, getIntensity, getOn, getPrimaryType, setValue, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Methods inherited from interface org.web3d.vrml.nodes.VRMLLightNodeType

getAmbientIntensity, getColor, getGlobal, getIntensity, getOn

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Constructor Details

OGLDirectionalLight

public OGLDirectionalLight()

Construct a new default instance of this class.

OGLDirectionalLight

public OGLDirectionalLight(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a light node, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - Incorrect Node Type

Method Details

getLight

public org.j3d.aviatrix3d.Light getLight()

Get the light making up this LightNode.

Specified by:

getLight in interface OGLLightNodeType

Returns:

The OGL light instance

updateNodeBoundsChanges

public void updateNodeBoundsChanges(Object src)

Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.

Specified by:

updateNodeBoundsChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

updateNodeDataChanges

public void updateNodeDataChanges(Object src)

Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Specified by:

updateNodeDataChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

setAmbientIntensity

public void setAmbientIntensity(float intensity)
                         throws InvalidFieldValueException

Accessor method to get current value of field ambientIntensity.

Specified by:

setAmbientIntensity in interface VRMLLightNodeType

Overrides:

setAmbientIntensity in class BaseLightNode

Parameters:

intensity - The new value

Throws:

InvalidFieldValueException - The value was out of the valid range

setColor

public void setColor(float[] newColor)
              throws InvalidFieldValueException

Accessor method to get current value of field color.

Specified by:

setColor in interface VRMLLightNodeType

Overrides:

setColor in class BaseLightNode

Parameters:

newColor - The new value

Throws:

InvalidFieldValueException - The value was out of the valid range

setIntensity

public void setIntensity(float intensity)
                  throws InvalidFieldValueException

Accessor method to get current value of field Intensity.

Specified by:

setIntensity in interface VRMLLightNodeType

Overrides:

setIntensity in class BaseLightNode

Parameters:

intensity - The new value

Throws:

InvalidFieldValueException - The value was out of the valid range

setOn

public void setOn(boolean state)

Turn the light on or off.

Specified by:

setOn in interface VRMLLightNodeType

Overrides:

setOn in class BaseLightNode

Parameters:

state - The new value

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the Java3D scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The J3D representation.

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

setGlobal

public void setGlobal(boolean global)
               throws InvalidFieldException

Set the current value of the global field.

Specified by:

setGlobal in interface VRMLLightNodeType

Overrides:

setGlobal in class BaseLightNode

Parameters:

global - true if this should have global effect, false for scoped

Throws:

InvalidFieldException - Called on a node that belongs to VRML or X3D 3.0.

setDirection

protected void setDirection(float[] dir)

Set the direction ofthe spot light. Should be overridden by derived classes for implementation-specific additions.

Overrides:

setDirection in class BaseDirectionalLight

Parameters:

dir - The new direction vector to use