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

Class BaseTransform

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

org.web3d.vrml.renderer.common.nodes.group.BaseTransform

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLGroupingNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRTransform, OGLTransform, TransformMatrix

public class BaseTransform
extends BaseGroupingNode

Common implementation of a transform node functionality. This base class does not automatically update the underlying transform with each set() call. These calls only update the local field values, but not the transform that would be used in the rendering code. To make sure this is updated, call the updateMatrix() method and then use the updated matrix in your rendering code.

Version:

$Revision: 1.18 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CENTER	Field Index
protected static final int	FIELD_ROTATION
protected static final int	FIELD_SCALE
protected static final int	FIELD_SCALE_ORIENTATION
protected static final int	FIELD_TRANSLATION
protected static final int	LAST_TRANSFORM_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected javax.vecmath.Matrix4f	tmatrix
protected float[]	vfCenter	SFVec3f center
protected float[]	vfRotation	SFRotation rotation
protected float[]	vfScale	SFVec3f scale
protected float[]	vfScaleOrientation	SFRotation scaleOrientation
protected float[]	vfTranslation	SFVec3f translation

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

childCount, FIELD_ADDCHILDREN, FIELD_BBOX_CENTER, FIELD_BBOX_DISPLAY, FIELD_BBOX_SIZE, FIELD_CHILDREN, FIELD_REMOVECHILDREN, FIELD_VISIBLE, hasBindables, LAST_GROUP_INDEX, shareCount, USE_BIND_MSG, vfBboxCenter, vfBboxDisplay, vfBboxSize, vfChildren, vfVisible

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

Method Summary

Modifier and Type	Method	Description
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
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.
float[]	getRotation()	Get the current rotation component of the transform.
float[]	getScale()	Get the current scale component of the transform.
float[]	getScaleOrientation()	Get the current scale orientation 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	setScaleOrientation(float[] so)	Set the scale orientation component of the of transform.
void	setTranslation(float[] tx)	Set the translation component of the of transform.
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	updateMatrix()	Calculate transforms needed to handle VRML semantics and place the results in the matrix variable of this class.

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

addChild, addChildNode, clearChildren, containsBindableNodes, copy, getBboxCenter, getBboxDisplay, getBboxSize, getChildren, getChildrenSize, getPrimaryType, getVisible, isShared, removeChildNode, setBboxCenter, setBboxDisplay, setBboxSize, setChildren, setChildren, setDEF, setShared, setupFinished, setValue, setValue, setValue, setVisible, updateRefCount

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

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, 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.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, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Field Details

FIELD_CENTER

protected static final int FIELD_CENTER

Field Index

See Also:

• Constant Field Values

FIELD_ROTATION

protected static final int FIELD_ROTATION

See Also:

• Constant Field Values

FIELD_SCALE

protected static final int FIELD_SCALE

See Also:

• Constant Field Values

FIELD_SCALE_ORIENTATION

protected static final int FIELD_SCALE_ORIENTATION

See Also:

• Constant Field Values

FIELD_TRANSLATION

protected static final int FIELD_TRANSLATION

See Also:

• Constant Field Values

LAST_TRANSFORM_INDEX

protected static final int LAST_TRANSFORM_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 constant

See Also:

• Constant Field Values

vfCenter

protected float[] vfCenter

SFVec3f center

vfRotation

protected float[] vfRotation

SFRotation rotation

vfScale

protected float[] vfScale

SFVec3f scale

vfScaleOrientation

protected float[] vfScaleOrientation

SFRotation scaleOrientation

vfTranslation

protected float[] vfTranslation

SFVec3f translation

tmatrix

protected javax.vecmath.Matrix4f tmatrix

Constructor Details

BaseTransform

public BaseTransform()

Construct a default instance of this node. The defaults are set by the VRML specification.

BaseTransform

public BaseTransform(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a group node, an exception will be thrown. It does not copy the children nodes, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

allEventsComplete

public void allEventsComplete()

Notification that the rendering of the event model is complete and that rendering is about to begin. Used to update the transformation matrix only once per frame. If the derived class needs to propagate the changes then it should override the updateMatrix() method or this and make sure this method is called first.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

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

setScaleOrientation

public void setScaleOrientation(float[] so)
                         throws InvalidFieldValueException

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

Parameters:

so - The new scale orientation component

Throws:

InvalidFieldValueException - The scale orientation was null

getScaleOrientation

public float[] getScaleOrientation()

Get the current scale orientation component of the transform.

Returns:

The current scale orientation

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

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.

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.

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.

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.

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 BaseGroupingNode

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 BaseGroupingNode

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,
 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 MFFloat, SFVec2f, SFVec3f and SFRotation field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseGroupingNode

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 not in range or not appropriate for this field

updateMatrix

protected void updateMatrix()

Calculate transforms needed to handle VRML semantics and place the results in the matrix variable of this class. formula: T x C x R x SR x S x -SR x -C