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

Class BaseScreenMarker

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.marker.BaseScreenMarker

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLExternalNodeType, VRMLNodeType, VRMLSingleExternalNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

OGLScreenMarker

public abstract class BaseScreenMarker
extends AbstractNode
implements VRMLWorldRootChildNodeType, VRMLSingleExternalNodeType

Common implementation of a ScreenMarker node.

Version:

$Revision: 1.5 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BAD_NODE_MSG	Message for when the node in setValue() is not a Child Node
protected static final String	BAD_PROTO_MSG	Message for when the proto is not a Child Node
protected static final int	FIELD_ENABLED	The field index for enabled
protected static final int	FIELD_HEIGHT	The field index for height
protected static final int	FIELD_ICON_URL	The field index for iconUrl
protected static final int	FIELD_REPRESENTS	The field index for represents
protected static final int	FIELD_WIDTH	The field index for width
protected static final int	LAST_SCREENMARKER_INDEX	The last field index used by this class
protected String	loadedURI	The URI of the finally loaded texture.
protected int	loadState	URL Load State
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pRepresents	The proto representation of the "represents" field
protected boolean	vfEnabled	The value of the enabled field
protected float	vfHeight	The value of the height field
protected VRMLChildNodeType	vfRepresents	The value of the "represents" SFNode exposedField
protected String[]	vfURL	exposedField MFString url []
protected float	vfWidth	The value of the width field

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

Fields inherited from interface org.web3d.vrml.nodes.VRMLExternalNodeType

LOAD_COMPLETE, LOAD_FAILED, LOADING, NOT_LOADED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseScreenMarker()	Construct a new default ScreenMarker object
protected	BaseScreenMarker(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	addContentStateListener(VRMLContentStateListener l)	Add a listener to this node instance for the content state changes.
void	addUrlListener(VRMLUrlListener ul)	Add a listener to this node instance.
boolean	checkValidContentType(String mimetype)	Check to see if the given MIME type is one that would be supported as content coming into this node.
protected void	fireContentStateChanged()	Send a notification to the registered listeners that the content state has been changed.
protected void	fireUrlChanged(int index)	Send a notification to the registered listeners that a field has been changed.
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	getLoadState()	Ask the state of the load 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.
String[]	getUrl()	Get the list of URLs requested by this node.
String	getWorldUrl()	Get the world URL so set for this node.
void	removeContentStateListener(VRMLContentStateListener l)	Remove a listener from this node instance for the content state changes.
void	removeUrlListener(VRMLUrlListener ul)	Remove a listener from this node instance.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setContent(String mimetype, Object content)	Set the content of this node to the given object.
protected void	setEnabled(boolean enabled)	Set the sensor enabled or disabled.
protected void	setHeight(float height)	Set the image height scale.
void	setLoadedURI(String uri)	Notify the node which URL was used to load the content.
void	setLoadState(int state)	Set the load state of the node.
protected void	setRepresents(VRMLNodeType node)	Set the node that should be used for the represents field.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setUrl(String[] newURL, int numValid)	Sets the URL to a new value.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of strings.
void	setValue(int index, VRMLNodeType node)	Set the value of the field at the given index as a node.
protected void	setWidth(float width)	Set the image width scale.
void	setWorldUrl(String url)	Set the world URL so that any relative URLs may be corrected to the fully qualified version.

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

Field Details

FIELD_ENABLED

protected static final int FIELD_ENABLED

The field index for enabled

See Also:

• Constant Field Values

FIELD_WIDTH

protected static final int FIELD_WIDTH

The field index for width

See Also:

• Constant Field Values

FIELD_HEIGHT

protected static final int FIELD_HEIGHT

The field index for height

See Also:

• Constant Field Values

FIELD_REPRESENTS

protected static final int FIELD_REPRESENTS

The field index for represents

See Also:

• Constant Field Values

FIELD_ICON_URL

protected static final int FIELD_ICON_URL

The field index for iconUrl

See Also:

• Constant Field Values

LAST_SCREENMARKER_INDEX

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

BAD_PROTO_MSG

protected static final String BAD_PROTO_MSG

Message for when the proto is not a Child Node

See Also:

• Constant Field Values

BAD_NODE_MSG

protected static final String BAD_NODE_MSG

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

See Also:

• Constant Field Values

loadState

protected int loadState

URL Load State

loadedURI

protected String loadedURI

The URI of the finally loaded texture. Null if not loaded yet

vfEnabled

protected boolean vfEnabled

The value of the enabled field

vfWidth

protected float vfWidth

The value of the width field

vfHeight

protected float vfHeight

The value of the height field

vfURL

protected String[] vfURL

exposedField MFString url []

vfRepresents

protected VRMLChildNodeType vfRepresents

The value of the "represents" SFNode exposedField

pRepresents

protected VRMLProtoInstance pRepresents

The proto representation of the "represents" field

Constructor Details

BaseScreenMarker

protected BaseScreenMarker()

Construct a new default ScreenMarker object

BaseScreenMarker

protected BaseScreenMarker(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 - The node is not the same type

Method Details

getLoadState

public int getLoadState()

Ask the state of the load of this node. The value will be one of the constants defined above.

Specified by:

getLoadState in interface VRMLSingleExternalNodeType

Returns:

The current load state of the node

setLoadState

public void setLoadState(int state)

Set the load state of the node. The value must be one of the constants defined above.

Specified by:

setLoadState in interface VRMLSingleExternalNodeType

Parameters:

state - The new state of the node

setWorldUrl

public void setWorldUrl(String url)

Set the world URL so that any relative URLs may be corrected to the fully qualified version. Guaranteed to be non-null.

Specified by:

setWorldUrl in interface VRMLExternalNodeType

Parameters:

url - The world URL.

getWorldUrl

public String getWorldUrl()

Get the world URL so set for this node.

Specified by:

getWorldUrl in interface VRMLExternalNodeType

Returns:

url The world URL.

setUrl

public void setUrl(String[] newURL,
 int numValid)

Sets the URL to a new value. We will load only one of these URL's. The list provides alternates.

Specified by:

setUrl in interface VRMLSingleExternalNodeType

Parameters:

newURL - Array of candidate URL strings

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

getUrl

public String[] getUrl()

Get the list of URLs requested by this node. If there are no URLs supplied in the text file then this will return a zero length array.

Specified by:

getUrl in interface VRMLSingleExternalNodeType

Returns:

The list of URLs to attempt to load

checkValidContentType

public boolean checkValidContentType(String mimetype)

Check to see if the given MIME type is one that would be supported as content coming into this node.

Specified by:

checkValidContentType in interface VRMLSingleExternalNodeType

Parameters:

mimetype - The type to check for

Returns:

true if this is OK, false if not

setContent

public void setContent(String mimetype,
 Object content)
                throws IllegalArgumentException

Set the content of this node to the given object. The object is then cast by the internal representation to the form it needs. This assumes at least some amount of intelligence on the part of the caller, but we also know that we should not pass something dumb to it when we can check what sort of content types it likes to handle. We assume the loader thread is operating in the same context as the one that created the node in the first place and thus knows the general types of items to pass through.

Specified by:

setContent in interface VRMLSingleExternalNodeType

Parameters:

mimetype - The mime type of this object if known

content - The content of the object

Throws:

IllegalArgumentException - The content object is not supported

setLoadedURI

public void setLoadedURI(String uri)

Notify the node which URL was used to load the content. It will be the complete URI with path, query and references parts. This method will be called before setContent.

Specified by:

setLoadedURI in interface VRMLSingleExternalNodeType

Parameters:

uri - The URI used to load this content

addUrlListener

public void addUrlListener(VRMLUrlListener ul)

Add a listener to this node instance. If the listener is already added or null the request is silently ignored.

Specified by:

addUrlListener in interface VRMLExternalNodeType

Parameters:

ul - The listener instance to add

removeUrlListener

public void removeUrlListener(VRMLUrlListener ul)

Remove a listener from this node instance. If the listener is null or not registered, the request is silently ignored.

Specified by:

removeUrlListener in interface VRMLExternalNodeType

Parameters:

ul - The listener to be removed

addContentStateListener

public void addContentStateListener(VRMLContentStateListener l)

Add a listener to this node instance for the content state changes. If the listener is already added or null the request is silently ignored.

Specified by:

addContentStateListener in interface VRMLExternalNodeType

Parameters:

l - The listener instance to add

removeContentStateListener

public void removeContentStateListener(VRMLContentStateListener l)

Remove a listener from this node instance for the content state changes. If the listener is null or not registered, the request is silently ignored.

Specified by:

removeContentStateListener in interface VRMLExternalNodeType

Parameters:

l - The listener to be removed

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

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

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)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a boolean. This is be used to set SFBool field types isActive, enabled and loop.

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)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFFloat 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,
 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 know

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

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

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

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 VRMLNodeType node)
              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

node - The new node to use

Throws:

InvalidFieldException - The index does not match a known field

InvalidFieldValueException - The node does not match the required type.

setEnabled

protected void setEnabled(boolean enabled)

Set the sensor enabled or disabled.

Parameters:

enabled - The new enabled value

setWidth

protected void setWidth(float width)

Set the image width scale.

Parameters:

width - The image width scale.

setHeight

protected void setHeight(float height)

Set the image height scale.

Parameters:

height - The image height scale.

setRepresents

protected void setRepresents(VRMLNodeType node)
                      throws InvalidFieldValueException

Set the node that should be used for the represents field. Setting a value of null will clear the current represents value.

Parameters:

node - The new node instance to be used.

Throws:

InvalidFieldValueException - The node does not match the required type.

fireUrlChanged

protected void fireUrlChanged(int index)

Send a notification to the registered listeners that a field has been changed. If no listeners have been registered, then this does nothing, so always call it regardless.

Parameters:

index - The index of the field that changed

fireContentStateChanged

protected void fireContentStateChanged()

Send a notification to the registered listeners that the content state has been changed. If no listeners have been registered, then this does nothing, so always call it regardless.