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

Class BaseCADFace

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.cadgeometry.BaseCADFace

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLProductStructureChildNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRCADFace, OGLCADFace

public class BaseCADFace
extends AbstractNode
implements VRMLProductStructureChildNodeType

Common base implementation of a CADFace node.

Version:

$Revision: 1.5 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_BBOX_CENTER	Field Index
protected static final int	FIELD_BBOX_DISPLAY	Field Index
protected static final int	FIELD_BBOX_SIZE	Field Index
protected static final int	FIELD_NAME	Field Index
protected static final int	FIELD_SHAPE	Field Index
protected static final int	FIELD_VISIBLE	Field Index
protected static final 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_CADFACE_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pShape	Proto version of the Shape
protected static final String	SHAPE_NODE_MSG	Message for when the node in setValue() is not a Shape
protected static final String	SHAPE_PROTO_MSG	Message for when the proto is not a Shape
protected float[]	vfBboxCenter	SFVec3f bboxCenter NULL
protected boolean	vfBboxDisplay	SFBool bboxDisplay false
protected float[]	vfBboxSize	SFVec3f bboxSize NULL
protected String	vfName	The name field
protected VRMLNodeType	vfShape	The shape field
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

Constructor	Description
BaseCADFace()	Construct a default instance of this node.
BaseCADFace(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
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.
String	getName()	Get the name of this node.
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.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setBboxCenter(float[] val)	Set the bounding box for this node.
protected void	setBboxDisplay(boolean val)	Set the bounding box for this node.
protected void	setBboxSize(float[] val)	Set the bounding box for this node.
void	setName(String name)	Set the name of this node.
protected void	setShape(VRMLNodeType shape)	Set node content as replacement for shape.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
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.
protected void	setVisible(boolean val)	Set the 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_NAME

protected static final int FIELD_NAME

Field Index

See Also:

• Constant Field Values

FIELD_SHAPE

protected static final int FIELD_SHAPE

Field Index

See Also:

• Constant Field Values

FIELD_BBOX_CENTER

protected static final int FIELD_BBOX_CENTER

Field Index

See Also:

• Constant Field Values

FIELD_BBOX_SIZE

protected static final int FIELD_BBOX_SIZE

Field Index

See Also:

• Constant Field Values

FIELD_BBOX_DISPLAY

protected static final int FIELD_BBOX_DISPLAY

Field Index

See Also:

• Constant Field Values

FIELD_VISIBLE

protected static final int FIELD_VISIBLE

Field Index

See Also:

• Constant Field Values

LAST_CADFACE_INDEX

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

SHAPE_PROTO_MSG

protected static final String SHAPE_PROTO_MSG

Message for when the proto is not a Shape

See Also:

• Constant Field Values

SHAPE_NODE_MSG

protected static final String SHAPE_NODE_MSG

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

See Also:

• Constant Field Values

fieldDecl

protected static final VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfName

protected String vfName

The name field

vfShape

protected VRMLNodeType vfShape

The shape field

pShape

protected VRMLProtoInstance pShape

Proto version of the Shape

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

Constructor Details

BaseCADFace

public BaseCADFace()

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

BaseCADFace

public BaseCADFace(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

setName

public void setName(String name)

Set the name of this node.

Specified by:

setName in interface VRMLProductStructureChildNodeType

Parameters:

name - The new name.

getName

public String getName()

Get the name of this node.

Specified by:

getName in interface VRMLProductStructureChildNodeType

Returns:

The name.

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

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

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

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

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

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation 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 known

InvalidFieldValueException - The value provided is out of range for the field type.

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

setShape

protected void setShape(VRMLNodeType shape)
                 throws InvalidFieldValueException

Set node content as replacement for shape.

Parameters:

shape - The new shape. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

setBboxCenter

protected void setBboxCenter(float[] val)

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

Parameters:

val - The box center to set

setBboxSize

protected void setBboxSize(float[] val)
                    throws InvalidFieldValueException

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

Parameters:

val - The box size to set

Throws:

InvalidFieldValueException - The bounds is not valid

setBboxDisplay

protected void setBboxDisplay(boolean val)

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

Parameters:

val - The box display to set

setVisible

protected void setVisible(boolean val)

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

Parameters:

val - The box display to set