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

Class BaseMultiTexture

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLComposedTextureNodeType, VRMLMultiTextureNodeType, VRMLNodeType, VRMLTextureListener, VRMLTextureNodeType

Direct Known Subclasses:

NRMultiTexture, OGLMultiTexture

public class BaseMultiTexture
extends BaseTextureNode
implements VRMLMultiTextureNodeType, VRMLTextureListener

Base implementation of a MultiTexture node.

Version:

$Revision: 1.14 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ALPHA	Alpha Index
protected static final int	FIELD_COLOR	Color Index
protected static final int	FIELD_FUNCTION	function Index
protected static final int	FIELD_MODE	Mode Index
protected static final int	FIELD_SOURCE	source Index
protected static final int	FIELD_TEXTURE	Texture Index
protected static final VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected static final Map<String,Integer>	functionMap	A map of function strings to texture constants
protected static final int	LAST_MULTITEXTURE_INDEX	Index of the last field of this node
protected boolean[]	loaded	Whether a texture has loaded.
protected static final Map<String,Integer>	modeMap	A map of mode strings to texture constants
protected static final int	NUM_FIELDS	Number of fields constant
protected static final Map<String,Integer>	sourceMap	A map of source strings to texture constants
protected float	vfAlpha	exposedField alpha 1
protected float[]	vfColor	exposedField color 1 1 1
protected String[]	vfFunction	exposedField MFString function []
protected String[]	vfMode	exposedField MFString mode []
protected String[]	vfSource	exposedField MFString source []
protected List<VRMLTextureNodeType>	vfTexture	exposedField MFNode texture []

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	BaseMultiTexture()	Empty constructor.
protected	BaseMultiTexture(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
protected void	addTextureNode(VRMLNodeType node)	Add a single texture node to the list of textures.
String	getCacheString(int stage)	Get a string for caching this object.
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.
protected int	getFunctionConst(String mode)	Convert a function to a TextureConstants const.
protected int	getModeConst(String mode)	Convert a mode to a TextureConstants const.
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.
protected int	getSourceConst(String mode)	Convert a source to a TextureConstants const.
void	getTextureParams(int start, int[] modes, int[] function, int[] source)	Get the texture params for each stage of this texture.
void	getTextures(int start, VRMLTextureNodeType[] texs)	Get the texture info which make up this multitexture.
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.
void	setupFinished()	Notification that the construction phase of this node has finished.
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 a float.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
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.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.
void	textureImageChanged(int len, VRMLNodeType[] node, NIOBufferImage[] image, String[] url)	Invoked when all of the underlying images have changed.
void	textureImageChanged(int idx, VRMLNodeType node, NIOBufferImage image, String url)	Invoked when an underlying image has changed.
void	textureParamsChanged(int len, int[] mode, int[] source, int[] function, float alpha, float[] color)	Invoked when the texture parameters have changed.
void	textureParamsChanged(int idx, int mode, int source, int function, float alpha, float[] color)	Invoked when the texture parameters have changed.

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

addTextureListener, fireTextureImageChanged, fireTextureParamsChanged, 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, 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, updateRefCount

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

addTextureListener, removeTextureListener

Field Details

FIELD_MODE

protected static final int FIELD_MODE

Mode Index

See Also:

• Constant Field Values

FIELD_TEXTURE

protected static final int FIELD_TEXTURE

Texture Index

See Also:

• Constant Field Values

FIELD_COLOR

protected static final int FIELD_COLOR

Color Index

See Also:

• Constant Field Values

FIELD_ALPHA

protected static final int FIELD_ALPHA

Alpha Index

See Also:

• Constant Field Values

FIELD_FUNCTION

protected static final int FIELD_FUNCTION

function Index

See Also:

• Constant Field Values

FIELD_SOURCE

protected static final int FIELD_SOURCE

source Index

See Also:

• Constant Field Values

LAST_MULTITEXTURE_INDEX

protected static final int LAST_MULTITEXTURE_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 final VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfMode

protected String[] vfMode

exposedField MFString mode []

vfFunction

protected String[] vfFunction

exposedField MFString function []

vfSource

protected String[] vfSource

exposedField MFString source []

vfTexture

protected List<VRMLTextureNodeType> vfTexture

exposedField MFNode texture []

vfColor

protected float[] vfColor

exposedField color 1 1 1

vfAlpha

protected float vfAlpha

exposedField alpha 1

modeMap

protected static final Map<String,Integer> modeMap

A map of mode strings to texture constants

functionMap

protected static final Map<String,Integer> functionMap

A map of function strings to texture constants

sourceMap

protected static final Map<String,Integer> sourceMap

A map of source strings to texture constants

loaded

protected boolean[] loaded

Whether a texture has loaded.

Constructor Details

BaseMultiTexture

protected BaseMultiTexture()

Empty constructor.

BaseMultiTexture

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

getCacheString

public String getCacheString(int stage)

Get a string for caching this object. Null means do not cache this texture.

Specified by:

getCacheString in interface VRMLTextureNodeType

Overrides:

getCacheString in class BaseTextureNode

Parameters:

stage - The stage number, 0 for all single stage textures.

Returns:

A string to use in lookups. Typically the url loaded.

getNumberTextures

public int getNumberTextures()

Description copied from interface: VRMLComposedTextureNodeType

Get the number of textures in this ComposedTexture node.

Specified by:

getNumberTextures in interface VRMLComposedTextureNodeType

Returns:

The number of active textures.

getTextures

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

Get the texture info which make up this multitexture.

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. // * @param modes The TextureConstant modes.

getTextureParams

public void getTextureParams(int start,
 int[] modes,
 int[] function,
 int[] source)

Get the texture params for each stage of this texture.

Specified by:

getTextureParams in interface VRMLMultiTextureNodeType

Parameters:

start - Where in the array to start filling in textures. // * @param texs The preallocated array to return texs in. Error if too small.

modes - The TextureConstant modes.

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

source -

textureImageChanged

public void textureImageChanged(int idx,
 VRMLNodeType node,
 NIOBufferImage image,
 String url)

Invoked when an underlying image has changed.

Specified by:

textureImageChanged in interface VRMLTextureListener

Parameters:

idx - The image idx which changed.

node - The texture which changed.

image - The image for this texture.

url - The url used to load this image.

textureImageChanged

public void textureImageChanged(int len,
 VRMLNodeType[] node,
 NIOBufferImage[] image,
 String[] url)

Invoked when all of the underlying images have changed.

Specified by:

textureImageChanged in interface VRMLTextureListener

Parameters:

len - The number of valid entries in the image array.

node - The textures which changed.

image - The images for this texture.

url - The urls used to load these images.

textureParamsChanged

public void textureParamsChanged(int idx,
 int mode,
 int source,
 int function,
 float alpha,
 float[] color)

Invoked when the texture parameters have changed. The most efficient route is to set the parameters before the image.

Specified by:

textureParamsChanged in interface VRMLTextureListener

Parameters:

idx - The texture index which changed.

mode - The mode for the stage.

source - The source for the stage.

function - The function to apply to the stage values.

alpha - The alpha value to use for modes requiring it.

color - The color to use for modes requiring it. 3 Component color.

textureParamsChanged

public void textureParamsChanged(int len,
 int[] mode,
 int[] source,
 int[] function,
 float alpha,
 float[] color)

Invoked when the texture parameters have changed. The most efficient route is to set the parameters before the image.

Specified by:

textureParamsChanged in interface VRMLTextureListener

Parameters:

len - The number of valid entries in the arrays. // * @param idx The texture index which changed.

mode - The mode for the stage.

source - The source for the stage.

function - The function to apply to the stage values.

alpha - The alpha value to use for modes requiring it.

color - The color to use for modes requiring it. An array of 3 component colors.

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 AbstractNode

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,
 float value)
              throws InvalidFieldException,
InvalidFieldFormatException,
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 raw value string to be parsed

Throws:

InvalidFieldException - The index is not a valid field

InvalidFieldFormatException - The string was not in a correct form for this field.

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

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldFormatException,
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 raw value string to be parsed

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

Throws:

InvalidFieldException - The index is not a valid field

InvalidFieldFormatException - The string was not in a correct form for this field.

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

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 index is not a valid field

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

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 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 know

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

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

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              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

children - 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 know

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

addTextureNode

protected void addTextureNode(VRMLNodeType node)
                       throws InvalidFieldValueException

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

Parameters:

node - The node to add

Throws:

InvalidFieldValueException - This is a bindable node shared

getModeConst

protected int getModeConst(String mode)

Convert a mode to a TextureConstants const. Returns -1 for unknown modes.

Parameters:

mode - The mode string

Returns:

The const

getFunctionConst

protected int getFunctionConst(String mode)

Convert a function to a TextureConstants const. Returns -1 for unknown functions.

Parameters:

mode - The mode string

Returns:

The const

getSourceConst

protected int getSourceConst(String mode)

Convert a source to a TextureConstants const. Returns -1 for unknown sources.

Parameters:

mode - The mode string

Returns:

The const