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

Class BaseLocalFog

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.enveffects.BaseLocalFog

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLFogNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRLocalFog, OGLLocalFog

public abstract class BaseLocalFog
extends AbstractNode
implements VRMLFogNodeType

Common base implementation of a LocalFog node.

This node is an custom extension to Xj3D node.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EXPONENTIAL_TYPE	Constant describing exponential fog type
protected static final int	FIELD_COLOR	Index for the color field
protected static final int	FIELD_ENABLED	Index of the title field
protected static final int	FIELD_FOGTYPE	Index for the fogType field
protected static final int	FIELD_VISIBILITY_RANGE	Index for the visibilityRange field
protected int	fogType	Constant representing the type used
static final int	LAST_FOG_INDEX	The last index value used in this node
protected static final String	LINEAR_TYPE	Constant describing linear fog type
protected static final int	NUM_FIELDS	Number of fields constant
protected float[]	vfColor	field SFColor color
protected boolean	vfEnabled	exposedField SFBool enabled
protected String	vfFogType	field SFString fogType
protected float	vfVisibilityRange	field SFFloat visibilityRange

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

Fields inherited from interface org.web3d.vrml.nodes.VRMLFogNodeType

FOG_TYPE_DISABLE, FOG_TYPE_EXPONENTIAL, FOG_TYPE_LINEAR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	getColor(float[] col)	Get the color of the current fog.
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	getFogType()	Get the currently set fog type.
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.
int	getPrimaryType()	Get the primary type of this node.
float	getVisibilityRange()	Get the current visibility limit on the fog to be viewed.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setColor(float[] color)	Set the color of the current fog.
void	setDEF()	Notify this node that is has been DEFd.
protected void	setEnabled(boolean state)	Set a new state for the enabled field.
void	setFogType(int type)	Set the fog type to one of the new values.
protected void	setFogType(String type)	Set the local fog type to a new value.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
void	setVisibilityRange(float range)	Set the visibility limit on the fog to be viewed to a new value.

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, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, 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, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_ENABLED

protected static final int FIELD_ENABLED

Index of the title field

See Also:

• Constant Field Values

FIELD_COLOR

protected static final int FIELD_COLOR

Index for the color field

See Also:

• Constant Field Values

FIELD_FOGTYPE

protected static final int FIELD_FOGTYPE

Index for the fogType field

See Also:

• Constant Field Values

FIELD_VISIBILITY_RANGE

protected static final int FIELD_VISIBILITY_RANGE

Index for the visibilityRange field

See Also:

• Constant Field Values

LAST_FOG_INDEX

public static final int LAST_FOG_INDEX

The last index value used in this node

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

LINEAR_TYPE

protected static final String LINEAR_TYPE

Constant describing linear fog type

See Also:

• Constant Field Values

EXPONENTIAL_TYPE

protected static final String EXPONENTIAL_TYPE

Constant describing exponential fog type

See Also:

• Constant Field Values

vfVisibilityRange

protected float vfVisibilityRange

field SFFloat visibilityRange

vfFogType

protected String vfFogType

field SFString fogType

vfColor

protected float[] vfColor

field SFColor color

fogType

protected int fogType

Constant representing the type used

vfEnabled

protected boolean vfEnabled

exposedField SFBool enabled

Constructor Details

BaseLocalFog

protected BaseLocalFog()

Construct a new default instance of this class.

BaseLocalFog

protected BaseLocalFog(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a group node, an exception will be thrown. It does not copy the children nodes, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

getColor

public void getColor(float[] col)

Get the color of the current fog.

Specified by:

getColor in interface VRMLFogNodeType

Parameters:

col - An array to copy the current color to

setColor

public void setColor(float[] color)
              throws InvalidFieldValueException

Set the color of the current fog. If the color values are out of range or the array is invalid, an exception will be generated.

Specified by:

setColor in interface VRMLFogNodeType

Parameters:

color - The new colors to set

Throws:

InvalidFieldValueException - The colour values were out of range.

getVisibilityRange

public float getVisibilityRange()

Get the current visibility limit on the fog to be viewed. A value of zero would disable the fog. It will always be a positive number.

Specified by:

getVisibilityRange in interface VRMLFogNodeType

Returns:

A non-negative number indicating the distance

setVisibilityRange

public void setVisibilityRange(float range)
                        throws InvalidFieldValueException

Set the visibility limit on the fog to be viewed to a new value. The value of zero will disable the fog. A negative number will generate an exception.

Specified by:

setVisibilityRange in interface VRMLFogNodeType

Parameters:

range - A non-negative number indicating the distance

Throws:

InvalidFieldValueException - The number was negative

getFogType

public int getFogType()

Get the currently set fog type. Will be one of the above constant values.

Specified by:

getFogType in interface VRMLFogNodeType

Returns:

One of FOG_TYPE_LINEAR or FOG_TYPE_EXPONENTIAL

setFogType

public void setFogType(int type)
                throws InvalidFieldValueException

Set the fog type to one of the new values. If the value is not known, issue an exception and leave the value at the current.

Specified by:

setFogType in interface VRMLFogNodeType

Parameters:

type - Constant indicating the type. Should be one of FOG_TYPE_LINEAR or FOG_TYPE_EXPONENTIAL

Throws:

InvalidFieldValueException - The value type is unknown

setDEF

public void setDEF()

Notify this node that is has been DEFd.

Specified by:

setDEF in interface VRMLNodeType

Overrides:

setDEF in class AbstractNode

Throws:

IllegalStateException - The setup is finished.

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.

Specified by:

getFieldIndex in interface VRMLNode

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.

Specified by:

getNodeFieldIndices in interface VRMLNode

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.

Specified by:

getFieldDeclaration in interface VRMLNode

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.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

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 AbstractNode

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 AbstractNode

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,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a boolean. This is be used to set SFBool field types isActive, enabled and loop.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The index is not a valid field

InvalidFieldValueException - The field value is not legal for the field specified.

setValue

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

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

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 know

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 AbstractNode

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

setValue

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

Set the value of the field at the given index as a string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

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 fog type string is invalid

setFogType

protected void setFogType(String type)
                   throws InvalidFieldValueException

Set the local fog type to a new value. Converts the string form to the internal representation.

Parameters:

type - The type string indicating what needs to be set

Throws:

InvalidFieldValueException - The fog type string is invalid

setEnabled

protected void setEnabled(boolean state)

Set a new state for the enabled field.

Parameters:

state - True if this sensor is to be enabled