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

Class BaseTextureProperties

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLTextureProperties2DNodeType

Direct Known Subclasses:

NRTextureProperties, OGLTextureProperties

public abstract class BaseTextureProperties
extends AbstractNode
implements VRMLTextureProperties2DNodeType

Common base implementation of a TextureProperties node.

Version:

$Revision: 1.5 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ANISOTROPIC_DEGREE	Index of the anistropicMode field
protected static final int	FIELD_ANISOTROPIC_MODE	Index of the anistropicMode field
protected static final int	FIELD_BORDER_COLOR	Index of the borderColor field
protected static final int	FIELD_BORDER_WIDTH	Index of the borderWidth field
protected static final int	FIELD_BOUNDARY_MODE_R	Index of the boundaryModeT field
protected static final int	FIELD_BOUNDARY_MODE_S	Index of the boundaryModeS field
protected static final int	FIELD_BOUNDARY_MODE_T	Index of the boundaryModeT field
protected static final int	FIELD_GENERATE_MIPMAPS	Index of the generateMipMaps field
protected static final int	FIELD_MAGNIFICATION_FILTER	Index of the magnificationFilter field
protected static final int	FIELD_MINIFICATION_FILTER	Index of the minificationFilter field
protected static final int	FIELD_TEXTURE_COMPRESSION	Index of the anistropicMode field
protected static final int	FIELD_TEXTURE_PRIORITY	Index of the anistropicMode field
protected static final int	LAST_TEXTUREPROPS_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected float	vfAnisotropicDegree	SFFloat anistropicFilterDegree
protected String	vfAnisotropicMode	SFString anistropicMode
protected float[]	vfBorderColor	SFColorRGBA borderColor
protected int	vfBorderWidth	SFInt32 boundary width
protected String	vfBoundaryModeR	SFString boundaryModeR
protected String	vfBoundaryModeS	SFString boundaryModeS
protected String	vfBoundaryModeT	SFString boundaryModeT
protected boolean	vfGenerateMipMaps	SFBool generateMipMaps
protected String	vfMagnificationFilter	SFString magnificationFilter
protected String	vfMinificationFilter	SFString magnificationFilter
protected String	vfTextureCompression	SFString textureCompression
protected float	vfTexturePriority	SFFloat textureCompression

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	BaseTextureProperties()	Construct a default node with all of the values set to the given types.
protected	BaseTextureProperties(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	getAnisotropicDegree()	Get the AnistropicFilter Degree.
int	getAnisotropicMode()	Get the Anisotropic Mode.
void	getBorderColor(float[] color)	Get the boundary color.
int	getBorderWidth()	Get the boundary width.
int	getBoundaryModeS()	Get the boundary mode for S.
int	getBoundaryModeT()	Get the boundary mode for T.
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.
boolean	getGenerateMipMaps()	Get the generateMipsMaps field.
int	getMagnificationFilter()	Get the magnification filter.
int	getMinificationFilter()	Get the minification filter.
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.
String	getTextureCompression()	Get the texture compression setting.
float	getTexturePriority()	Get the texture priority.
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, boolean value)	Set the value of the field at the given index as an boolean.
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.
void	setValue(int index, int value)	Set the value of the field at the given index as an integer.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.

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

Field Details

FIELD_BORDER_COLOR

protected static final int FIELD_BORDER_COLOR

Index of the borderColor field

See Also:

• Constant Field Values

FIELD_BORDER_WIDTH

protected static final int FIELD_BORDER_WIDTH

Index of the borderWidth field

See Also:

• Constant Field Values

FIELD_BOUNDARY_MODE_S

protected static final int FIELD_BOUNDARY_MODE_S

Index of the boundaryModeS field

See Also:

• Constant Field Values

FIELD_BOUNDARY_MODE_T

protected static final int FIELD_BOUNDARY_MODE_T

Index of the boundaryModeT field

See Also:

• Constant Field Values

FIELD_MAGNIFICATION_FILTER

protected static final int FIELD_MAGNIFICATION_FILTER

Index of the magnificationFilter field

See Also:

• Constant Field Values

FIELD_MINIFICATION_FILTER

protected static final int FIELD_MINIFICATION_FILTER

Index of the minificationFilter field

See Also:

• Constant Field Values

FIELD_GENERATE_MIPMAPS

protected static final int FIELD_GENERATE_MIPMAPS

Index of the generateMipMaps field

See Also:

• Constant Field Values

FIELD_ANISOTROPIC_MODE

protected static final int FIELD_ANISOTROPIC_MODE

Index of the anistropicMode field

See Also:

• Constant Field Values

FIELD_ANISOTROPIC_DEGREE

protected static final int FIELD_ANISOTROPIC_DEGREE

Index of the anistropicMode field

See Also:

• Constant Field Values

FIELD_TEXTURE_COMPRESSION

protected static final int FIELD_TEXTURE_COMPRESSION

Index of the anistropicMode field

See Also:

• Constant Field Values

FIELD_TEXTURE_PRIORITY

protected static final int FIELD_TEXTURE_PRIORITY

Index of the anistropicMode field

See Also:

• Constant Field Values

FIELD_BOUNDARY_MODE_R

protected static final int FIELD_BOUNDARY_MODE_R

Index of the boundaryModeT field

See Also:

• Constant Field Values

LAST_TEXTUREPROPS_INDEX

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

vfBorderColor

protected float[] vfBorderColor

SFColorRGBA borderColor

vfBorderWidth

protected int vfBorderWidth

SFInt32 boundary width

vfBoundaryModeS

protected String vfBoundaryModeS

SFString boundaryModeS

vfBoundaryModeT

protected String vfBoundaryModeT

SFString boundaryModeT

vfBoundaryModeR

protected String vfBoundaryModeR

SFString boundaryModeR

vfMagnificationFilter

protected String vfMagnificationFilter

SFString magnificationFilter

vfMinificationFilter

protected String vfMinificationFilter

SFString magnificationFilter

vfGenerateMipMaps

protected boolean vfGenerateMipMaps

SFBool generateMipMaps

vfAnisotropicMode

protected String vfAnisotropicMode

SFString anistropicMode

vfAnisotropicDegree

protected float vfAnisotropicDegree

SFFloat anistropicFilterDegree

vfTextureCompression

protected String vfTextureCompression

SFString textureCompression

vfTexturePriority

protected float vfTexturePriority

SFFloat textureCompression

Constructor Details

BaseTextureProperties

protected BaseTextureProperties()

Construct a default node with all of the values set to the given types.

BaseTextureProperties

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

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

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.

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

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

Set the value of the field at the given index as an boolean. This would be used to set SFBool field types headlight and bind.

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 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,
 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 speed and visibilityLimit.

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

Set the value of the field at the given index as an integer. This would be used to set SFInt32 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 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,
 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 field type avatarSize.

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

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 the SFString field type "type".

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

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

getBorderColor

public void getBorderColor(float[] color)

Get the boundary color. This is a 4 component color.

Specified by:

getBorderColor in interface VRMLTextureProperties2DNodeType

Parameters:

color - A preallocated 4 component color array;

getBorderWidth

public int getBorderWidth()

Get the boundary width.

Specified by:

getBorderWidth in interface VRMLTextureProperties2DNodeType

Returns:

The boundary width

getBoundaryModeS

public int getBoundaryModeS()

Get the boundary mode for S.

Specified by:

getBoundaryModeS in interface VRMLTextureProperties2DNodeType

Returns:

The boundary mode. Defined in TextureConstants.

getBoundaryModeT

public int getBoundaryModeT()

Get the boundary mode for T.

Specified by:

getBoundaryModeT in interface VRMLTextureProperties2DNodeType

Returns:

The boundary mode. Defined in TextureConstants.

getMagnificationFilter

public int getMagnificationFilter()

Get the magnification filter.

Specified by:

getMagnificationFilter in interface VRMLTextureProperties2DNodeType

Returns:

The mag filter. Defined in TextureConstants.

getMinificationFilter

public int getMinificationFilter()

Get the minification filter.

Specified by:

getMinificationFilter in interface VRMLTextureProperties2DNodeType

Returns:

The min filter. Defined in TextureConstants.

getGenerateMipMaps

public boolean getGenerateMipMaps()

Get the generateMipsMaps field.

Specified by:

getGenerateMipMaps in interface VRMLTextureProperties2DNodeType

Returns:

Should mips be generated for this object.

getAnisotropicMode

public int getAnisotropicMode()

Get the Anisotropic Mode.

Specified by:

getAnisotropicMode in interface VRMLTextureProperties2DNodeType

Returns:

The anisotropic mode. Defined in TextureConstants.

getAnisotropicDegree

public float getAnisotropicDegree()

Get the AnistropicFilter Degree.

Specified by:

getAnisotropicDegree in interface VRMLTextureProperties2DNodeType

Returns:

The anisotropic degree.

getTextureCompression

public String getTextureCompression()

Get the texture compression setting.

Specified by:

getTextureCompression in interface VRMLTextureProperties2DNodeType

Returns:

What texture compression mode to use

getTexturePriority

public float getTexturePriority()

Get the texture priority.

Specified by:

getTexturePriority in interface VRMLTextureProperties2DNodeType

Returns:

The texture priority for memory management.