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

Class BaseImage2D

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

org.web3d.vrml.renderer.common.nodes.layout.BaseImage2D

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType

Direct Known Subclasses:

NRImage2D

public abstract class BaseImage2D
extends BaseSurfaceChildNode
implements VRMLSurfaceChildNodeType

Common implementation of a Image2D node.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ENABLED	The field index for enabled.
protected static final int	FIELD_FIXED_SIZE	The field index for fixedSize.
protected static final int	FIELD_ISACTIVE	The field index for isActive.
protected static final int	FIELD_ISOVER	The field index for isOvery.
protected static final int	FIELD_TEXTURE	The field index for texture.
protected static final int	FIELD_TOUCHTIME	The field index for touchTime.
protected static final int	FIELD_TRACKPOINT_CHANGED	The field index for trackPoint_changed.
protected static final int	FIELD_WINDOW_RELATIVE	The field index for windowRelative.
protected static final int	LAST_IMAGE2D_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pTexture	Proto version of the texture
protected static final String	TEXTURE_NODE_MSG	Message for when the node in setValue() is not a Appearance
protected static final String	TEXTURE_PROTO_MSG	Message for when the proto is not a Appearance
protected boolean	vfEnabled	The value of the enabled exposedField
protected boolean	vfFixedSize	The value of the fixedSize field.
protected boolean	vfIsActive	The value of the isActive eventOut
protected boolean	vfIsOver	The value of the isOver eventOut
protected VRMLTexture2DNodeType	vfTexture	The value of the texture exposedField.
protected double	vfTouchTime	The value of the touchTime eventOut
protected float[]	vfTrackPoint	The value of th trackPoint_changed eventOut
protected boolean	vfWindowRelative	The value of the windowRelative field

Fields inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

FIELD_BBOX_SIZE, FIELD_VISIBLE, LAST_SURFACE_CHILD_INDEX, listener, parentVisibility, screenBounds, screenLocation, vfBboxSize, 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

Modifier	Constructor	Description
protected	BaseImage2D()	Construct a new default Overlay object
protected	BaseImage2D(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Accessor method to get current value of the enabled field.
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	getIsActive()	Accessor method to get current value of the isActive 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[]	getSecondaryType()	Get the secondary type of 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	setEnabled(boolean state)	Accessor method to set a new value for the enabled field
protected void	setTextureNode(VRMLNodeType texture)	Called to set the texture node to be used.
protected void	setTrackPoint(int x, int y)	Send notification that the track point has changed.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field from the raw string.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as an array of nodes.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

copy, fireSizeChange, getBboxSize, getParentVisible, getPrimaryType, getRealBounds, isVisible, setBboxSize, setLayoutListener, setLocation, setParentVisible, setValue, setVisible

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, 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

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

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

getBboxSize, getParentVisible, getRealBounds, isVisible, setLayoutListener, setLocation, setParentVisible, setVisible

Field Details

FIELD_FIXED_SIZE

protected static final int FIELD_FIXED_SIZE

The field index for fixedSize.

See Also:

• Constant Field Values

FIELD_TEXTURE

protected static final int FIELD_TEXTURE

The field index for texture.

See Also:

• Constant Field Values

FIELD_ISACTIVE

protected static final int FIELD_ISACTIVE

The field index for isActive.

See Also:

• Constant Field Values

FIELD_ENABLED

protected static final int FIELD_ENABLED

The field index for enabled.

See Also:

• Constant Field Values

FIELD_ISOVER

protected static final int FIELD_ISOVER

The field index for isOvery.

See Also:

• Constant Field Values

FIELD_TOUCHTIME

protected static final int FIELD_TOUCHTIME

The field index for touchTime.

See Also:

• Constant Field Values

FIELD_TRACKPOINT_CHANGED

protected static final int FIELD_TRACKPOINT_CHANGED

The field index for trackPoint_changed.

See Also:

• Constant Field Values

FIELD_WINDOW_RELATIVE

protected static final int FIELD_WINDOW_RELATIVE

The field index for windowRelative.

See Also:

• Constant Field Values

LAST_IMAGE2D_INDEX

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

TEXTURE_PROTO_MSG

protected static final String TEXTURE_PROTO_MSG

Message for when the proto is not a Appearance

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 Appearance

See Also:

• Constant Field Values

vfFixedSize

protected boolean vfFixedSize

The value of the fixedSize field.

vfTexture

protected VRMLTexture2DNodeType vfTexture

The value of the texture exposedField.

pTexture

protected VRMLProtoInstance pTexture

Proto version of the texture

vfIsActive

protected boolean vfIsActive

The value of the isActive eventOut

vfWindowRelative

protected boolean vfWindowRelative

The value of the windowRelative field

vfEnabled

protected boolean vfEnabled

The value of the enabled exposedField

vfIsOver

protected boolean vfIsOver

The value of the isOver eventOut

vfTouchTime

protected double vfTouchTime

The value of the touchTime eventOut

vfTrackPoint

protected float[] vfTrackPoint

The value of th trackPoint_changed eventOut

Constructor Details

BaseImage2D

protected BaseImage2D()

Construct a new default Overlay object

BaseImage2D

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

setEnabled

public void setEnabled(boolean state)

Accessor method to set a new value for the enabled field

Parameters:

state - The new enabled state

getEnabled

public boolean getEnabled()

Accessor method to get current value of the enabled field. The default value is true.

Returns:

The value of the enabled field

getIsActive

public boolean getIsActive()

Accessor method to get current value of the isActive field.

Returns:

The current value of isActive

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

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 BaseSurfaceChildNode

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.

getSecondaryType

public int[] getSecondaryType()

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

Specified by:

getSecondaryType in interface VRMLNode

Overrides:

getSecondaryType in class AbstractNode

Returns:

The secondary 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 BaseSurfaceChildNode

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 BaseSurfaceChildNode

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 InvalidFieldFormatException,
InvalidFieldValueException,
InvalidFieldException

Set the value of the field from the raw string. This requires the implementation to parse the string in the given format for the field type. If the field type does not match the requirements for that index then an exception will be thrown. If the destination field is a string, then the leading and trailing quote characters will be stripped before calling this method.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseSurfaceChildNode

Parameters:

index - The index of destination field to set

value - The raw value string to be parsed

Throws:

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

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

InvalidFieldException - The field index is not know

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException

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

setTextureNode

protected void setTextureNode(VRMLNodeType texture)
                       throws InvalidFieldValueException

Called to set the texture node to be used. May be overridden by the derived class, but must also call this version first to ensure everything is valid node types and the fields correctly set.

Parameters:

texture - The new texture node instance to use

Throws:

InvalidFieldValueException - The node is not the required type

setTrackPoint

protected void setTrackPoint(int x,
 int y)

Send notification that the track point has changed. The values passed should be in surface coordinates and this will adjust as necessary for the windowRelative field setting when generating the eventOut. Assumes standard window coordinates with X across and Y down.

Parameters:

x - The x position of the mouse

y - The y position of the mouse