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

Class BaseTextureTransform

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLTextureTransformNodeType

Direct Known Subclasses:

NRTextureTransform, OGLTextureTransform, TextureTransformMatrix

public abstract class BaseTextureTransform
extends AbstractNode
implements VRMLTextureTransformNodeType

norender implementation of a texture transform.

Version:

$Revision: 1.12 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.vecmath.AxisAngle4f	al
protected javax.vecmath.Matrix4f	C
protected static final int	FIELD_CENTER	Field index for center
protected static final int	FIELD_ROTATION	Field index for rotation
protected static final int	FIELD_SCALE	Field index for scale
protected static final int	FIELD_TRANSLATION	Field index for translation
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_TEXTURETRANSFORM_INDEX	ID of the last field index in this class
protected javax.vecmath.Matrix4f	matrix	Combined Matrix
protected javax.vecmath.Matrix4f	R
protected javax.vecmath.Matrix4f	S
protected javax.vecmath.Matrix4f	T
protected javax.vecmath.Vector3f	v1	Class Vars for speed
protected javax.vecmath.Vector3f	v2
protected javax.vecmath.Vector3f	v3
protected float[]	vfCenter	exposedField SFVec2f center 0 0
protected float	vfRotation	exposedField SFFloat rotation 0
protected float[]	vfScale	exposedField SFVec2f scale 1 1
protected float[]	vfTranslation	exposedField SFVec2f translation 0 0

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

Method Summary

Modifier and Type	Method	Description
float[]	getCenter()	Get the current center component of the transform.
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.
float	getRotation()	Get the current rotation component of the transform.
float[]	getScale()	Get the current scale component of the transform.
float[]	getTranslation()	Get the current translation component of the transform.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setCenter(float[] center)	Set the center component of the of transform.
void	setRotation(float rot)	Set the rotation component of the of transform.
void	setScale(float[] scale)	Set the scale component of the of transform.
void	setTranslation(float[] tx)	Set the translation component of the of transform.
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.
protected void	updateTransform()

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

Field Details

FIELD_CENTER

protected static final int FIELD_CENTER

Field index for center

See Also:

• Constant Field Values

FIELD_ROTATION

protected static final int FIELD_ROTATION

Field index for rotation

See Also:

• Constant Field Values

FIELD_SCALE

protected static final int FIELD_SCALE

Field index for scale

See Also:

• Constant Field Values

FIELD_TRANSLATION

protected static final int FIELD_TRANSLATION

Field index for translation

See Also:

• Constant Field Values

LAST_TEXTURETRANSFORM_INDEX

protected static final int LAST_TEXTURETRANSFORM_INDEX

ID of the last field index in this class

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

vfCenter

protected float[] vfCenter

exposedField SFVec2f center 0 0

vfRotation

protected float vfRotation

exposedField SFFloat rotation 0

vfScale

protected float[] vfScale

exposedField SFVec2f scale 1 1

vfTranslation

protected float[] vfTranslation

exposedField SFVec2f translation 0 0

matrix

protected javax.vecmath.Matrix4f matrix

Combined Matrix

v1

protected javax.vecmath.Vector3f v1

Class Vars for speed

v2

protected javax.vecmath.Vector3f v2

v3

protected javax.vecmath.Vector3f v3

T

protected javax.vecmath.Matrix4f T

C

protected javax.vecmath.Matrix4f C

R

protected javax.vecmath.Matrix4f R

S

protected javax.vecmath.Matrix4f S

al

protected javax.vecmath.AxisAngle4f al

Constructor Details

BaseTextureTransform

protected BaseTextureTransform()

Construct a new default instance of this class.

BaseTextureTransform

protected BaseTextureTransform(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 - The node is not the same type

Method Details

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,
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 index does not match a known field

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

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 index does not match a known field

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

setRotation

public void setRotation(float rot)
                 throws InvalidFieldValueException

Set the rotation component of the of transform. Setting a value of null is an error

Parameters:

rot - The new rotation component

Throws:

InvalidFieldValueException - The rotation was null

getRotation

public float getRotation()

Get the current rotation component of the transform.

Returns:

The current rotation

setTranslation

public void setTranslation(float[] tx)
                    throws InvalidFieldValueException

Set the translation component of the of transform. Setting a value of null is an error

Parameters:

tx - The new translation component

Throws:

InvalidFieldValueException - The translation was null

getTranslation

public float[] getTranslation()

Get the current translation component of the transform.

Returns:

The current translation

setScale

public void setScale(float[] scale)
              throws InvalidFieldValueException

Set the scale component of the of transform. Setting a value of null is an error

Parameters:

scale - The new scale component

Throws:

InvalidFieldValueException - The scale was null

getScale

public float[] getScale()

Get the current scale component of the transform.

Returns:

The current scale

setCenter

public void setCenter(float[] center)
               throws InvalidFieldValueException

Set the center component of the of transform. Setting a value of null is an error

Parameters:

center - The new center component

Throws:

InvalidFieldValueException - The center was null

getCenter

public float[] getCenter()

Get the current center component of the transform.

Returns:

The current center

updateTransform

protected void updateTransform()