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

Class BaseStaticGroup

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.group.BaseStaticGroup

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRStaticGroup, OGLStaticGroup

public abstract class BaseStaticGroup
extends AbstractNode
implements VRMLBoundedNodeType

Common base implementation of a StaticGroup node.

Properties

The following properties are used by this class

• org.web3d.vrml.nodes.staticgroup.dispose Boolean value describing whether the StaticGroup should dispose of the VRML node children. This is an efficiency measure that will allow an implementation to remove unneeded memory. However, it also means that they can no longer be traversed, so if your application is trying to traverse the scene graph, it will not be able to use the nodes later on. Useful for a runtime optimisation, no good if you are writing an editor.
• org.web3d.vrml.nodes.staticgroup.compact Boolean value describing whether the StaticGroup should compact the VRML scene graph below this node or leave it in an expanded state. This is an efficiency measure that will allow an implementation to flatten the scene graph if desired. Useful for debugging but also means the runtime scene graph will probably be different from the original loaded from file.

The base implementation provided by this class does not do anything with these properties. Their values are only provided as a hook for higher level functionality. This is because most of the action would take place in the setupFinished() method and it would dispose/compact the children before the derived class had a chance to do anything with the children nodes. It is assumed that a derived class would know when and where it is safe to dispose of the children.

Version:

$Revision: 1.12 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	compactChildren	Global flag to specify if the StaticGroup should compact its children nodes during the setupFinish().
protected static final boolean	disposeChildren	Global flag to specify if the StaticGroup should dispose of its children after setupFinished() is called as an optimisation measure.
protected static final int	FIELD_BBOX_CENTER	Index of the Bounding box center bboxCenter field
protected static final int	FIELD_BBOX_DISPLAY	Index of the Bounding box display bboxDisplay field
protected static final int	FIELD_BBOX_SIZE	Index of the Bounding box size bboxSize field
protected static final int	FIELD_CHILDREN	Index of the children field
protected static final int	FIELD_VISIBLE	Index of the Bounding box display bboxDisplay field
protected static VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected static final int	LAST_STATICGROUP_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected int	shareCount	Counter for the number of sharing references this has
protected float[]	vfBboxCenter	SFVec3f bboxCenter NULL
protected boolean	vfBboxDisplay	SFBool bboxDisplay false
protected float[]	vfBboxSize	SFVec3f bboxSize NULL
protected List<VRMLNodeType>	vfChildren	MFNode children 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	BaseStaticGroup()	Construct a default instance of this node.
protected	BaseStaticGroup(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
protected void	addChildNode(VRMLNodeType node)	Add a single child node to the list of available children.
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.
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.
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	setBboxCenter(float[] val)	Set the bounding box for this node.
void	setBboxDisplay(boolean val)	Set the bounding box display for this node.
void	setBboxSize(float[] val)	Set the bounding box for this node.
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 an array of nodes.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as an array of nodes.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.
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, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, 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, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_CHILDREN

protected static final int FIELD_CHILDREN

Index of the children field

See Also:

• Constant Field Values

FIELD_BBOX_CENTER

protected static final int FIELD_BBOX_CENTER

Index of the Bounding box center bboxCenter field

See Also:

• Constant Field Values

FIELD_BBOX_SIZE

protected static final int FIELD_BBOX_SIZE

Index of the Bounding box size bboxSize field

See Also:

• Constant Field Values

FIELD_BBOX_DISPLAY

protected static final int FIELD_BBOX_DISPLAY

Index of the Bounding box display bboxDisplay field

See Also:

• Constant Field Values

FIELD_VISIBLE

protected static final int FIELD_VISIBLE

Index of the Bounding box display bboxDisplay field

See Also:

• Constant Field Values

LAST_STATICGROUP_INDEX

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

fieldDecl

protected static VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

disposeChildren

protected static final boolean disposeChildren

Global flag to specify if the StaticGroup should dispose of its children after setupFinished() is called as an optimisation measure.

compactChildren

protected static final boolean compactChildren

Global flag to specify if the StaticGroup should compact its children nodes during the setupFinish().

vfChildren

protected List<VRMLNodeType> vfChildren

MFNode children 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

shareCount

protected int shareCount

Counter for the number of sharing references this has

Constructor Details

BaseStaticGroup

protected BaseStaticGroup()

Construct a default instance of this node. The defaults are set by the VRML specification.

BaseStaticGroup

protected BaseStaticGroup(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

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)

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

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.

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

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

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldFormatException,
InvalidFieldValueException,
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

value - The new value to use for the node

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

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 known

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

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              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

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

setBboxCenter

public void setBboxCenter(float[] val)
                   throws InvalidFieldValueException

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

Specified by:

setBboxCenter in interface VRMLBoundedNodeType

Parameters:

val - The box center to set

Throws:

InvalidFieldValueException

setBboxSize

public void setBboxSize(float[] val)
                 throws InvalidFieldValueException

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

Specified by:

setBboxSize in interface VRMLBoundedNodeType

Parameters:

val - The box size to set

Throws:

InvalidFieldValueException - The bounds is not valid

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

addChildNode

protected void addChildNode(VRMLNodeType node)
                     throws InvalidFieldValueException

Add a single child node to the list of available children. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

Parameters:

node - The node to add

Throws:

InvalidFieldValueException - This is a bindable node shared