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

Class BaseComposedCubeMapTexture

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseTextureNode

org.web3d.vrml.renderer.common.nodes.texture.BaseComposedCubeMapTexture

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLComposedTextureNodeType, VRMLEnvironmentTextureNodeType, VRMLNodeType, VRMLTextureNodeType

Direct Known Subclasses:

NRComposedCubeMapTexture

public class BaseComposedCubeMapTexture
extends BaseTextureNode
implements VRMLEnvironmentTextureNodeType, VRMLComposedTextureNodeType

Base implementation of a ComposedCubeMapTexture node.

Version:

$Revision: 1.5 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_BACK	back texture children Index
protected static final int	FIELD_BOTTOM	bottom texture children Index
protected static final int	FIELD_FRONT	front texture children Index
protected static final int	FIELD_LEFT	left texture children Index
protected static final int	FIELD_RIGHT	right texture children Index
protected static final int	FIELD_TOP	top texture children Index
protected static VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected static final int	LAST_COMPOSED_ENVTEXTURE_INDEX	Index of the last field of this node
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pBack	proto version of back field
protected VRMLProtoInstance	pBottom	proto version of right field
protected VRMLProtoInstance	pFront	proto version of front field
protected VRMLProtoInstance	pLeft	proto version of left field
protected VRMLProtoInstance	pRight	proto version of right field
protected VRMLProtoInstance	pTop	proto version of top field
protected VRMLTexture2DNodeType	vfBack	exposedField SFNode back NULL
protected VRMLTexture2DNodeType	vfBottom	exposedField SFNode bottom NULL
protected VRMLTexture2DNodeType	vfFront	exposedField SFNode front NULL
protected VRMLTexture2DNodeType	vfLeft	exposedField SFNode left NULL
protected VRMLTexture2DNodeType	vfRight	exposedField SFNode right NULL
protected VRMLTexture2DNodeType	vfTop	exposedField SFNode top NULL

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

listenerList

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	BaseComposedCubeMapTexture()	Default constructor.
protected	BaseComposedCubeMapTexture(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.
NIOBufferImage	getImage()	Get the image representation of this texture.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumberTextures()	Get the number of textures in this ComposedTexture node.
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
void	getTextures(int start, VRMLTextureNodeType[] texs)	Get the textures which make up this composed texture.
int	getTextureType()	Get the texture type of this texture.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setTextureNode(int index, VRMLNodeType node)	Add a single texture node to the list of textures.
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.BaseTextureNode

addTextureListener, fireTextureImageChanged, fireTextureParamsChanged, getCacheString, removeTextureListener

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

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

addTextureListener, getCacheString, removeTextureListener

Field Details

FIELD_FRONT

protected static final int FIELD_FRONT

front texture children Index

See Also:

• Constant Field Values

FIELD_BACK

protected static final int FIELD_BACK

back texture children Index

See Also:

• Constant Field Values

FIELD_LEFT

protected static final int FIELD_LEFT

left texture children Index

See Also:

• Constant Field Values

FIELD_RIGHT

protected static final int FIELD_RIGHT

right texture children Index

See Also:

• Constant Field Values

FIELD_TOP

protected static final int FIELD_TOP

top texture children Index

See Also:

• Constant Field Values

FIELD_BOTTOM

protected static final int FIELD_BOTTOM

bottom texture children Index

See Also:

• Constant Field Values

LAST_COMPOSED_ENVTEXTURE_INDEX

protected static final int LAST_COMPOSED_ENVTEXTURE_INDEX

Index of the last field of this node

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

fieldDecl

protected static VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfFront

protected VRMLTexture2DNodeType vfFront

exposedField SFNode front NULL

pFront

protected VRMLProtoInstance pFront

proto version of front field

vfBack

protected VRMLTexture2DNodeType vfBack

exposedField SFNode back NULL

pBack

protected VRMLProtoInstance pBack

proto version of back field

vfLeft

protected VRMLTexture2DNodeType vfLeft

exposedField SFNode left NULL

pLeft

protected VRMLProtoInstance pLeft

proto version of left field

vfRight

protected VRMLTexture2DNodeType vfRight

exposedField SFNode right NULL

pRight

protected VRMLProtoInstance pRight

proto version of right field

vfTop

protected VRMLTexture2DNodeType vfTop

exposedField SFNode top NULL

pTop

protected VRMLProtoInstance pTop

proto version of top field

vfBottom

protected VRMLTexture2DNodeType vfBottom

exposedField SFNode bottom NULL

pBottom

protected VRMLProtoInstance pBottom

proto version of right field

Constructor Details

BaseComposedCubeMapTexture

protected BaseComposedCubeMapTexture()

Default constructor.

BaseComposedCubeMapTexture

protected BaseComposedCubeMapTexture(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - Incorrect Node Type

Method Details

getTextureType

public int getTextureType()

Get the texture type of this texture. Valid entries are defined in the vrml.lang.TextureConstants.

Specified by:

getTextureType in interface VRMLTextureNodeType

Returns:

the texture type of this texture

getNumberTextures

public int getNumberTextures()

Get the number of textures in this ComposedTexture node. Always return a value of 6.

Specified by:

getNumberTextures in interface VRMLComposedTextureNodeType

Returns:

The number of active textures.

getTextures

public void getTextures(int start,
 VRMLTextureNodeType[] texs)

Get the textures which make up this composed texture.

Specified by:

getTextures in interface VRMLComposedTextureNodeType

Parameters:

start - Where in the array to start filling in textures.

texs - The preallocated array to return texs in. Error if too small.

getImage

public NIOBufferImage getImage()

Get the image representation of this texture.

Returns:

The image.

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,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException

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 know

InvalidFieldValueException - The value provided does not fit this type of node

setTextureNode

protected void setTextureNode(int index,
 VRMLNodeType node)
                       throws InvalidFieldValueException

Add a single texture node to the list of textures. Override this to add render-specific behavior, bu~t remember to call this method.

Parameters:

index - The index of the field

node - The node to add

Throws:

InvalidFieldValueException - This is a bindable node shared