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

Class BaseAnnotationTarget

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.annotation.BaseAnnotationTarget

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

public class BaseAnnotationTarget
extends AbstractNode
implements VRMLChildNodeType

A node that represents target for annotations.

The node definition is:

 AnnotationTarget : X3DChildNode {
   MFNode  [in,out] annotations    []       [X3DAnnotationNode]
   SFNode  [in,out] leadLineStyle  NULL     [X3DLinePropertiesNode]
   SFNode  [in,out] metadata       NULL     [X3DMetadataObject]
   SFVec3f [in,out] referencePoint 0, 0, 0  (-∞,∞)
   SFNode  [in,out] marker         NULL     [X3DShapeNode]
 }
 

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ANNOTATION_NODE_MSG	Message for when the node in setValue() is not a X3DAnnotationNode
protected static final String	ANNOTATION_PROTO_MSG	Message for when the proto is not a X3DAnnotationNode
protected List<VRMLNodeType>	annotationsList	Temporary array to store the values in during node setup
protected static final int	FIELD_ANNOTATIONS	Index of the annotations field
protected static final int	FIELD_LEAD_LINE_STYLE	Index of the leadLineStyle field
protected static final int	FIELD_MARKER	Index of the leadLineStyle field
protected static final int	FIELD_REFERENCE_POINT	Index of the leadLineStyle field
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_ANNOTATION_INDEX	The last field index used by this class
protected static final String	LEAD_LINE_STYLE_NODE_MSG	Message for when the node in setValue() is not a LineProperties
protected static final String	LEAD_LINE_STYLE_PROTO_MSG	Message for when the proto is not a LineProperties
protected static final String	MARKER_NODE_MSG	Message for when the node in setValue() is not a X3DShapeNode
protected static final String	MARKER_PROTO_MSG	Message for when the proto is not a X3DShapeNode
protected VRMLProtoInstance	pLeadLineStyle	Proto version of the leadLineStyle field
protected VRMLProtoInstance	pMarker	Proto version of the marker field
protected VRMLNodeType[]	vfAnnotations	inputOutput MFNode annotations
protected VRMLAppearanceChildNodeType	vfLeadLineStyle	inputOutput SFNode leadLineStyle NULL
protected VRMLShapeNodeType	vfMarker	inputOutput SFNode field
protected float[]	vfReferencePoint	inputOutput SFVec3f referencePoint 0, 0, 0

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
BaseAnnotationTarget()	Create a new, default instance of this class.
BaseAnnotationTarget(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.
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.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setLeadLineStyle(VRMLNodeType lineStyle)	Set node content as replacement for lineStyle.
protected void	setMarker(VRMLNodeType marker)	Set node content as replacement for marker.
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, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setValue(int index, VRMLNodeType[] value, int numValid)	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.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, 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, setValue, updateRefCount

Field Details

FIELD_ANNOTATIONS

protected static final int FIELD_ANNOTATIONS

Index of the annotations field

See Also:

• Constant Field Values

FIELD_LEAD_LINE_STYLE

protected static final int FIELD_LEAD_LINE_STYLE

Index of the leadLineStyle field

See Also:

• Constant Field Values

FIELD_REFERENCE_POINT

protected static final int FIELD_REFERENCE_POINT

Index of the leadLineStyle field

See Also:

• Constant Field Values

FIELD_MARKER

protected static final int FIELD_MARKER

Index of the leadLineStyle field

See Also:

• Constant Field Values

LAST_ANNOTATION_INDEX

protected static final int LAST_ANNOTATION_INDEX

The last field index used by this class

See Also:

• Constant Field Values

LEAD_LINE_STYLE_PROTO_MSG

protected static final String LEAD_LINE_STYLE_PROTO_MSG

Message for when the proto is not a LineProperties

See Also:

• Constant Field Values

LEAD_LINE_STYLE_NODE_MSG

protected static final String LEAD_LINE_STYLE_NODE_MSG

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

See Also:

• Constant Field Values

MARKER_PROTO_MSG

protected static final String MARKER_PROTO_MSG

Message for when the proto is not a X3DShapeNode

See Also:

• Constant Field Values

MARKER_NODE_MSG

protected static final String MARKER_NODE_MSG

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

See Also:

• Constant Field Values

ANNOTATION_PROTO_MSG

protected static final String ANNOTATION_PROTO_MSG

Message for when the proto is not a X3DAnnotationNode

See Also:

• Constant Field Values

ANNOTATION_NODE_MSG

protected static final String ANNOTATION_NODE_MSG

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

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

vfLeadLineStyle

protected VRMLAppearanceChildNodeType vfLeadLineStyle

inputOutput SFNode leadLineStyle NULL

pLeadLineStyle

protected VRMLProtoInstance pLeadLineStyle

Proto version of the leadLineStyle field

vfMarker

protected VRMLShapeNodeType vfMarker

inputOutput SFNode field

pMarker

protected VRMLProtoInstance pMarker

Proto version of the marker field

vfReferencePoint

protected float[] vfReferencePoint

inputOutput SFVec3f referencePoint 0, 0, 0

vfAnnotations

protected VRMLNodeType[] vfAnnotations

inputOutput MFNode annotations

annotationsList

protected List<VRMLNodeType> annotationsList

Temporary array to store the values in during node setup

Constructor Details

BaseAnnotationTarget

public BaseAnnotationTarget()

Create a new, default instance of this class.

BaseAnnotationTarget

public BaseAnnotationTarget(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 - Incorrect Node Type

Method Details

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

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

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

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

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat field type.

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 not in range or not appropriate for this field

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

setValue

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

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field type url.

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 does not fit this type of node

setMarker

protected void setMarker(VRMLNodeType marker)
                  throws InvalidFieldValueException

Set node content as replacement for marker.

Parameters:

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

Throws:

InvalidFieldValueException - The node does not match the required type.

setLeadLineStyle

protected void setLeadLineStyle(VRMLNodeType lineStyle)
                         throws InvalidFieldValueException

Set node content as replacement for lineStyle.

Parameters:

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

Throws:

InvalidFieldValueException - The node does not match the required type.