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

Class OGLScript

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractDynamicFieldNode

org.web3d.vrml.renderer.common.nodes.scripting.BaseScript

org.web3d.vrml.renderer.ogl.nodes.scripting.OGLScript

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLExternalNodeType, VRMLNodeType, VRMLScriptNodeType, VRMLSingleExternalNodeType, VRMLWorldRootChildNodeType, OGLVRMLNode

public class OGLScript
extends BaseScript
implements OGLVRMLNode

Scene graph representation of a script node.

The script is different to all the other nodes. While it represents a script, it doesn't have the normal content of a Java3D node. It is also a bit different to the ordinary Abstract node implementation in that a script can have fields added and removed on demand.

Version:

$Revision: 1.5 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.scripting.BaseScript

majorVersion, minorVersion

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

BAD_NODE_MSG, errorReporter, FIELD_CLASH_MSG, fieldCount, fieldDeclList, fieldIndexMap, fieldLocalData, inSetup, isVrml97, layerIds, METADATA_NODE_MSG, METADATA_PROTO_MSG, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, vfMetadata

Fields inherited from interface org.web3d.vrml.nodes.VRMLExternalNodeType

LOAD_COMPLETE, LOAD_FAILED, LOADING, NOT_LOADED

Constructor Summary

Constructors

Constructor	Description
OGLScript()	Construct a default instance of the script
OGLScript(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.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.scripting.BaseScript

addContentStateListener, addUrlListener, appendField, checkValidContentType, copy, eventsProcessed, fireContentStateChanged, fireUrlChanged, getExecutionSpace, getFieldValue, getLoadState, getPrimaryType, getSecondaryType, getUrl, getUserData, getWorldUrl, hasFieldChanged, initialize, isDEF, isSetupFinished, notifyExternProtoLoaded, prepareEvents, processEvents, removeContentStateListener, removeUrlListener, sendRoute, setContent, setDEF, setExecutionSpace, setLoadedURI, setLoadState, setupFinished, setUrl, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, setWorldUrl, shutdown, shutdownAll

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

addNodeListener, allEventsComplete, checkNodeType, clearRemovedLayerIds, deleteField, deleteField, fireFieldChanged, getAllFields, getFieldCount, getFieldDeclaration, getFieldIndex, getLayerIds, getMetadataObject, getNodeFieldIndices, getNumFields, getRefCount, getRemovedLayerIds, getVRMLNodeName, isVRML97, removeNodeListener, setErrorReporter, setFrameStateManager, setMetadataObject, updateRefCount

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, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

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

getAllFields, getFieldCount

Constructor Details

OGLScript

public OGLScript()

Construct a default instance of the script

OGLScript

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

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OpenGL representation.