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

Class BaseAnnotation

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAnnotationNodeType, VRMLChildNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

public abstract class BaseAnnotation
extends AbstractNode
implements VRMLAnnotationNodeType

Common base class for all the AnnotationNodeType implementations.

The base X3D node definition is:

 X3DAnnotationNode : X3DChildNode {
   SFString [in,out] annotationGroupID ""
   SFString [in,out] displayPolicy     "NEVER"  ["POINTER_OVER", "POINTER_ACTIVATE", "ALWAYS", "WHEN_VISIBLE", "NEVER"]
   SFBool   [in,out] enabled           TRUE
   SFNode   [in,out] metadata          NULL     [X3DMetadataObject]
 }
 

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ANNOTATION_GROUP_ID	Index of the annotations field
protected static final int	FIELD_DISPLAY_POLICY	Index of the leadLineStyle field
protected static final int	FIELD_ENABLED	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	POLICY_NEVER	Display Policy is NEVER
protected String	vfAnnotationGroupID	inputOutput SFVec3f referencePoint 0, 0, 0
protected String	vfDisplayPolicy	inputOutput MFNode annotations
protected boolean	vfEnabled	Temporary array to store the values in during node setup

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	BaseAnnotation(String name)	Create a new, default instance of this class.
	BaseAnnotation(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
String	getAnnotationGroupID()	Get the current annotation group ID.
String	getDisplayPolicy()	Get the policy for when this annotation should be displayed.
boolean	getEnabled()	Get current value of the enabled field.
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	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.
void	setAnnotationGroupID(String id)	Set the annotation group ID field to the new value.
void	setDisplayPolicy(String policy)	Set the display policy field to the new value.
void	setEnabled(boolean state)	Set a new enabled state for the annotation.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.

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, setupFinished, setUserData, setValue, setValue, 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

getFieldDeclaration, getNumFields, 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, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_ANNOTATION_GROUP_ID

protected static final int FIELD_ANNOTATION_GROUP_ID

Index of the annotations field

See Also:

• Constant Field Values

FIELD_DISPLAY_POLICY

protected static final int FIELD_DISPLAY_POLICY

Index of the leadLineStyle field

See Also:

• Constant Field Values

FIELD_ENABLED

protected static final int FIELD_ENABLED

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

POLICY_NEVER

protected static final String POLICY_NEVER

Display Policy is NEVER

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

vfAnnotationGroupID

protected String vfAnnotationGroupID

inputOutput SFVec3f referencePoint 0, 0, 0

vfDisplayPolicy

protected String vfDisplayPolicy

inputOutput MFNode annotations

vfEnabled

protected boolean vfEnabled

Temporary array to store the values in during node setup

Constructor Details

BaseAnnotation

protected BaseAnnotation(String name)

Create a new, default instance of this class.

Parameters:

name - name of this new BaseAnnotation

BaseAnnotation

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

getAnnotationGroupID

public String getAnnotationGroupID()

Get the current annotation group ID. If there is none set, this will return an empty string.

Specified by:

getAnnotationGroupID in interface VRMLAnnotationNodeType

Returns:

A string representing the group ID

setAnnotationGroupID

public void setAnnotationGroupID(String id)

Set the annotation group ID field to the new value. A null value or zero length string will be treated as clearing the current value.

Specified by:

setAnnotationGroupID in interface VRMLAnnotationNodeType

Parameters:

id - The new ID string to use

setEnabled

public void setEnabled(boolean state)

Set a new enabled state for the annotation.

Specified by:

setEnabled in interface VRMLAnnotationNodeType

Parameters:

state - The new enabled value

getEnabled

public boolean getEnabled()

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

Specified by:

getEnabled in interface VRMLAnnotationNodeType

Returns:

The value of the enabled field

getDisplayPolicy

public String getDisplayPolicy()

Get the policy for when this annotation should be displayed. The default value is "NEVER".

Specified by:

getDisplayPolicy in interface VRMLAnnotationNodeType

Returns:

A string representing the current display policy

setDisplayPolicy

public void setDisplayPolicy(String policy)
                      throws InvalidFieldValueException

Set the display policy field to the new value. The field must be a valid string from the collection described in the class overview documentation. Null values are treated as an error.

Specified by:

setDisplayPolicy in interface VRMLAnnotationNodeType

Parameters:

policy - The new display policy to use

Throws:

InvalidFieldValueException

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

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

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