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

Class OGLTextureBackground

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseBindableNode

org.web3d.vrml.renderer.common.nodes.enveffects.BaseTextureBackground

org.web3d.vrml.renderer.ogl.nodes.enveffects.OGLTextureBackground

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBackgroundNodeType, VRMLBindableNodeType, VRMLChildNodeType, VRMLNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType, OGLBackgroundNodeType, OGLVRMLNode

public class OGLTextureBackground
extends BaseTextureBackground
implements OGLBackgroundNodeType

OGL implementation of a Background node

Version:

$Revision: 1.5 $

Author:

Alan Hudson

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.enveffects.BaseTextureBackground

BACK, BOTTOM, EMPTY_LIST, FIELD_BACK_TEXTURE, FIELD_BOTTOM_TEXTURE, FIELD_FRONT_TEXTURE, FIELD_GROUND_ANGLE, FIELD_GROUND_COLOR, FIELD_LEFT_TEXTURE, FIELD_RIGHT_TEXTURE, FIELD_SKY_ANGLE, FIELD_SKY_COLOR, FIELD_TOP_TEXTURE, FIELD_TRANSPARENCY, FRONT, GROUND_SPHERE, LAST_BACKGROUND_INDEX, LEFT, NUM_BG_OBJECTS, NUM_FIELDS, numGroundAngle, numGroundColor, numSkyAngle, numSkyColor, RIGHT, SKY_SPHERE, TOP, vfBackTexture, vfBottomTexture, vfFrontTexture, vfGroundAngle, vfGroundColor, vfLeftTexture, vfRightTexture, vfSkyAngle, vfSkyColor, vfTopTexture, vfTransparency

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

FIELD_BIND, FIELD_BIND_TIME, FIELD_IS_BOUND, isOnStack, LAST_BINDABLE_INDEX, vfBindTime, vfIsBound

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
OGLTextureBackground()	Default constructor for a OGLTextureBackground
OGLTextureBackground(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.Texture2D[]	getBackgroundTextures()	Get the list of textures defined for this background.
boolean	getChangedTextures(org.j3d.aviatrix3d.Texture2D[] textures, boolean[] changes)	Get the list of textures defined for this background that have changed since the last frame.
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the OGL scene graph object representation of this node.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.enveffects.BaseTextureBackground

getFieldDeclaration, getFieldIndex, getFieldValue, getGroundValues, getNodeFieldIndices, getNumFields, getNumGroundColors, getNumSkyColors, getPrimaryType, getSecondaryType, getSkyValues, getTransparency, sendRoute, setTransparency, setValue, setValue, setValue, setValue

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

addBindableNodeListener, copy, fireIsBoundChanged, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack, setValue, setVRMLClock

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, 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.nodes.VRMLBackgroundNodeType

getGroundValues, getNumGroundColors, getNumSkyColors, getSkyValues, getTransparency, setTransparency

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

addBindableNodeListener, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack

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

Constructor Details

OGLTextureBackground

public OGLTextureBackground()

Default constructor for a OGLTextureBackground

OGLTextureBackground

public OGLTextureBackground(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the right type.

Method Details

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the OGL 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 null representation.

getChangedTextures

public boolean getChangedTextures(org.j3d.aviatrix3d.Texture2D[] textures,
 boolean[] changes)

Get the list of textures defined for this background that have changed since the last frame. The array contains the textures in the order back, front, left, right, top, bottom. If the texture hasn't changed is or no texture defined, then that array element is null.

Specified by:

getChangedTextures in interface OGLBackgroundNodeType

Parameters:

textures - The list of textures that have changed for this background.

changes - An array to copy in the flags of the individual textures that have changed

Returns:

true if anything changed since the last time

getBackgroundTextures

public org.j3d.aviatrix3d.Texture2D[] getBackgroundTextures()

Get the list of textures defined for this background. The array contains the textures in the order front, back, left, right, top, bottom. If there is no texture defined, then that array element is null.

Specified by:

getBackgroundTextures in interface OGLBackgroundNodeType

Returns:

The list of textures for this background.