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

Class BaseSurfaceChildNode

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType

Direct Known Subclasses:

BaseImage2D, BaseSurfaceLayoutNode, BaseText2D

public abstract class BaseSurfaceChildNode
extends AbstractNode
implements VRMLSurfaceChildNodeType

Base implementation of any surface child node.

All surface child nodes start with an automatically sized bounding box and are visible.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_BBOX_SIZE	The field index for bboxSize
protected static final int	FIELD_VISIBLE	The field index for visible
protected static final int	LAST_SURFACE_CHILD_INDEX	The last field index used by this class
protected VRMLSurfaceLayoutListener	listener	The listener for resize events
protected boolean	parentVisibility	The visibility state of the parent node.
protected Rectangle	screenBounds	The real bounds of this object
protected float[]	screenLocation	The real position of the overlay in screen coordinates
protected float[]	vfBboxSize	The user-supplied bounding box size field
protected boolean	vfVisible	exposedField SFBool visible

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	BaseSurfaceChildNode(String name)	Construct a new default Overlay object

Method Summary

Modifier and Type	Method	Description
protected void	copy(VRMLSurfaceChildNodeType node)	Set the fields of the overlay child node that has the fields set based on the fields of the passed in node.
protected void	fireSizeChange(int width, int height)	Send an event to the listener with the new size information.
float[]	getBboxSize()	Get the value of the 2D bounding box size of this overlay.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
boolean	getParentVisible()	Request the node's current parent visibility state.
int	getPrimaryType()	Get the primary type of this node.
Rectangle	getRealBounds()	Get the current value of the 2D bounding box of this overlay.
boolean	isVisible()	Get the current visibility state 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	setBboxSize(float[] bbox)	Convenience method to check on the raw value of the bbox to make sure it is OK.
void	setLayoutListener(VRMLSurfaceLayoutListener l)	Set the layout listener for this 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	setParentVisible(boolean state)	Notification from the parent node about this node's visibility state.
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, float[] value, int numValid)	Set the value of the field at the given index as a boolean.
void	setVisible(boolean state)	Set the visibility state of the surface.

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, 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, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_VISIBLE

protected static final int FIELD_VISIBLE

The field index for visible

See Also:

• Constant Field Values

FIELD_BBOX_SIZE

protected static final int FIELD_BBOX_SIZE

The field index for bboxSize

See Also:

• Constant Field Values

LAST_SURFACE_CHILD_INDEX

protected static final int LAST_SURFACE_CHILD_INDEX

The last field index used by this class

See Also:

• Constant Field Values

vfVisible

protected boolean vfVisible

exposedField SFBool visible

screenLocation

protected float[] screenLocation

The real position of the overlay in screen coordinates

vfBboxSize

protected float[] vfBboxSize

The user-supplied bounding box size field

screenBounds

protected Rectangle screenBounds

The real bounds of this object

listener

protected VRMLSurfaceLayoutListener listener

The listener for resize events

parentVisibility

protected boolean parentVisibility

The visibility state of the parent node. Defaults to true

Constructor Details

BaseSurfaceChildNode

protected BaseSurfaceChildNode(String name)

Construct a new default Overlay object

Parameters:

name -

Method Details

copy

protected void copy(VRMLSurfaceChildNodeType node)

Set the fields of the overlay child node that has the fields set based on the fields of the passed in node.

Parameters:

node - The node to copy info from

isVisible

public boolean isVisible()

Get the current visibility state of this node.

Specified by:

isVisible in interface VRMLSurfaceChildNodeType

Returns:

true if the node is current visible, false otherwise

setVisible

public void setVisible(boolean state)

Set the visibility state of the surface. A non-visible surface will still take events and update, just not be rendered.

Specified by:

setVisible in interface VRMLSurfaceChildNodeType

Parameters:

state - true to make this node visible, false to hide

setParentVisible

public void setParentVisible(boolean state)

Notification from the parent node about this node's visibility state. Used to control the rendering so that if a parent is not visible it can inform this node that it is also not visible without needing to stuff with the local visibility state. This implementation does nothing, but derived classes may wish to do something with it.

Specified by:

setParentVisible in interface VRMLSurfaceChildNodeType

Parameters:

state - true to make this node visible, false to hide

getParentVisible

public boolean getParentVisible()

Request the node's current parent visibility state. Mainly used for proto copying.

Specified by:

getParentVisible in interface VRMLSurfaceChildNodeType

Returns:

true if parent visible, false otherwise

getBboxSize

public float[] getBboxSize()

Get the value of the 2D bounding box size of this overlay. The bounds are given in pixel coordinates relative to the center of this overlay. Although the return values are always floats, the values will alway be integer based and will not contain fractional values.

Specified by:

getBboxSize in interface VRMLSurfaceChildNodeType

Returns:

The current bounds

getRealBounds

public Rectangle getRealBounds()

Get the current value of the 2D bounding box of this overlay. The bounds are given in pixel coordinates relative to the top left corner.

Specified by:

getRealBounds in interface VRMLSurfaceChildNodeType

Returns:

The current bounds [x, y, width, height]

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

Parameters:

x - The x location of the window in pixels

y - The y location of the window in pixels

setLayoutListener

public void setLayoutListener(VRMLSurfaceLayoutListener l)

Set the layout listener for this node. Setting a value of null clears the current listener instance.

Specified by:

setLayoutListener in interface VRMLSurfaceChildNodeType

Parameters:

l - The new listener to use or null

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.

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

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,
 float[] value,
 int numValid)
              throws InvalidFieldException

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

fireSizeChange

protected void fireSizeChange(int width,
 int height)

Send an event to the listener with the new size information.

Parameters:

width - The new width to use

height - The new height to use

setBboxSize

public void setBboxSize(float[] bbox)
                 throws InvalidFieldValueException,
InvalidFieldAccessException

Convenience method to check on the raw value of the bbox to make sure it is OK.

Parameters:

bbox - The bounding box to check

Throws:

InvalidFieldValueException - Value out of spec

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now