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

Class BaseXYLayout

java.lang.Object

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

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType, VRMLSurfaceLayoutListener, VRMLSurfaceLayoutNodeType

Direct Known Subclasses:

NRXYLayout

public abstract class BaseXYLayout
extends BaseSurfaceLayoutNode

Common implementation of a XYLayout node.

An XY layout places its children in relative positions to its layout location. So a position of 0,64 would place the child 64 units down from the layout 0,0.

Version:

$Revision: 1.2 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_POSITIONS	The field index for horizontalAlign.
protected static final int	LAST_XY_LAYOUT_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected int	numPositions	Number of valid values in vfPositions
protected float[]	vfPositions	The value of the positions field.

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

BAD_NODE_MSG, BAD_PROTO_MSG, FIELD_CHILDREN, LAST_LAYOUT_INDEX, vfChildren

Fields inherited from class org.web3d.vrml.renderer.common.nodes.layout.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	BaseXYLayout()	Construct a new default Overlay object
protected	BaseXYLayout(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.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
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.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as a float.
protected void	updateManagedNodes()	Convenience method to update the children node(s) to the new positions.

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

appendNode, getChildren, getPrimaryType, setChildren, setParentVisible, setValue, setValue, setVisible, surfaceResized, windowChanged

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

copy, fireSizeChange, getBboxSize, getParentVisible, getRealBounds, isVisible, setBboxSize, setLayoutListener, 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, updateRefCount

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

getBboxSize, getParentVisible, getRealBounds, isVisible, setLayoutListener

Field Details

FIELD_POSITIONS

protected static final int FIELD_POSITIONS

The field index for horizontalAlign.

See Also:

• Constant Field Values

LAST_XY_LAYOUT_INDEX

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

vfPositions

protected float[] vfPositions

The value of the positions field.

numPositions

protected int numPositions

Number of valid values in vfPositions

Constructor Details

BaseXYLayout

protected BaseXYLayout()

Construct a new default Overlay object

BaseXYLayout

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

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.

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 BaseSurfaceLayoutNode

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 BaseSurfaceLayoutNode

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

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 BaseSurfaceChildNode

Parameters:

index - The index of destination field to set

value - The new value to use for the field

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

Throws:

InvalidFieldException - The field index is not known

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

updateManagedNodes

protected void updateManagedNodes()

Convenience method to update the children node(s) to the new positions. The position may have changed because the window size changed, or the alignment fractions have changed. Derived classes may override this method but should call this as well to make sure the correct values are updated.

Overrides:

updateManagedNodes in class BaseSurfaceLayoutNode