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

Class BaseTextureCoordinateGenerator

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGeometricPropertyNode

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometricPropertyNodeType, VRMLNodeType, VRMLTextureCoordinateNodeType

Direct Known Subclasses:

NRTextureCoordinateGenerator, OGLTextureCoordinateGenerator

public abstract class BaseTextureCoordinateGenerator
extends BaseGeometricPropertyNode
implements VRMLTextureCoordinateNodeType

Common base implementation of a texture coordinate generator node.

Version:

$Revision: 1.11 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_MODE	Field index for mode
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_TEXTURECOORDINATE_INDEX	The last field index used by this class
protected String	vfMode	exposedField SFString mode "REPLACE"

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	BaseTextureCoordinateGenerator()	Empty constructor
protected	BaseTextureCoordinateGenerator(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	getNumSets()	Get the number of texture coordinate sets contained by this node
int	getNumTextureComponents()	Get the number of components defined for this texture type.
void	getPoint(int setNum, float[] point)	Accessor method to get current value of field point.
int	getPrimaryType()	Get the primary type of this node.
int	getSize(int setNum)	Get the size of the specified set
String	getTexCoordGenMode(int setNum)	Get the texture coordinate generation mode.
int	isShared(int index)	Determine if this index is shared via DEF/USE inside this set
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setPoint(int setNum, float[] newPoint, int numValid)	Accessor method to set a new value for field attribute point.
void	setValue(int index, String value)	Set the value of the field as a string.

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

addComponentListener, fireComponentChanged, removeComponentListener

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.nodes.VRMLGeometricPropertyNodeType

addComponentListener, removeComponentListener

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

Field Details

FIELD_MODE

protected static final int FIELD_MODE

Field index for mode

See Also:

• Constant Field Values

LAST_TEXTURECOORDINATE_INDEX

protected static final int LAST_TEXTURECOORDINATE_INDEX

The last field index used by 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

vfMode

protected String vfMode

exposedField SFString mode "REPLACE"

Constructor Details

BaseTextureCoordinateGenerator

protected BaseTextureCoordinateGenerator()

Empty constructor

BaseTextureCoordinateGenerator

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

getNumTextureComponents

public int getNumTextureComponents()

Get the number of components defined for this texture type. SHould be one of 2, 3 or 4 for 2D, 3D or time-driven textures.

Specified by:

getNumTextureComponents in interface VRMLTextureCoordinateNodeType

Returns:

one of 2, 3 or 4

getNumSets

public int getNumSets()

Get the number of texture coordinate sets contained by this node

Specified by:

getNumSets in interface VRMLTextureCoordinateNodeType

Returns:

the number of texture coordinate sets

getSize

public int getSize(int setNum)

Get the size of the specified set

Specified by:

getSize in interface VRMLTextureCoordinateNodeType

Parameters:

setNum - The set to size

Returns:

setPoint

public void setPoint(int setNum,
 float[] newPoint,
 int numValid)

Accessor method to set a new value for field attribute point. Attempts to set nodes > numSets will throw an exception.

Specified by:

setPoint in interface VRMLTextureCoordinateNodeType

Parameters:

setNum - The set which this point belongs.

newPoint - New value for the point field

numValid - number of valid items to use from the size array

Throws:

ArrayIndexOutOfBoundsException

getPoint

public void getPoint(int setNum,
 float[] point)

Accessor method to get current value of field point. Sets outside the numSize will throw an exception.

Specified by:

getPoint in interface VRMLTextureCoordinateNodeType

Parameters:

setNum - The set which this point belongs.

point - The current value of point

Throws:

ArrayIndexOutOfBoundsException

isShared

public int isShared(int index)

Determine if this index is shared via DEF/USE inside this set

Specified by:

isShared in interface VRMLTextureCoordinateNodeType

Parameters:

index - The index to check

Returns:

The index if not shared or the original index DEFed

getTexCoordGenMode

public String getTexCoordGenMode(int setNum)

Get the texture coordinate generation mode. NULL is returned if the texture coordinates are not generated.

Specified by:

getTexCoordGenMode in interface VRMLTextureCoordinateNodeType

Parameters:

setNum - The set which this tex gen mode refers

Returns:

The mode or NULL

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

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

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

Set the value of the field as a string.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The value string to be used

Throws:

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