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

Class BasePixelTexture

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseTextureNode

org.web3d.vrml.renderer.common.nodes.BaseTexture2DNode

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLTexture2DNodeType, VRMLTextureNodeType

Direct Known Subclasses:

NRPixelTexture, OGLPixelTexture

public abstract class BasePixelTexture
extends BaseTexture2DNode

Common implementation of a PixelTexture node.

Given a SFImage this will produce a Texture2D object

Version:

$Revision: 1.9 $

Author:

Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_IMAGE	Field Index for the Image field
protected int[]	vfImage	exposedField SFImage 0 0 0
protected int	vfImageLen	actual length of vfVector

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

FIELD_DESCRIPTION, FIELD_REPEATS, FIELD_REPEATT, FIELD_TEXTURE_PROPERTIES, implImage, LAST_TEXTURENODETYPE_INDEX, pTextureProperties, TEXPROPS_VERSION_MSG, TEXTURE_PROPS_NODE_MSG, TEXTURE_PROPS_PROTO_MSG, vfDescription, vfRepeatS, vfRepeatT, vfTextureProperties

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

listenerList

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

Method Summary

Modifier and Type	Method	Description
String	getCacheString(int stage)	Get a string for caching this object.
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.
protected abstract void	processImageData()	The image data field has been updated, so time to process the image right now.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setValue(int index, int[] value, int numValid)	Set the value of the field at the given index as an array of integers.

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

copy, getDescription, getImage, getRepeatS, getRepeatT, getTextureProperties, getTextureType, setTextureProperties, setupFinished, setValue, setValue, setValue

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

addTextureListener, fireTextureImageChanged, fireTextureParamsChanged, removeTextureListener

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

Methods inherited from interface org.web3d.vrml.nodes.VRMLTextureNodeType

addTextureListener, removeTextureListener

Field Details

FIELD_IMAGE

protected static final int FIELD_IMAGE

Field Index for the Image field

See Also:

• Constant Field Values

vfImage

protected int[] vfImage

exposedField SFImage 0 0 0

vfImageLen

protected int vfImageLen

actual length of vfVector

Constructor Details

BasePixelTexture

public BasePixelTexture()

Empty constructor

BasePixelTexture

public BasePixelTexture(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

getCacheString

public String getCacheString(int stage)

Get a string for caching this object. Null means do not cache this texture.

Specified by:

getCacheString in interface VRMLTextureNodeType

Overrides:

getCacheString in class BaseTextureNode

Parameters:

stage - The stage number, 0 for all single stage textures.

Returns:

A string to use in lookups. Typically the url loaded.

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

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.

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

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

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 BaseTexture2DNode

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 BaseTexture2DNode

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,
 int[] value,
 int numValid)
              throws InvalidFieldException

Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 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 field index is not know

processImageData

protected abstract void processImageData()

The image data field has been updated, so time to process the image right now. The field notifications have not been sent yet.