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

Class BaseSpotLight

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLLightNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRSpotLight, OGLSpotLight

public abstract class BaseSpotLight
extends BaseLightNode

Common implementation code for a SpotLight node.

Version:

$Revision: 1.13 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ATTENUATION	Index of the attenuation field
protected static final int	FIELD_BEAMWIDTH	Index of the beamWidth field
protected static final int	FIELD_CUTOFFANGLE	Index of the cutOfAngle field
protected static final int	FIELD_DIRECTION	Index of the direction field
protected static final int	FIELD_LOCATION	Index of the location field
protected static final int	FIELD_RADIUS	Index of the radius field
static final int	LAST_SPOTLIGHT_INDEX	Last value used as an index
protected float[]	vfAttenuation	exposedField SFVec3f attenuation 1 0 0
protected float	vfBeamWidth	exposedField SFFloat beamWidth 1.570796
protected float	vfCutOffAngle	exposedField SFFloat cutOffAngle 0.785398
protected float[]	vfDirection	exposedField SFVec3f direction 0 0 -1
protected float[]	vfLocation	exposedField SFVec3f location 0 0 0
protected float	vfRadius	exposedField SFFloat radius 100

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

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

Method Summary

Modifier and Type	Method	Description
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setAttenuation(float[] factor)	Set the attenuation factor of the light.
protected void	setBeamWidth(float value)	Set the beamWidth of the light.
protected void	setCutOffAngle(float value)	Set the cutOffAngle of the light.
protected void	setDirection(float[] dir)	Set the direction of the spot light.
protected void	setLocation(float[] loc)	Set the location of the point light.
protected void	setRadius(float radius)	Set the radius of the light.
void	setValue(int index, float value)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.

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

copy, getAmbientIntensity, getColor, getGlobal, getIntensity, getOn, getPrimaryType, setAmbientIntensity, setColor, setGlobal, setIntensity, setOn, 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, setupFinished, 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.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

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

Field Details

FIELD_ATTENUATION

protected static final int FIELD_ATTENUATION

Index of the attenuation field

See Also:

• Constant Field Values

FIELD_BEAMWIDTH

protected static final int FIELD_BEAMWIDTH

Index of the beamWidth field

See Also:

• Constant Field Values

FIELD_CUTOFFANGLE

protected static final int FIELD_CUTOFFANGLE

Index of the cutOfAngle field

See Also:

• Constant Field Values

FIELD_DIRECTION

protected static final int FIELD_DIRECTION

Index of the direction field

See Also:

• Constant Field Values

FIELD_LOCATION

protected static final int FIELD_LOCATION

Index of the location field

See Also:

• Constant Field Values

FIELD_RADIUS

protected static final int FIELD_RADIUS

Index of the radius field

See Also:

• Constant Field Values

LAST_SPOTLIGHT_INDEX

public static final int LAST_SPOTLIGHT_INDEX

Last value used as an index

See Also:

• Constant Field Values

vfAttenuation

protected float[] vfAttenuation

exposedField SFVec3f attenuation 1 0 0

vfBeamWidth

protected float vfBeamWidth

exposedField SFFloat beamWidth 1.570796

vfCutOffAngle

protected float vfCutOffAngle

exposedField SFFloat cutOffAngle 0.785398

vfDirection

protected float[] vfDirection

exposedField SFVec3f direction 0 0 -1

vfLocation

protected float[] vfLocation

exposedField SFVec3f location 0 0 0

vfRadius

protected float vfRadius

exposedField SFFloat radius 100

Constructor Details

BaseSpotLight

protected BaseSpotLight()

Construct a new default instance of this class.

BaseSpotLight

protected BaseSpotLight(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

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Returns:

The number of fields.

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class BaseLightNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class BaseLightNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseLightNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set SFColor and SFVec3f field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseLightNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setDirection

protected void setDirection(float[] dir)

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

Parameters:

dir - The new direction vector to use

setLocation

protected void setLocation(float[] loc)

Set the location of the point light. Should be overridden by derived classes for implementation-specific additions.

Parameters:

loc - The new location to use

setRadius

protected void setRadius(float radius)
                  throws InvalidFieldValueException

Set the radius of the light. Should be overridden by derived classes for implementation-specific additions.

Parameters:

radius - The new radius to use

Throws:

InvalidFieldValueException - Radius value was negative

setAttenuation

protected void setAttenuation(float[] factor)
                       throws InvalidFieldValueException

Set the attenuation factor of the light. Should be overridden by derived classes for implementation-specific additions.

Parameters:

factor - The new attenuation factor to use

Throws:

InvalidFieldValueException - Attenuation was not [0,1]

setBeamWidth

protected void setBeamWidth(float value)
                     throws InvalidFieldValueException

Set the beamWidth of the light. Should be overridden by derived classes for implementation-specific additions.

Parameters:

value - The new width to use in radians

Throws:

InvalidFieldValueException - Width was not 0 to PI/2

setCutOffAngle

protected void setCutOffAngle(float value)
                       throws InvalidFieldValueException

Set the cutOffAngle of the light. Should be overridden by derived classes for implementation-specific additions.

Parameters:

value - The new width to use in radians

Throws:

InvalidFieldValueException - Width was not 0 to PI/2