Package org.web3d.vrml.renderer.ogl.nodes.navigation

Class OGLLOD

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

org.web3d.vrml.renderer.common.nodes.navigation.BaseLOD

org.web3d.vrml.renderer.ogl.nodes.navigation.OGLLOD

All Implemented Interfaces:

org.j3d.aviatrix3d.NodeUpdateListener, VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLGroupingNodeType, VRMLNodeType, VRMLViewDependentNodeType, VRMLWorldRootChildNodeType, OGLVRMLNode

public class OGLLOD
extends BaseLOD
implements OGLVRMLNode, org.j3d.aviatrix3d.NodeUpdateListener

OpenGL-renderer implementation of a LOD node.

Note that we always change right on the suggested LOD ranges, so the forceTransitions field introduced in 3.1 is ignored for our implementation.

Version:

$Revision: 1.14 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.navigation.BaseLOD

FIELD_CENTER, FIELD_FORCE_TRANSITIONS, FIELD_LEVEL_CHANGED, FIELD_RANGE, LAST_LOD_INDEX, NUM_FIELDS, rangeLen, rangeSquared, SECONDARY_TYPE, vfCenter, vfForceTransitions, vfLevelChanged, vfRange

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

childCount, FIELD_ADDCHILDREN, FIELD_BBOX_CENTER, FIELD_BBOX_DISPLAY, FIELD_BBOX_SIZE, FIELD_CHILDREN, FIELD_REMOVECHILDREN, FIELD_VISIBLE, hasBindables, LAST_GROUP_INDEX, shareCount, USE_BIND_MSG, vfBboxCenter, vfBboxDisplay, vfBboxSize, vfChildren, 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

Constructor	Description
OGLLOD()	Construct a default instance of this node.
OGLLOD(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
protected void	addChildNode(VRMLNodeType node)	Add a single child node to the list of available children.
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
protected void	clearChildren()	Clear the child node list of all children - both VRML and OpenGL.
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the OpenGL scene graph object representation of this node.
void	notifyExternProtoLoaded(int index, VRMLNodeType node)	Notify a node that an ExternProto has resolved.
protected void	removeChildNode(VRMLNodeType node)	Remove the given node from this grouping node.
protected void	setCenter(float[] center)	Set the center component of the of transform.
protected void	setRange(float[] range, int numValid)	Set the range to the new series of values.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	updateNodeBoundsChanges(Object src)	Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.
void	updateNodeDataChanges(Object src)	Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.navigation.BaseLOD

getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, getSecondaryType, sendRoute, setLevelChanged, setValue, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

addChild, containsBindableNodes, copy, getBboxCenter, getBboxDisplay, getBboxSize, getChildren, getChildrenSize, getPrimaryType, getVisible, isShared, setBboxCenter, setBboxDisplay, setBboxSize, setChildren, setChildren, setDEF, setShared, setValue, setValue, setVisible, updateRefCount

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, removeNodeListener, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, 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.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Constructor Details

OGLLOD

public OGLLOD()

Construct a default instance of this node. The defaults are set by the VRML specification.

OGLLOD

public OGLLOD(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a group node, an exception will be thrown. It does not copy the children nodes, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the OpenGL scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OGL representation.

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 BaseGroupingNode

allEventsComplete

public void allEventsComplete()

Notification that the rendering of the event model is complete and that rendering is about to begin. Used to update the transformation matrix only once per frame.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

updateNodeBoundsChanges

public void updateNodeBoundsChanges(Object src)

Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.

Specified by:

updateNodeBoundsChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

updateNodeDataChanges

public void updateNodeDataChanges(Object src)

Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Specified by:

updateNodeDataChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

notifyExternProtoLoaded

public void notifyExternProtoLoaded(int index,
 VRMLNodeType node)

Description copied from interface: VRMLNodeType

Notify a node that an ExternProto has resolved. This will verify the objects type and add it to the render sceneGraph.

Specified by:

notifyExternProtoLoaded in interface VRMLNodeType

Overrides:

notifyExternProtoLoaded in class AbstractNode

Parameters:

index - The field index

node - The node resolved

setCenter

protected void setCenter(float[] center)
                  throws InvalidFieldValueException

Set the center component of the of transform. Setting a value of null is an error

Overrides:

setCenter in class BaseLOD

Parameters:

center - The new center component

Throws:

InvalidFieldValueException - The center was null

setRange

protected void setRange(float[] range,
 int numValid)
                 throws InvalidFieldValueException

Set the range to the new series of values. A null value is the same as removing the range altogether.

Overrides:

setRange in class BaseLOD

Parameters:

range - the new range values to use

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

Throws:

InvalidFieldValueException

clearChildren

protected void clearChildren()

Clear the child node list of all children - both VRML and OpenGL.

Overrides:

clearChildren in class BaseGroupingNode

addChildNode

protected void addChildNode(VRMLNodeType node)
                     throws InvalidFieldValueException

Add a single child node to the list of available children. This auto matically deals with DEF/USE and adds links and branchgroups where appropriate. When nodes are null, we do not add them to the GL representation, only to the vfChildren list.

Overrides:

addChildNode in class BaseGroupingNode

Parameters:

node - The node to view

Throws:

InvalidFieldValueException - This is a bindable node shared

removeChildNode

protected void removeChildNode(VRMLNodeType node)
                        throws InvalidFieldValueException

Remove the given node from this grouping node. If the node is not a child of this node, the request is silently ignored.

Overrides:

removeChildNode in class BaseGroupingNode

Parameters:

node - The node to remove

Throws:

InvalidFieldValueException