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

Class BaseLayer2D

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.layout.BaseLayer2D

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLLayerNodeType, VRMLNodeType

Direct Known Subclasses:

NRLayer2D

public abstract class BaseLayer2D
extends AbstractNode
implements VRMLLayerNodeType

Common implementation of an Layer2D node.

The basic definition of Layer2D is:

 Layer2D : X3DLayerNode {
   SFNode  [in,out] layout             []    [X3DLayoutChildNode]
   SFBool  [in,out] isPickable         TRUE
   SFNode  [in,out] metadata           NULL  [X3DMetadataObject]
   SFVec2f [out]    windowSizeChanged  NULL  [X3DMetadataObject]
   SFNode  []       viewport           NULL  [X3DViewportNode]
 }
 

Layout is always relative to the size of the viewport, not the full screen.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_IS_PICKABLE	The field index for the isPickable field
protected static final int	FIELD_LAYOUT	The field index for layout
protected static final int	FIELD_VIEWPORT	The field index for the viewport node field
protected static final int	FIELD_WINDOW_SIZE_CHANGED	The field index for windowSizeChanged
protected static final int	LAST_LAYER_INDEX	The last field index used by this class
protected int	layerId	The Id of this layer
protected List<LayerListener>	layerListeners	List of those who want to know about role changes, likely 1
protected static final String	LAYOUT_NODE_MSG	Message for when the node in setValue() is not a Appearance
protected static final String	LAYOUT_PROTO_MSG	Message for when the proto is not a Appearance
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pLayout	The proto representation of the the layout field
protected VRMLProtoInstance	pViewport	Proto version of the viewport
protected boolean	vfIsPickable	exposedField SFBool isPickable true
protected VRMLSurfaceLayoutNodeType	vfLayout	The value of the layout SFNode exposedField
protected VRMLViewportNodeType	vfViewport	SFNode viewport.
protected float[]	vfWindowSize	The value of the windowSizeChanged eventOut
protected static final String	VIEWPORT_NODE_MSG	Message for when the node in setValue() is not a viewport
protected static final String	VIEWPORT_PROTO_MSG	Message for when the proto is not a viewport

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	BaseLayer2D()	Construct a new default Layer2D object
protected	BaseLayer2D(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	addLayerListener(LayerListener listener)	Add a listener for layer state changes.
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	getLayerId()	Get the ID of this layer.
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.
VRMLNodeType	getViewport()	Fetch the viewport node instance that this layer currently has.
int	getViewportType()	Get the type of viewport layout policy that the contained viewport node represents.
boolean	isPickable()	See if this layer is currently pickable.
void	removeLayerListener(LayerListener listener)	Removed a listener for layer state changes.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setLayerId(int id)	Set the ID of this layer.
protected void	setLayout(VRMLNodeType layout)	Set the layout to the new value.
void	setPickable(boolean enable)	Set the value of the isPickable field.
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 a boolean.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setViewport(VRMLNodeType vp)	Set the viewport node instance used to control the size of screen real estate to use for this layer.
void	surfaceSizeChanged(int width, int height)	Notification that the area allocated to the surface has changed.

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

Field Details

FIELD_WINDOW_SIZE_CHANGED

protected static final int FIELD_WINDOW_SIZE_CHANGED

The field index for windowSizeChanged

See Also:

• Constant Field Values

FIELD_LAYOUT

protected static final int FIELD_LAYOUT

The field index for layout

See Also:

• Constant Field Values

FIELD_IS_PICKABLE

protected static final int FIELD_IS_PICKABLE

The field index for the isPickable field

See Also:

• Constant Field Values

FIELD_VIEWPORT

protected static final int FIELD_VIEWPORT

The field index for the viewport node field

See Also:

• Constant Field Values

LAST_LAYER_INDEX

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

LAYOUT_PROTO_MSG

protected static final String LAYOUT_PROTO_MSG

Message for when the proto is not a Appearance

See Also:

• Constant Field Values

LAYOUT_NODE_MSG

protected static final String LAYOUT_NODE_MSG

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

See Also:

• Constant Field Values

VIEWPORT_PROTO_MSG

protected static final String VIEWPORT_PROTO_MSG

Message for when the proto is not a viewport

See Also:

• Constant Field Values

VIEWPORT_NODE_MSG

protected static final String VIEWPORT_NODE_MSG

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

See Also:

• Constant Field Values

vfIsPickable

protected boolean vfIsPickable

exposedField SFBool isPickable true

vfWindowSize

protected float[] vfWindowSize

The value of the windowSizeChanged eventOut

vfLayout

protected VRMLSurfaceLayoutNodeType vfLayout

The value of the layout SFNode exposedField

pLayout

protected VRMLProtoInstance pLayout

The proto representation of the the layout field

pViewport

protected VRMLProtoInstance pViewport

Proto version of the viewport

vfViewport

protected VRMLViewportNodeType vfViewport

SFNode viewport.

layerId

protected int layerId

The Id of this layer

layerListeners

protected List<LayerListener> layerListeners

List of those who want to know about role changes, likely 1

Constructor Details

BaseLayer2D

protected BaseLayer2D()

Construct a new default Layer2D object

BaseLayer2D

protected BaseLayer2D(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

addLayerListener

public void addLayerListener(LayerListener listener)

Add a listener for layer state changes. Duplicates will be ignored.

Specified by:

addLayerListener in interface VRMLLayerNodeType

Parameters:

listener - The listener

removeLayerListener

public void removeLayerListener(LayerListener listener)

Removed a listener for layer state changes.

Specified by:

removeLayerListener in interface VRMLLayerNodeType

Parameters:

listener - The listener

isPickable

public boolean isPickable()

See if this layer is currently pickable.

Specified by:

isPickable in interface VRMLLayerNodeType

Returns:

true if the contents of this layer can be picked

setPickable

public void setPickable(boolean enable)

Set the value of the isPickable field.

Specified by:

setPickable in interface VRMLLayerNodeType

Parameters:

enable - true if the contents of this layer can be picked

setViewport

public void setViewport(VRMLNodeType vp)
                 throws InvalidFieldValueException,
InvalidFieldAccessException

Set the viewport node instance used to control the size of screen real estate to use for this layer. The node type passed in should be an instance of VRMLViewportNodeType or a proto wrapper thereof.

Specified by:

setViewport in interface VRMLLayerNodeType

Parameters:

vp - The viewport node instance to use or null to clear

Throws:

InvalidFieldValueException - The node is not a viewport node type

InvalidFieldAccessException - Attempting to write to the field after the setup is complete

getViewport

public VRMLNodeType getViewport()

Fetch the viewport node instance that this layer currently has. If no instance is used, returns null.

Specified by:

getViewport in interface VRMLLayerNodeType

Returns:

The current node instance

getViewportType

public int getViewportType()

Get the type of viewport layout policy that the contained viewport node represents. This is a shortcut to fetching the viewport instance directly, walking the proto heirarchy and so forth.

This determines how the viewport is managed by the system during window resizes etc. It is a fixed value that never changes for the node implementation.

If no viewport node is defined, return VIEWPORT_FULLWINDOW.

If no viewport is yet referenced courtesy of an externproto, this returns VIEWPORT_UNDEFINED until it is updated.

Specified by:

getViewportType in interface VRMLLayerNodeType

Returns:

One of the VIEWPORT_* constant values

setLayerId

public void setLayerId(int id)

Set the ID of this layer. The layer should pass this down to all contained geometry through the updateRefCount() method. This method should only ever be called once, when just after construction.

Specified by:

setLayerId in interface VRMLLayerNodeType

Parameters:

id - The id of this layer

getLayerId

public int getLayerId()

Get the ID of this layer. If none has been set, it should return a value of -1.

Specified by:

getLayerId in interface VRMLLayerNodeType

Returns:

The ID of this layer or -1 if not yet set

surfaceSizeChanged

public void surfaceSizeChanged(int width,
 int height)

Notification that the area allocated to the surface has changed. The new size in pixels is given.

Parameters:

width - The width of the surface in pixels

height - The height of the surface in pixels

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

Set the value of the field at the given index as a 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

Throws:

InvalidFieldException - The field index is not know

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException

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:

InvalidFieldException - The field index is not know

setLayout

protected void setLayout(VRMLNodeType layout)
                  throws InvalidFieldValueException

Set the layout to the new value. Setting a value of null will clear the current layout and leave nothing visible on-screen. The node provided must be either VRMLSurfaceLayoutNodeType or VRMLProtoInstance.

Parameters:

layout - The new layout to use

Throws:

InvalidFieldValueException - The nodes are not one of the required types.