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

Class BaseAppearance

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.shape.BaseAppearance

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceNodeType, VRMLNodeType, VRMLTextureListener

Direct Known Subclasses:

NRAppearance, OGLAppearance

public abstract class BaseAppearance
extends AbstractNode
implements VRMLAppearanceNodeType, VRMLTextureListener

Common base implementation of an Appearance node.

Properties

The properties for this file are loaded once on startup so they cannot be initialized per run of loader. The following properties are used by this class:

• org.web3d.vrml.renderer.common.nodes.shape.useTextureCache Whether to cache textures for later reuse. This caches by URL which might be incorrect for some dynamic systems. It improves performance for files which don't use DEF/USE for textures.
• org.web3d.vrml.renderer.common.nodes.shape.useMipMaps Force the use of mipmaps on nodes without TextureProperties.

Version:

$Revision: 1.43 $

Author:

Justin Couch, Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ANISOTROPIC_DEGREE_PROP	Property describing the anisotropicDegree value
protected static final int	anisotropicDegree	The anisotropicDegree value
protected static final int	DEFAULT_ANISOTROPIC_DEGREE	The default anisotropicDegree value
protected static final boolean	DEFAULT_USE_MIPMAPS	The default useMipMaps value
protected static final boolean	DEFAULT_USETEXTURECACHE	The default useTextureCache value
protected static final int	FIELD_ACOUSTIC_PROPERTIES	Index of the acousticProperties field value
protected static final int	FIELD_ALPHACUTOFF	Index of the alphaCutoff field value
protected static final int	FIELD_ALPHAMODE	Index of the alphaMode field value
protected static final int	FIELD_BACKMATERIAL	Index of the backMaterial field value
protected static final int	FIELD_FILL_PROPERTIES	Index of the fillProperties field value
protected static final int	FIELD_LINE_PROPERTIES	Index of the lineProperties field value
protected static final int	FIELD_MATERIAL	Index of the Material field value
protected static final int	FIELD_POINT_PROPERTIES	Index of the pointProperties field value
protected static final int	FIELD_SHADERS	Index of the backMaterial field value
protected static final int	FIELD_TEXTURE	Index of the Texture field value
protected static final int	FIELD_TEXTURE_PROPERTIES	Index of the textureProperties field value
protected static final int	FIELD_TEXTURE_TRANSFORM	Index of the TextureTransform field value
protected static final String	FILL_PROP_NODE_MSG	Message for when the node in setValue() is not a FillProperties
protected static final String	FILL_PROP_PROTO_MSG	Message for when the proto is not a FillProperties
protected static final String	LINE_PROP_NODE_MSG	Message for when the node in setValue() is not a LineProperties
protected static final String	LINE_PROP_PROTO_MSG	Message for when the proto is not a LineProperties
protected static final String	MATERIAL_NODE_MSG	Message for when the node in setValue() is not a Material
protected static final String	MATERIAL_PROTO_MSG	Message for when the proto is not a Material
protected int	numStages
protected VRMLProtoInstance	pAcousticProperties	Proto version of the acousticProperties
protected VRMLProtoInstance	pBackMaterial	Proto version of the backMaterial
protected VRMLProtoInstance	pFillProperties	Proto version of the fillProperties
protected VRMLProtoInstance	pLineProperties	Proto version of the lineProperties
protected VRMLProtoInstance	pMaterial	Proto version of the material
protected static final String	POINT_PROP_NODE_MSG	Message for when the node in setValue() is not a PointProperties
protected static final String	POINT_PROP_PROTO_MSG	Message for when the proto is not a PointProperties
protected VRMLProtoInstance	pPointProperties	Proto version of the pointProperties
protected VRMLProtoInstance	pShaders	Proto version of the shaders
protected VRMLProtoInstance	pTexture	Proto version of the texture
protected VRMLProtoInstance	pTextureProperties	Proto version of the textureProperties
protected VRMLProtoInstance	pTextureTransform	Proto version of the texture transform
protected TextureStage[]	stages
protected static final String	TEXTURE_NODE_MSG	Message for when the node in setValue() is not a Texture
protected static final String	TEXTURE_PROP_NODE_MSG	Message for when the node in setValue() is not a TextureProperties
protected static final String	TEXTURE_PROP_PROTO_MSG	Message for when the proto is not a TextureProperties
protected static final String	TEXTURE_PROTO_MSG	Message for when the proto is not a Texture
protected static float	totalTextureSize	Total size of textures (K bytes)
protected static final String	TRANSFORM_NODE_MSG	Message for when the node in setValue() is not a TextureTransform
protected static final String	TRANSFORM_PROTO_MSG	Message for when the proto is not a TextureTransform
protected String[]	urls
protected static final String	USE_MIPMAPS_PROP	Property describing the mipmap usage
protected static boolean	useMipMaps	The value read from the system property for MIPMAPS
protected static final boolean	useTextureCache	The value read from the system property for TEXTURECACHE
protected static final String	USETEXTURECACHE_PROP	Property describing the rescaling method to use
protected VRMLNodeType	vfAcousticProperties	SFNode acousticProperties.
protected float	vfAlphaCutoff	SFFloat alphaCutoff.
protected String	vfAlphaMode	SFString alphaMode.
protected VRMLNodeType	vfBackMaterial	SFNode backMaterial.
protected VRMLAppearanceChildNodeType	vfFillProperties	SFNode fillProperties
protected VRMLAppearanceChildNodeType	vfLineProperties	SFNode lineProperties.
protected VRMLMaterialNodeType	vfMaterial	SFNode material
protected VRMLPointPropertiesNodeType	vfPointProperties	SFNode pointProperties.
protected VRMLNodeType	vfShaders	SFNode shaders.
protected VRMLTextureNodeType	vfTexture	SFNode texture.
protected VRMLTextureProperties2DNodeType	vfTextureProperties	SFNode textureProperties.
protected VRMLTextureTransformNodeType	vfTextureTransform	SFNode textureTransform

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	BaseAppearance()	Default constructor that initialises all fields to the spec defaults.
protected	BaseAppearance(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	addMaterialColorListener(MaterialColorListener l)	Add a listener instance for the material color change notifications.
VRMLNodeType	getAcousticProperties()	Get the current acousticProperties used by the appearance.
float	getAlphaCutoff()	Get the current alphaCutoff used by the appearance.
String	getAlphaMode()	Get the current alphaMode used by the appearance.
VRMLNodeType	getBackMaterial()	Get the current backMaterial used by the appearance.
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.
VRMLNodeType	getFillProperties()	Get the current texture used by the appearance.
VRMLNodeType	getLineProperties()	Get the current line properties used by the appearance.
VRMLNodeType	getMaterial()	Get the current material used by the appearance.
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.
VRMLNodeType	getPointProperties()	Get the current point properties used by the appearance.
int	getPrimaryType()	Get the primary type of this node.
VRMLNodeType	getShaders()	Get the current shaders used by the appearance.
VRMLNodeType	getTexture()	Get the current texture used by the appearance.
VRMLNodeType	getTextureProperties()	Get the current texture properties used by the appearance.
VRMLNodeType	getTextureTransform()	Get the current texture transform used by the appearance.
static float	getTotalTextureSize()	Get the total texture size of all textured loaded to date.
protected void	insureStageSize(int newLen, boolean inc)	Insures that the Texture Stage array and associated arrays are at least this big.
void	notifyExternProtoLoaded(int index, VRMLNodeType node)	Notify a node that an ExternProto has resolved.
protected NIOBufferImage[]	processImage(int stage, NIOBufferImage niobi, String url)	Setup TextureStage parameters
protected void	processImages(int stage, VRMLTextureNodeType tex)	Process the images in this texture.
void	removeMaterialColorListener(MaterialColorListener l)	Remove a listener instance from this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setAcousticProperties(VRMLNodeType prop)	Set the acousticProperties that should be used for this appearance.
protected void	setAlphaCutoff(float alphaCutoff)	Set the alphaCutoff
protected void	setAlphaMode(String alphaMode)	Set the alphaMode
void	setBackMaterial(VRMLNodeType prop)	Set the backMaterial that should be used for this appearance.
void	setCCW(boolean ccw)	Specify whether the geometry's triangles are in counter clockwise order (the default) or clockwise.
void	setFillProperties(VRMLNodeType prop)	Set the fillProperties that should be used for this appearance.
void	setLightingEnabled(boolean enable)	Set whether lighting will be used for this appearance.
void	setLineProperties(VRMLNodeType prop)	Set the line properties that should be used for this appearance.
void	setLocalColor(boolean enable, boolean hasAlpha)	Set whether the geometry has local colors to override the diffuse color.
void	setMaterial(VRMLNodeType mat)	Set the material that should be used for this appearance.
void	setPointProperties(VRMLNodeType prop)	Set the point properties that should be used for this appearance.
void	setShaders(VRMLNodeType prop)	Set the shaders that should be used for this appearance.
void	setSolid(boolean solid)	Specify whether an object is solid.
void	setTexture(VRMLNodeType tex)	Set the texture that should be used for this appearance.
void	setTextureProperties(VRMLNodeType prop)	Set the textureProperties that should be used for this appearance.
void	setTextureTransform(VRMLNodeType trans)	Set the texture transform that should be used for this appearance.
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, String value)	Set the value of the field at the given index as a String.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
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.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, 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, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_MATERIAL

protected static final int FIELD_MATERIAL

Index of the Material field value

See Also:

• Constant Field Values

FIELD_TEXTURE

protected static final int FIELD_TEXTURE

Index of the Texture field value

See Also:

• Constant Field Values

FIELD_TEXTURE_TRANSFORM

protected static final int FIELD_TEXTURE_TRANSFORM

Index of the TextureTransform field value

See Also:

• Constant Field Values

FIELD_LINE_PROPERTIES

protected static final int FIELD_LINE_PROPERTIES

Index of the lineProperties field value

See Also:

• Constant Field Values

FIELD_POINT_PROPERTIES

protected static final int FIELD_POINT_PROPERTIES

Index of the pointProperties field value

See Also:

• Constant Field Values

FIELD_FILL_PROPERTIES

protected static final int FIELD_FILL_PROPERTIES

Index of the fillProperties field value

See Also:

• Constant Field Values

FIELD_TEXTURE_PROPERTIES

protected static final int FIELD_TEXTURE_PROPERTIES

Index of the textureProperties field value

See Also:

• Constant Field Values

FIELD_ACOUSTIC_PROPERTIES

protected static final int FIELD_ACOUSTIC_PROPERTIES

Index of the acousticProperties field value

See Also:

• Constant Field Values

FIELD_ALPHACUTOFF

protected static final int FIELD_ALPHACUTOFF

Index of the alphaCutoff field value

See Also:

• Constant Field Values

FIELD_ALPHAMODE

protected static final int FIELD_ALPHAMODE

Index of the alphaMode field value

See Also:

• Constant Field Values

FIELD_BACKMATERIAL

protected static final int FIELD_BACKMATERIAL

Index of the backMaterial field value

See Also:

• Constant Field Values

FIELD_SHADERS

protected static final int FIELD_SHADERS

Index of the backMaterial field value

See Also:

• Constant Field Values

DEFAULT_USETEXTURECACHE

protected static final boolean DEFAULT_USETEXTURECACHE

The default useTextureCache value

See Also:

• Constant Field Values

USETEXTURECACHE_PROP

protected static final String USETEXTURECACHE_PROP

Property describing the rescaling method to use

See Also:

• Constant Field Values

useTextureCache

protected static final boolean useTextureCache

The value read from the system property for TEXTURECACHE

DEFAULT_USE_MIPMAPS

protected static final boolean DEFAULT_USE_MIPMAPS

The default useMipMaps value

See Also:

• Constant Field Values

USE_MIPMAPS_PROP

protected static final String USE_MIPMAPS_PROP

Property describing the mipmap usage

See Also:

• Constant Field Values

useMipMaps

protected static boolean useMipMaps

The value read from the system property for MIPMAPS

DEFAULT_ANISOTROPIC_DEGREE

protected static final int DEFAULT_ANISOTROPIC_DEGREE

The default anisotropicDegree value

See Also:

• Constant Field Values

ANISOTROPIC_DEGREE_PROP

protected static final String ANISOTROPIC_DEGREE_PROP

Property describing the anisotropicDegree value

See Also:

• Constant Field Values

anisotropicDegree

protected static final int anisotropicDegree

The anisotropicDegree value

MATERIAL_PROTO_MSG

protected static final String MATERIAL_PROTO_MSG

Message for when the proto is not a Material

See Also:

• Constant Field Values

MATERIAL_NODE_MSG

protected static final String MATERIAL_NODE_MSG

Message for when the node in setValue() is not a Material

See Also:

• Constant Field Values

TEXTURE_PROTO_MSG

protected static final String TEXTURE_PROTO_MSG

Message for when the proto is not a Texture

See Also:

• Constant Field Values

TEXTURE_NODE_MSG

protected static final String TEXTURE_NODE_MSG

Message for when the node in setValue() is not a Texture

See Also:

• Constant Field Values

TRANSFORM_PROTO_MSG

protected static final String TRANSFORM_PROTO_MSG

Message for when the proto is not a TextureTransform

See Also:

• Constant Field Values

TRANSFORM_NODE_MSG

protected static final String TRANSFORM_NODE_MSG

Message for when the node in setValue() is not a TextureTransform

See Also:

• Constant Field Values

FILL_PROP_PROTO_MSG

protected static final String FILL_PROP_PROTO_MSG

Message for when the proto is not a FillProperties

See Also:

• Constant Field Values

FILL_PROP_NODE_MSG

protected static final String FILL_PROP_NODE_MSG

Message for when the node in setValue() is not a FillProperties

See Also:

• Constant Field Values

LINE_PROP_PROTO_MSG

protected static final String LINE_PROP_PROTO_MSG

Message for when the proto is not a LineProperties

See Also:

• Constant Field Values

LINE_PROP_NODE_MSG

protected static final String LINE_PROP_NODE_MSG

Message for when the node in setValue() is not a LineProperties

See Also:

• Constant Field Values

POINT_PROP_PROTO_MSG

protected static final String POINT_PROP_PROTO_MSG

Message for when the proto is not a PointProperties

See Also:

• Constant Field Values

POINT_PROP_NODE_MSG

protected static final String POINT_PROP_NODE_MSG

Message for when the node in setValue() is not a PointProperties

See Also:

• Constant Field Values

TEXTURE_PROP_NODE_MSG

protected static final String TEXTURE_PROP_NODE_MSG

Message for when the node in setValue() is not a TextureProperties

See Also:

• Constant Field Values

TEXTURE_PROP_PROTO_MSG

protected static final String TEXTURE_PROP_PROTO_MSG

Message for when the proto is not a TextureProperties

See Also:

• Constant Field Values

pMaterial

protected VRMLProtoInstance pMaterial

Proto version of the material

vfMaterial

protected VRMLMaterialNodeType vfMaterial

SFNode material

pTexture

protected VRMLProtoInstance pTexture

Proto version of the texture

vfTexture

protected VRMLTextureNodeType vfTexture

SFNode texture.

pTextureTransform

protected VRMLProtoInstance pTextureTransform

Proto version of the texture transform

vfTextureTransform

protected VRMLTextureTransformNodeType vfTextureTransform

SFNode textureTransform

pFillProperties

protected VRMLProtoInstance pFillProperties

Proto version of the fillProperties

vfFillProperties

protected VRMLAppearanceChildNodeType vfFillProperties

SFNode fillProperties

pLineProperties

protected VRMLProtoInstance pLineProperties

Proto version of the lineProperties

vfLineProperties

protected VRMLAppearanceChildNodeType vfLineProperties

SFNode lineProperties.

pPointProperties

protected VRMLProtoInstance pPointProperties

Proto version of the pointProperties

vfPointProperties

protected VRMLPointPropertiesNodeType vfPointProperties

SFNode pointProperties.

pTextureProperties

protected VRMLProtoInstance pTextureProperties

Proto version of the textureProperties

vfTextureProperties

protected VRMLTextureProperties2DNodeType vfTextureProperties

SFNode textureProperties.

pAcousticProperties

protected VRMLProtoInstance pAcousticProperties

Proto version of the acousticProperties

vfAcousticProperties

protected VRMLNodeType vfAcousticProperties

SFNode acousticProperties.

vfAlphaCutoff

protected float vfAlphaCutoff

SFFloat alphaCutoff.

vfAlphaMode

protected String vfAlphaMode

SFString alphaMode.

pBackMaterial

protected VRMLProtoInstance pBackMaterial

Proto version of the backMaterial

vfBackMaterial

protected VRMLNodeType vfBackMaterial

SFNode backMaterial.

pShaders

protected VRMLProtoInstance pShaders

Proto version of the shaders

vfShaders

protected VRMLNodeType vfShaders

SFNode shaders.

numStages

protected int numStages

stages

protected TextureStage[] stages

urls

protected String[] urls

totalTextureSize

protected static float totalTextureSize

Total size of textures (K bytes)

Constructor Details

BaseAppearance

protected BaseAppearance()

Default constructor that initialises all fields to the spec defaults.

BaseAppearance

protected BaseAppearance(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a Appearance node, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

notifyExternProtoLoaded

public void notifyExternProtoLoaded(int index,
 VRMLNodeType node)
                             throws InvalidFieldValueException

Description copied from interface: VRMLNodeType

Notify a node that an ExternProto has resolved. This will verify the objects type and add it to the render sceneGraph.

Specified by:

notifyExternProtoLoaded in interface VRMLNodeType

Overrides:

notifyExternProtoLoaded in class AbstractNode

Parameters:

index - The field index

node - The node resolved

Throws:

InvalidFieldValueException - If the proto contains he wrong type

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 stage 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.

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.

setMaterial

public void setMaterial(VRMLNodeType mat)
                 throws InvalidFieldValueException

Set the material that should be used for this appearance. Setting a value of null will clear the current material.

Specified by:

setMaterial in interface VRMLAppearanceNodeType

Parameters:

mat - The new material instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getMaterial

public VRMLNodeType getMaterial()

Get the current material used by the appearance. If none has been set this will return null.

Specified by:

getMaterial in interface VRMLAppearanceNodeType

Returns:

The currently set Material

setTexture

public void setTexture(VRMLNodeType tex)
                throws InvalidFieldValueException

Set the texture that should be used for this appearance. Setting a value of null will clear the current texture.

Specified by:

setTexture in interface VRMLAppearanceNodeType

Parameters:

tex - The new texture instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getTexture

public VRMLNodeType getTexture()

Get the current texture used by the appearance. If none has been set this will return null.

Specified by:

getTexture in interface VRMLAppearanceNodeType

Returns:

The currently set Texture

setTextureTransform

public void setTextureTransform(VRMLNodeType trans)
                         throws InvalidFieldValueException

Set the texture transform that should be used for this appearance. Setting a value of null will clear the current texture transform.

Specified by:

setTextureTransform in interface VRMLAppearanceNodeType

Parameters:

trans - The new texture transform instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type

getTextureTransform

public VRMLNodeType getTextureTransform()

Get the current texture transform used by the appearance. If none has been set this will return null.

Specified by:

getTextureTransform in interface VRMLAppearanceNodeType

Returns:

The currently set TextureTransform

setLineProperties

public void setLineProperties(VRMLNodeType prop)
                       throws InvalidFieldValueException

Set the line properties that should be used for this appearance. Setting a value of null will clear the current property.

Specified by:

setLineProperties in interface VRMLAppearanceNodeType

Parameters:

prop - The new property instance instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getLineProperties

public VRMLNodeType getLineProperties()

Get the current line properties used by the appearance. If none has been set this will return null.

Specified by:

getLineProperties in interface VRMLAppearanceNodeType

Returns:

The currently set LineProperties

setPointProperties

public void setPointProperties(VRMLNodeType prop)
                        throws InvalidFieldValueException

Set the point properties that should be used for this appearance. Setting a value of null will clear the current property.

Parameters:

prop - The new property instance instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getPointProperties

public VRMLNodeType getPointProperties()

Get the current point properties used by the appearance. If none has been set this will return null.

Returns:

The currently set PointProperties

setAcousticProperties

public void setAcousticProperties(VRMLNodeType prop)
                           throws InvalidFieldValueException

Set the acousticProperties that should be used for this appearance. Setting a value of null will clear the current texture Properties.

Parameters:

prop - The new acousticProperties instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

setAlphaCutoff

protected void setAlphaCutoff(float alphaCutoff)
                       throws InvalidFieldValueException

Set the alphaCutoff

Parameters:

alphaCutoff - The new alphaCutoff to use

Throws:

InvalidFieldValueException - Radius value was negative

setAlphaMode

protected void setAlphaMode(String alphaMode)
                     throws InvalidFieldValueException

Set the alphaMode

Parameters:

alphaMode - The new alphaMode to use

Throws:

InvalidFieldValueException - Radius value was negative

setBackMaterial

public void setBackMaterial(VRMLNodeType prop)
                     throws InvalidFieldValueException

Set the backMaterial that should be used for this appearance. Setting a value of null will clear the current texture Properties.

Parameters:

prop - The new backMaterial instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

setShaders

public void setShaders(VRMLNodeType prop)
                throws InvalidFieldValueException

Set the shaders that should be used for this appearance. Setting a value of null will clear the current texture Properties.

Parameters:

prop - The new shaders instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

setTextureProperties

public void setTextureProperties(VRMLNodeType prop)
                          throws InvalidFieldValueException

Set the textureProperties that should be used for this appearance. Setting a value of null will clear the current texture Properties.

Parameters:

prop - The new textureProperties instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getTextureProperties

public VRMLNodeType getTextureProperties()

Get the current texture properties used by the appearance. If none has been set this will return null.

Returns:

The currently set TextureProperties

getAcousticProperties

public VRMLNodeType getAcousticProperties()

Get the current acousticProperties used by the appearance. If none has been set this will return null.

Returns:

The currently set AcousticProperties

getAlphaCutoff

public float getAlphaCutoff()

Get the current alphaCutoff used by the appearance. If none has been set this will return null.

Returns:

The currently set AlphaCutoff

getAlphaMode

public String getAlphaMode()

Get the current alphaMode used by the appearance. If none has been set this will return null.

Returns:

The currently set alphaMode

getBackMaterial

public VRMLNodeType getBackMaterial()

Get the current backMaterial used by the appearance. If none has been set this will return null.

Returns:

The currently set BackMaterial

getShaders

public VRMLNodeType getShaders()

Get the current shaders used by the appearance. If none has been set this will return null.

Returns:

The currently set Shaders

setFillProperties

public void setFillProperties(VRMLNodeType prop)
                       throws InvalidFieldValueException

Set the fillProperties that should be used for this appearance. Setting a value of null will clear the current property.

Specified by:

setFillProperties in interface VRMLAppearanceNodeType

Parameters:

prop - The new fillProperties instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

getFillProperties

public VRMLNodeType getFillProperties()

Get the current texture used by the appearance. If none has been set this will return null.

Specified by:

getFillProperties in interface VRMLAppearanceNodeType

Returns:

The currently set FillProperties

setSolid

public void setSolid(boolean solid)

Specify whether an object is solid. The default is true. This will determine if we do backface culling and flip backface normals. Can only be set during setup

Specified by:

setSolid in interface VRMLAppearanceNodeType

Parameters:

solid - Whether the object is solid

setLightingEnabled

public void setLightingEnabled(boolean enable)

Set whether lighting will be used for this appearance. In general you should let the material node decide this. Needed to handle IndexedLineSets or other geometry that specifically declares lighting be turned off. This method will notify the related Material node for this Appearance.

Specified by:

setLightingEnabled in interface VRMLAppearanceNodeType

Parameters:

enable - Whether lighting is enabled

setCCW

public void setCCW(boolean ccw)

Specify whether the geometry's triangles are in counter clockwise order (the default) or clockwise. The default is true. This will determine if we do backface culling and flip backface normals. Can only be set during setup

Specified by:

setCCW in interface VRMLAppearanceNodeType

Parameters:

ccw - True for counter-clockwise ordering

setLocalColor

public void setLocalColor(boolean enable,
 boolean hasAlpha)

Set whether the geometry has local colors to override the diffuse color. If the local color contains alpha values we want to ignore the material's transparency values.

Specified by:

setLocalColor in interface VRMLAppearanceNodeType

Parameters:

enable - Whether local color is enabled

hasAlpha - true with the local color also contains alpha values

addMaterialColorListener

public void addMaterialColorListener(MaterialColorListener l)

Add a listener instance for the material color change notifications. Adding the same instance more than once is ignored. Adding null values are ignored.

Specified by:

addMaterialColorListener in interface VRMLAppearanceNodeType

Parameters:

l - The new instance to add

removeMaterialColorListener

public void removeMaterialColorListener(MaterialColorListener l)

Remove a listener instance from this node. If the listener is not currently registered, the request is silently ignored.

Specified by:

removeMaterialColorListener in interface VRMLAppearanceNodeType

Parameters:

l - The new instance to remove

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

Set the value of the field at the given index as a node. This would be used to set SFNode 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 index does not match a known field

InvalidFieldValueException - The node does not match the required type.

getTotalTextureSize

public static float getTotalTextureSize()

Get the total texture size of all textured loaded to date.

Returns:

The total(K bytes) of textures loaded.

processImage

protected NIOBufferImage[] processImage(int stage,
 NIOBufferImage niobi,
 String url)

Setup TextureStage parameters

Parameters:

stage - The TextureStage index

niobi - The image object

url - The source of the image

Returns:

The array of images

insureStageSize

protected void insureStageSize(int newLen,
 boolean inc)

Insures that the Texture Stage array and associated arrays are at least this big. Sets the numStages variable to the largest length.

Parameters:

newLen - The new length

inc - Should this increase the number of valid stages

processImages

protected void processImages(int stage,
 VRMLTextureNodeType tex)

Process the images in this texture. Recursively follow any multitexture references.

Parameters:

stage - The TextureStage index

tex - The texture to process.