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

Class BaseGroupLayout

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode

org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceLayoutNode

org.web3d.vrml.renderer.common.nodes.surface.BaseGroupLayout

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType, VRMLSurfaceLayoutListener, VRMLSurfaceLayoutNodeType

Direct Known Subclasses:

NRGroupLayout

public abstract class BaseGroupLayout
extends BaseSurfaceLayoutNode

Common implementation of a GroupLayout node.

A group layout is a container for allowing the use of more than one child layout. Typically used to group a bunch of BorderLayouts together under the Overlay node. It has no additional properties beyond the simple layout capabilities.

Version:

$Revision: 1.5 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	NUM_FIELDS	Number of fields constant

Fields inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceLayoutNode

BAD_NODE_MSG, BAD_PROTO_MSG, FIELD_CHILDREN, LAST_LAYOUT_INDEX, vfChildren

Fields inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode

FIELD_BBOX_SIZE, FIELD_VISIBLE, LAST_SURFACE_CHILD_INDEX, listener, parentVisibility, screenBounds, screenLocation, vfBboxSize, vfVisible

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	BaseGroupLayout()	Construct a new default Overlay object
protected	BaseGroupLayout(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.
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.
void	setLocation(int x, int y)	Tell this overlay that it's position in window coordinates has been changed to this new value.
void	setupFinished()	Notification that the construction phase of this node has finished.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceLayoutNode

appendNode, getChildren, getFieldValue, getPrimaryType, sendRoute, setChildren, setParentVisible, setValue, setValue, setVisible, surfaceResized, updateManagedNodes, windowChanged

Methods inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode

copy, fireSizeChange, getBboxSize, getParentVisible, getRealBounds, isVisible, setBboxSize, setLayoutListener, setValue, setValue

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

Methods inherited from interface org.web3d.vrml.nodes.VRMLSurfaceChildNodeType

getBboxSize, getParentVisible, getRealBounds, isVisible, setLayoutListener

Field Details

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

Constructor Details

BaseGroupLayout

protected BaseGroupLayout()

Construct a new default Overlay object

BaseGroupLayout

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

setLocation

public void setLocation(int x,
 int y)

Tell this overlay that it's position in window coordinates has been changed to this new value. The position is always that of the top-left corner of the bounding box in screen coordinate space.

Specified by:

setLocation in interface VRMLSurfaceChildNodeType

Overrides:

setLocation in class BaseSurfaceChildNode

Parameters:

x - The x location of the window in pixels

y - The y location of the window in pixels

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 BaseSurfaceLayoutNode

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.

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.

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.

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.

Returns:

The number of fields.