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

Class BaseTextureBackground

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseBindableNode

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBackgroundNodeType, VRMLBindableNodeType, VRMLChildNodeType, VRMLNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRTextureBackground, OGLTextureBackground

public abstract class BaseTextureBackground
extends BaseBindableNode
implements VRMLBackgroundNodeType

Common base implementation of a TextureBackground node.

TODO: This is a very light copy of background right now to get transparency in

Version:

$Revision: 1.9 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	BACK
protected static final int	BOTTOM
protected static final String[]	EMPTY_LIST	An empty list of URL fields for initialization
protected static final int	FIELD_BACK_TEXTURE	Index of the backUrl field
protected static final int	FIELD_BOTTOM_TEXTURE	Index of the bottomUrl field
protected static final int	FIELD_FRONT_TEXTURE	Index of the frontUrl field
protected static final int	FIELD_GROUND_ANGLE	Index of the groundAngle field
protected static final int	FIELD_GROUND_COLOR	Index of the groundColor field
protected static final int	FIELD_LEFT_TEXTURE	Index of the leftUrl field
protected static final int	FIELD_RIGHT_TEXTURE	Index of the rightUrl field
protected static final int	FIELD_SKY_ANGLE	Index of the skyAngle field
protected static final int	FIELD_SKY_COLOR	Index of the skyColor field
protected static final int	FIELD_TOP_TEXTURE	Index of the topUrl field
protected static final int	FIELD_TRANSPARENCY	Index of the topUrl field
protected static final int	FRONT
protected static final int	GROUND_SPHERE
protected static final int	LAST_BACKGROUND_INDEX	The last field index used by this class
protected static final int	LEFT
protected static final int	NUM_BG_OBJECTS
protected static final int	NUM_FIELDS	The number of fields implemented
protected int	numGroundAngle	Number of valid values in vfGroundAngle
protected int	numGroundColor	Number of valid values in vfGroundColor
protected int	numSkyAngle	Number of valid values in vfSkyAngle
protected int	numSkyColor	Number of valid values in vfSkyColor
protected static final int	RIGHT
protected static final int	SKY_SPHERE
protected static final int	TOP
protected VRMLNodeType	vfBackTexture	MFString backTexture list
protected VRMLNodeType	vfBottomTexture	MFString bottomTexture list
protected VRMLNodeType	vfFrontTexture	MFString frontTexture list
protected float[]	vfGroundAngle	MFFloat groundAngle
protected float[]	vfGroundColor	MFColor groundColor
protected VRMLNodeType	vfLeftTexture	MFString leftTexture list
protected VRMLNodeType	vfRightTexture	MFString rightTexture list
protected float[]	vfSkyAngle	MFFloat skyAngle
protected float[]	vfSkyColor	MFColor skyColor
protected VRMLNodeType	vfTopTexture	MFString topTexture list
protected float	vfTransparency	SFFloat transparency

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

FIELD_BIND, FIELD_BIND_TIME, FIELD_IS_BOUND, isOnStack, LAST_BINDABLE_INDEX, vfBindTime, vfIsBound

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	BaseTextureBackground()	Create a new, default instance of this class.
protected	BaseTextureBackground(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.
void	getGroundValues(float[] color, float[] angle)	Fetch the color and angles for the ground values.
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	getNumGroundColors()	Get the number of valid ground color values that are currently defined.
int	getNumSkyColors()	Get the number of valid sky color values that are currently defined.
int	getPrimaryType()	Get the primary type of this node.
int[]	getSecondaryType()	Get the secondary type of this node.
void	getSkyValues(float[] color, float[] angle)	Fetch the color and angles for the sky values.
float	getTransparency()	Get the transparency of the background.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setTransparency(float val)	Set the transparency of the background.
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.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of strings.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as an array of nodes.

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

addBindableNodeListener, copy, fireIsBoundChanged, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack, setValue, setVRMLClock

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, 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.VRMLBindableNodeType

addBindableNodeListener, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack

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

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, updateRefCount

Field Details

FIELD_GROUND_ANGLE

protected static final int FIELD_GROUND_ANGLE

Index of the groundAngle field

See Also:

• Constant Field Values

FIELD_GROUND_COLOR

protected static final int FIELD_GROUND_COLOR

Index of the groundColor field

See Also:

• Constant Field Values

FIELD_SKY_ANGLE

protected static final int FIELD_SKY_ANGLE

Index of the skyAngle field

See Also:

• Constant Field Values

FIELD_SKY_COLOR

protected static final int FIELD_SKY_COLOR

Index of the skyColor field

See Also:

• Constant Field Values

FIELD_BACK_TEXTURE

protected static final int FIELD_BACK_TEXTURE

Index of the backUrl field

See Also:

• Constant Field Values

FIELD_FRONT_TEXTURE

protected static final int FIELD_FRONT_TEXTURE

Index of the frontUrl field

See Also:

• Constant Field Values

FIELD_LEFT_TEXTURE

protected static final int FIELD_LEFT_TEXTURE

Index of the leftUrl field

See Also:

• Constant Field Values

FIELD_RIGHT_TEXTURE

protected static final int FIELD_RIGHT_TEXTURE

Index of the rightUrl field

See Also:

• Constant Field Values

FIELD_BOTTOM_TEXTURE

protected static final int FIELD_BOTTOM_TEXTURE

Index of the bottomUrl field

See Also:

• Constant Field Values

FIELD_TOP_TEXTURE

protected static final int FIELD_TOP_TEXTURE

Index of the topUrl field

See Also:

• Constant Field Values

FIELD_TRANSPARENCY

protected static final int FIELD_TRANSPARENCY

Index of the topUrl field

See Also:

• Constant Field Values

LAST_BACKGROUND_INDEX

protected static final int LAST_BACKGROUND_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

The number of fields implemented

See Also:

• Constant Field Values

EMPTY_LIST

protected static final String[] EMPTY_LIST

An empty list of URL fields for initialization

BACK

protected static final int BACK

See Also:

• Constant Field Values

FRONT

protected static final int FRONT

See Also:

• Constant Field Values

LEFT

protected static final int LEFT

See Also:

• Constant Field Values

RIGHT

protected static final int RIGHT

See Also:

• Constant Field Values

TOP

protected static final int TOP

See Also:

• Constant Field Values

BOTTOM

protected static final int BOTTOM

See Also:

• Constant Field Values

SKY_SPHERE

protected static final int SKY_SPHERE

See Also:

• Constant Field Values

GROUND_SPHERE

protected static final int GROUND_SPHERE

See Also:

• Constant Field Values

NUM_BG_OBJECTS

protected static final int NUM_BG_OBJECTS

See Also:

• Constant Field Values

vfBackTexture

protected VRMLNodeType vfBackTexture

MFString backTexture list

vfFrontTexture

protected VRMLNodeType vfFrontTexture

MFString frontTexture list

vfLeftTexture

protected VRMLNodeType vfLeftTexture

MFString leftTexture list

vfRightTexture

protected VRMLNodeType vfRightTexture

MFString rightTexture list

vfTopTexture

protected VRMLNodeType vfTopTexture

MFString topTexture list

vfBottomTexture

protected VRMLNodeType vfBottomTexture

MFString bottomTexture list

vfGroundAngle

protected float[] vfGroundAngle

MFFloat groundAngle

vfGroundColor

protected float[] vfGroundColor

MFColor groundColor

vfSkyAngle

protected float[] vfSkyAngle

MFFloat skyAngle

vfSkyColor

protected float[] vfSkyColor

MFColor skyColor

vfTransparency

protected float vfTransparency

SFFloat transparency

numGroundAngle

protected int numGroundAngle

Number of valid values in vfGroundAngle

numGroundColor

protected int numGroundColor

Number of valid values in vfGroundColor

numSkyAngle

protected int numSkyAngle

Number of valid values in vfSkyAngle

numSkyColor

protected int numSkyColor

Number of valid values in vfSkyColor

Constructor Details

BaseTextureBackground

protected BaseTextureBackground()

Create a new, default instance of this class.

BaseTextureBackground

protected BaseTextureBackground(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the right type.

Method Details

getTransparency

public float getTransparency()

Get the transparency of the background.

Specified by:

getTransparency in interface VRMLBackgroundNodeType

Returns:

the transparency of the background

setTransparency

public void setTransparency(float val)

Set the transparency of the background.

Specified by:

setTransparency in interface VRMLBackgroundNodeType

Parameters:

val - The transparency value

getNumSkyColors

public int getNumSkyColors()

Get the number of valid sky color values that are currently defined.

Specified by:

getNumSkyColors in interface VRMLBackgroundNodeType

Returns:

The number of values

getNumGroundColors

public int getNumGroundColors()

Get the number of valid ground color values that are currently defined.

Specified by:

getNumGroundColors in interface VRMLBackgroundNodeType

Returns:

The number of values

getSkyValues

public void getSkyValues(float[] color,
 float[] angle)

Fetch the color and angles for the sky values. Assumes that the sky color size is at least 1.

Specified by:

getSkyValues in interface VRMLBackgroundNodeType

Parameters:

color - The array to return the color values in

angle - The array to return the angle values in

getGroundValues

public void getGroundValues(float[] color,
 float[] angle)

Fetch the color and angles for the ground values. Assumes that the ground color size is at least 1.

Specified by:

getGroundValues in interface VRMLBackgroundNodeType

Parameters:

color - The array to return the color values in

angle - The array to return the angle values in

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

getSecondaryType

public int[] getSecondaryType()

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

Specified by:

getSecondaryType in interface VRMLNode

Overrides:

getSecondaryType in class BaseBindableNode

Returns:

The secondary 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 BaseBindableNode

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 BaseBindableNode

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 fields.

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 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 SFVec3f field types bboxCenter and bboxSize.

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 out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

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

Set the value of the field at the given index as an array of strings. This would be used to set MFString field type url.

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 out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

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

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now