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

Class BaseRenderedTexture

java.lang.Object

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

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

org.web3d.vrml.renderer.common.nodes.BaseTexture2DNode

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLTexture2DNodeType, VRMLTextureNodeType

Direct Known Subclasses:

NRRenderedTexture, OGLRenderedTexture

public abstract class BaseRenderedTexture
extends BaseTexture2DNode
implements VRMLTexture2DNodeType

RenderedTexture node implementation.

Version:

$Revision: 1.10 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BACKGROUND_NODE_MSG	Message for when the node in setValue() is not a Background
protected static final String	BACKGROUND_PROTO_MSG	Message for when the proto is not a Background
protected static final int	FIELD_BACKGROUND	Index of background field
protected static final int	FIELD_DIMENSIONS	Index of dimensions field
protected static final int	FIELD_FOG	Index of fog field
protected static final int	FIELD_SCENE	Index of scene field
protected static final int	FIELD_UPDATE	Index of update field
protected static final int	FIELD_VIEWPOINT	Index of viewpoint field
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 String	FOG_NODE_MSG	Message for when the node in setValue() is not a Fog
protected static final String	FOG_PROTO_MSG	Message for when the proto is not a Fog
protected static final int	LAST_RENDERED_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields implemented
protected VRMLProtoInstance	pBackground	The proto version of the background
protected VRMLProtoInstance	pFog	The proto version of the fog
protected VRMLProtoInstance	pScene	The proto version of the scene
protected VRMLProtoInstance	pViewpoint	The proto version of the viewpoint
protected static final String	SCENE_NODE_MSG	Message for when the node in setValue() is not a Scene
protected static final String	SCENE_PROTO_MSG	Message for when the proto is not a Scene
protected static final int	UPDATE_ALWAYS	Internal ID for updating every frame
protected static final int	UPDATE_NEXT	Internal ID for updating this next frame
protected static final int	UPDATE_NONE	Internal ID for no updates
protected int	updateFlag	The current update type as a constant
protected static final Map<String,Integer>	updateMap	Mapping of the justify field string to the internal int type
protected VRMLBackgroundNodeType	vfBackground	exposedField SFNode background NULL
protected int[]	vfDimensions	field MFInt32 dimensions
protected VRMLFogNodeType	vfFog	exposedField SFNode fog NULL
protected VRMLGroupingNodeType	vfScene	exposedField SFNode scene NULL
protected String	vfUpdate	exposedField SFBool update FALSE
protected VRMLViewpointNodeType	vfViewpoint	exposedField SFNode viewpoint NULL
protected static final String	VIEWPOINT_NODE_MSG	Message for when the node in setValue() is not a Viewpoint
protected static final String	VIEWPOINT_PROTO_MSG	Message for when the proto is not a Viewpoint

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

FIELD_DESCRIPTION, FIELD_REPEATS, FIELD_REPEATT, FIELD_TEXTURE_PROPERTIES, implImage, LAST_TEXTURENODETYPE_INDEX, pTextureProperties, TEXPROPS_VERSION_MSG, TEXTURE_PROPS_NODE_MSG, TEXTURE_PROPS_PROTO_MSG, vfDescription, vfRepeatS, vfRepeatT, vfTextureProperties

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

Constructor	Description
BaseRenderedTexture()	Constructor creates a default movietexture node.
BaseRenderedTexture(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.
int	getPrimaryType()	Get the primary type of this node.
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	setBackground(VRMLNodeType bg)	Set new value to be used for the background field.
protected void	setFog(VRMLNodeType fog)	Set new value to be used for the fog field.
protected void	setScene(VRMLNodeType scn)	Set new value to be used for the scene field.
protected void	setUpdate(String state)	The update state has changed.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, int[] value, int numValid)	Set the value of the field at the given index as a float.
void	setValue(int index, String value)	Set the value of the field at the given index as a float.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
protected void	setViewpoint(VRMLNodeType vp)	Set new value to be used for the viewpoint field.

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

copy, getDescription, getImage, getRepeatS, getRepeatT, getTextureProperties, setTextureProperties, setValue

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, 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, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

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

getDescription, getImage, getRepeatS, getRepeatT, getTextureProperties, setTextureProperties

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

addTextureListener, getCacheString, removeTextureListener

Field Details

FIELD_UPDATE

protected static final int FIELD_UPDATE

Index of update field

See Also:

• Constant Field Values

FIELD_DIMENSIONS

protected static final int FIELD_DIMENSIONS

Index of dimensions field

See Also:

• Constant Field Values

FIELD_BACKGROUND

protected static final int FIELD_BACKGROUND

Index of background field

See Also:

• Constant Field Values

FIELD_FOG

protected static final int FIELD_FOG

Index of fog field

See Also:

• Constant Field Values

FIELD_VIEWPOINT

protected static final int FIELD_VIEWPOINT

Index of viewpoint field

See Also:

• Constant Field Values

FIELD_SCENE

protected static final int FIELD_SCENE

Index of scene field

See Also:

• Constant Field Values

LAST_RENDERED_INDEX

protected static final int LAST_RENDERED_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields implemented

See Also:

• Constant Field Values

BACKGROUND_PROTO_MSG

protected static final String BACKGROUND_PROTO_MSG

Message for when the proto is not a Background

See Also:

• Constant Field Values

BACKGROUND_NODE_MSG

protected static final String BACKGROUND_NODE_MSG

Message for when the node in setValue() is not a Background

See Also:

• Constant Field Values

FOG_PROTO_MSG

protected static final String FOG_PROTO_MSG

Message for when the proto is not a Fog

See Also:

• Constant Field Values

FOG_NODE_MSG

protected static final String FOG_NODE_MSG

Message for when the node in setValue() is not a Fog

See Also:

• Constant Field Values

VIEWPOINT_PROTO_MSG

protected static final String VIEWPOINT_PROTO_MSG

Message for when the proto is not a Viewpoint

See Also:

• Constant Field Values

VIEWPOINT_NODE_MSG

protected static final String VIEWPOINT_NODE_MSG

Message for when the node in setValue() is not a Viewpoint

See Also:

• Constant Field Values

SCENE_PROTO_MSG

protected static final String SCENE_PROTO_MSG

Message for when the proto is not a Scene

See Also:

• Constant Field Values

SCENE_NODE_MSG

protected static final String SCENE_NODE_MSG

Message for when the node in setValue() is not a Scene

See Also:

• Constant Field Values

UPDATE_NONE

protected static final int UPDATE_NONE

Internal ID for no updates

See Also:

• Constant Field Values

UPDATE_NEXT

protected static final int UPDATE_NEXT

Internal ID for updating this next frame

See Also:

• Constant Field Values

UPDATE_ALWAYS

protected static final int UPDATE_ALWAYS

Internal ID for updating every frame

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

updateMap

protected static final Map<String,Integer> updateMap

Mapping of the justify field string to the internal int type

vfUpdate

protected String vfUpdate

exposedField SFBool update FALSE

updateFlag

protected int updateFlag

The current update type as a constant

vfDimensions

protected int[] vfDimensions

field MFInt32 dimensions

vfBackground

protected VRMLBackgroundNodeType vfBackground

exposedField SFNode background NULL

pBackground

protected VRMLProtoInstance pBackground

The proto version of the background

vfViewpoint

protected VRMLViewpointNodeType vfViewpoint

exposedField SFNode viewpoint NULL

pViewpoint

protected VRMLProtoInstance pViewpoint

The proto version of the viewpoint

vfFog

protected VRMLFogNodeType vfFog

exposedField SFNode fog NULL

pFog

protected VRMLProtoInstance pFog

The proto version of the fog

vfScene

protected VRMLGroupingNodeType vfScene

exposedField SFNode scene NULL

pScene

protected VRMLProtoInstance pScene

The proto version of the scene

Constructor Details

BaseRenderedTexture

public BaseRenderedTexture()

Constructor creates a default movietexture node.

BaseRenderedTexture

public BaseRenderedTexture(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

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

Overrides:

getTextureType in class BaseTexture2DNode

Returns:

the texture type of this texture

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

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

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 BaseTexture2DNode

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.

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 BaseTexture2DNode

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 BaseTexture2DNode

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

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

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseTexture2DNode

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,
 int[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a float. This would be used to set MFInt32/SFImage/MFImage 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 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

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

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseTexture2DNode

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.

setUpdate

protected void setUpdate(String state)

The update state has changed. Override if need be for any renderer-specific needs.

Parameters:

state - The new state for updates

setBackground

protected void setBackground(VRMLNodeType bg)
                      throws InvalidFieldValueException

Set new value to be used for the background field.

Parameters:

bg - The new background. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

setFog

protected void setFog(VRMLNodeType fog)
               throws InvalidFieldValueException

Set new value to be used for the fog field.

Parameters:

fog - The new fog. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

setViewpoint

protected void setViewpoint(VRMLNodeType vp)
                     throws InvalidFieldValueException

Set new value to be used for the viewpoint field.

Parameters:

vp - The new viewpoint. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

setScene

protected void setScene(VRMLNodeType scn)
                 throws InvalidFieldValueException

Set new value to be used for the scene field.

Parameters:

scn - The new scene. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.