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

Class BaseShape

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, LocalColorsListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNodeType, VRMLShapeNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRShape, OGLShape

public abstract class BaseShape
extends AbstractNode
implements VRMLShapeNodeType, VRMLBoundedNodeType, LocalColorsListener

Common base renderer implementation of a shape node.

Version:

$Revision: 1.22 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	APPEARANCE_NODE_MSG	Message for when the node in setValue() is not a Appearance
protected static final String	APPEARANCE_PROTO_MSG	Message for when the proto is not a Appearance
protected static final boolean	DEFAULT_FORCE_LIGHTING	The default forceLighting value
protected static final int	FIELD_APPEARANCE	Index for the appearance field
protected static final int	FIELD_GEOMETRY	Index for the geometry field
protected static final String	FORCE_LIGHTING_PROP
protected static boolean	forceLighting	The value read from the system property for ForceLighting
protected static final String	GEOMETRY_NODE_MSG	Message for when the node in setValue() is not a Geometry
protected static final String	GEOMETRY_PROTO_MSG	Message for when the proto is not a Geometry
protected static final int	LAST_SHAPE_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pAppearance	Proto version of the appearance
protected VRMLProtoInstance	pGeometry	Proto version of the Geometry
protected int	shareCount	Counter for the number of sharing references this has
protected VRMLAppearanceNodeType	vfAppearance	SFNode appearance NULL
protected float[]	vfBboxCenter	SFVec3f bboxCenter NULL
protected boolean	vfBboxDisplay	SFBool bboxDisplay false
protected float[]	vfBboxSize	SFVec3f bboxSize NULL
protected boolean	vfCastShadow	SFBool castShadow true
protected VRMLGeometryNodeType	vfGeometry	SFNode geometry NULL
protected boolean	vfVisible	SFBool visible true

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	BaseShape()	Construct a new default shape node implementation.
protected	BaseShape(BaseShape node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
VRMLNodeType	getAppearance()	Get node content for appearance.
float[]	getBboxCenter()	Get the current value of field the bboxCenter field.
boolean	getBboxDisplay()	Get the current value of the bboxDisplay field.
float[]	getBboxSize()	Get the current value of the bboxSize field.
boolean	getCastShadow()
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	getGeometry()	Get node content for geometry
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.
int[]	getSecondaryType()	Get the secondary type of this node.
boolean	getVisible()	Get the current value of the visible field.
boolean	isShared()	Check to see if this node has been used more than once.
void	localColorsChanged(boolean enabled, boolean hasAlpha)	The localColors state has change.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setAppearance(VRMLNodeType app)	Set node content as replacement for appearance.
void	setBboxCenter(float[] newBboxCenter)	Convenience method to set a new value the vfBboxCenter fields
void	setBboxDisplay(boolean val)	Set the bounding box display for this node.
void	setBboxSize(float[] newBboxSize)	Convenience method to set a new value for the vfBboxSize field.
void	setCastShadow(boolean val)	Set castShadow field for this node.
void	setGeometry(VRMLNodeType geom)	Set node content as replacement for geometry.
void	setShared(boolean used)	Adjust the sharing count up or down one increment depending on the flag.
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, int numValid)	Set the value of the field at the given index as a node.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setVisible(boolean val)	Set visible field for this node.

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

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

Field Details

FIELD_APPEARANCE

protected static final int FIELD_APPEARANCE

Index for the appearance field

See Also:

• Constant Field Values

FIELD_GEOMETRY

protected static final int FIELD_GEOMETRY

Index for the geometry field

See Also:

• Constant Field Values

LAST_SHAPE_INDEX

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

FORCE_LIGHTING_PROP

protected static final String FORCE_LIGHTING_PROP

See Also:

• Constant Field Values

DEFAULT_FORCE_LIGHTING

protected static final boolean DEFAULT_FORCE_LIGHTING

The default forceLighting value

See Also:

• Constant Field Values

forceLighting

protected static boolean forceLighting

The value read from the system property for ForceLighting

GEOMETRY_PROTO_MSG

protected static final String GEOMETRY_PROTO_MSG

Message for when the proto is not a Geometry

See Also:

• Constant Field Values

GEOMETRY_NODE_MSG

protected static final String GEOMETRY_NODE_MSG

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

See Also:

• Constant Field Values

APPEARANCE_PROTO_MSG

protected static final String APPEARANCE_PROTO_MSG

Message for when the proto is not a Appearance

See Also:

• Constant Field Values

APPEARANCE_NODE_MSG

protected static final String APPEARANCE_NODE_MSG

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

See Also:

• Constant Field Values

pAppearance

protected VRMLProtoInstance pAppearance

Proto version of the appearance

vfAppearance

protected VRMLAppearanceNodeType vfAppearance

SFNode appearance NULL

pGeometry

protected VRMLProtoInstance pGeometry

Proto version of the Geometry

vfGeometry

protected VRMLGeometryNodeType vfGeometry

SFNode geometry NULL

vfBboxCenter

protected float[] vfBboxCenter

SFVec3f bboxCenter NULL

vfBboxSize

protected float[] vfBboxSize

SFVec3f bboxSize NULL

vfBboxDisplay

protected boolean vfBboxDisplay

SFBool bboxDisplay false

vfVisible

protected boolean vfVisible

SFBool visible true

vfCastShadow

protected boolean vfCastShadow

SFBool castShadow true

shareCount

protected int shareCount

Counter for the number of sharing references this has

Constructor Details

BaseShape

protected BaseShape()

Construct a new default shape node implementation.

BaseShape

protected BaseShape(BaseShape node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - Incorrect node type

Method Details

getAppearance

public VRMLNodeType getAppearance()

Get node content for appearance.

Specified by:

getAppearance in interface VRMLShapeNodeType

Returns:

The current appearance

setAppearance

public void setAppearance(VRMLNodeType app)
                   throws InvalidFieldValueException

Set node content as replacement for appearance.

Specified by:

setAppearance in interface VRMLShapeNodeType

Parameters:

app - The new appearance. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

getGeometry

public VRMLNodeType getGeometry()

Get node content for geometry

Specified by:

getGeometry in interface VRMLShapeNodeType

Returns:

The current geometry field

setGeometry

public void setGeometry(VRMLNodeType geom)
                 throws InvalidFieldValueException

Set node content as replacement for geometry.

Specified by:

setGeometry in interface VRMLShapeNodeType

Parameters:

geom - The new value for geometry. Null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

getBboxCenter

public float[] getBboxCenter()

Description copied from interface: VRMLBoundedNodeType

Get the current value of field the bboxCenter field. The default value is 0 0 0.

Specified by:

getBboxCenter in interface VRMLBoundedNodeType

Returns:

The value of bboxCenter(SFVec3f)

getBboxSize

public float[] getBboxSize()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the bboxSize field. The default value is -1 -1 -1.

Specified by:

getBboxSize in interface VRMLBoundedNodeType

Returns:

The size of the bboxSize(SFVec3f)

getBboxDisplay

public boolean getBboxDisplay()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the bboxDisplay field. The default value is false.

Specified by:

getBboxDisplay in interface VRMLBoundedNodeType

Returns:

the value of the bboxDisplay(SFBool)

getVisible

public boolean getVisible()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the visible field. The default value is true.

Specified by:

getVisible in interface VRMLBoundedNodeType

Returns:

the value of the visible(SFBool)

getCastShadow

public boolean getCastShadow()

isShared

public boolean isShared()

Check to see if this node has been used more than once. If it has then return true.

Specified by:

isShared in interface VRMLBoundedNodeType

Returns:

true if this node is shared

setShared

public void setShared(boolean used)

Adjust the sharing count up or down one increment depending on the flag.

Specified by:

setShared in interface VRMLBoundedNodeType

Parameters:

used - true if this is about to have another reference added

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

localColorsChanged

public void localColorsChanged(boolean enabled,
 boolean hasAlpha)

The localColors state has change.

Specified by:

localColorsChanged in interface LocalColorsListener

Parameters:

enabled - True if the geometry has local colors.

hasAlpha - true with the local color also contains alpha values

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

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 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)

Description copied from interface: VRMLNodeType

Set the value of the field at the given index as an boolean. This would be used to set SFBool 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

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a node. This would be used to set SFVec3f field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The raw value string to be parsed

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided does not fit this type of node

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

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:

InvalidFieldValueException - The node does not match the required type.

InvalidFieldException - The field index is not known

setBboxCenter

public void setBboxCenter(float[] newBboxCenter)
                   throws InvalidFieldAccessException

Convenience method to set a new value the vfBboxCenter fields

Specified by:

setBboxCenter in interface VRMLBoundedNodeType

Parameters:

newBboxCenter - The new center of the bounding box

Throws:

InvalidFieldAccessException - The call is attempting to write to after setup has finished

setBboxSize

public void setBboxSize(float[] newBboxSize)
                 throws InvalidFieldAccessException

Convenience method to set a new value for the vfBboxSize field.

Specified by:

setBboxSize in interface VRMLBoundedNodeType

Parameters:

newBboxSize - The new size for the bounding box

Throws:

InvalidFieldAccessException - The call is attempting to write to after setup has finished

setBboxDisplay

public void setBboxDisplay(boolean val)

Set the bounding box display for this node. Only used by the field parser

Specified by:

setBboxDisplay in interface VRMLBoundedNodeType

Parameters:

val - the display value to set

setVisible

public void setVisible(boolean val)

Set visible field for this node. Only used by the field parser

Specified by:

setVisible in interface VRMLBoundedNodeType

Parameters:

val - the display value to set

setCastShadow

public void setCastShadow(boolean val)

Set castShadow field for this node. Only used by the field parser

Parameters:

val - the display value to set