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

Class OGLClipPlane

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.render.BaseClipPlane

org.web3d.vrml.renderer.ogl.nodes.render.OGLClipPlane

All Implemented Interfaces:

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

public class OGLClipPlane
extends BaseClipPlane
implements OGLVRMLNode, org.j3d.aviatrix3d.NodeUpdateListener

Null renderer implementation of a ClipPlane node.

This node is purely informational within the scene graph. It does not have a renderable representation.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.render.BaseClipPlane

vfEnabled, vfPlane

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
OGLClipPlane()	Construct a default node with an empty info array any the title set to the empty string.
OGLClipPlane(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the OpenGL scene graph object representation of this node.
protected void	setEnabled(boolean state)	Set a new state for the enabled field.
protected void	setPlane(double[] equation)	Set a the new plane equation 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.render.BaseClipPlane

getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, getPrimaryType, sendRoute, 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, 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, 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, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Constructor Details

OGLClipPlane

public OGLClipPlane()

Construct a default node with an empty info array any the title set to the empty string.

OGLClipPlane

public OGLClipPlane(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

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.

setEnabled

protected void setEnabled(boolean state)

Set a new state for the enabled field.

Overrides:

setEnabled in class BaseClipPlane

Parameters:

state - True if this sensor is to be enabled

setPlane

protected void setPlane(double[] equation)
                 throws InvalidFieldValueException

Set a the new plane equation values. This is a 4-dimensional vector indicating the valid half-space for the plane.

Overrides:

setPlane in class BaseClipPlane

Parameters:

equation - The new values for the equation

Throws:

InvalidFieldValueException - The first 3 components of the field do not describe a unit vector

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. Default implementation returns null.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OpenGL 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 AbstractNode