javax.media.j3d

Class DepthComponentFloat

java.lang.Object

javax.media.j3d.SceneGraphObject

javax.media.j3d.NodeComponent

javax.media.j3d.DepthComponent

javax.media.j3d.DepthComponentFloat

public class DepthComponentFloat
extends DepthComponent

A 2D array of depth (Z) values in floating point format in the range [0,1]. A value of 0.0 indicates the closest Z value to the user while a value of 1.0 indicates the farthest Z value.

Field Summary

Fields inherited from class javax.media.j3d.DepthComponent

ALLOW_DATA_READ, ALLOW_SIZE_READ

Fields inherited from class javax.media.j3d.NodeComponent

forceDuplicate

Fields inherited from class javax.media.j3d.SceneGraphObject

nodeHashtable, retained

Constructor Summary

Constructors

Constructor and Description
DepthComponentFloat() Package scope defualt constructor used by cloneNodeComponent
DepthComponentFloat(int width, int height) Constructs a new floating-point depth (z-buffer) component object with the specified width and height.

Method Summary

Methods

Modifier and Type	Method and Description
NodeComponent	cloneNodeComponent() Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate)
(package private) void	createRetained() Creates a retained mode DepthComponentFloatRetained object that this DepthComponentFloat component object will point to.
(package private) void	duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate) Copies all node information from originalNodeComponent into the current node.
void	getDepthData(float[] depthData) Copies the depth data from this object to the specified array.
void	setDepthData(float[] depthData) Copies the specified depth data to this object.

Methods inherited from class javax.media.j3d.DepthComponent

getHeight, getWidth

Methods inherited from class javax.media.j3d.NodeComponent

checkDuplicateNodeComponent, cloneNodeComponent, duplicateChild, duplicateNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree, validateImageIllegalSharing

Methods inherited from class javax.media.j3d.SceneGraphObject

capabilityBitsEmpty, checkForLiveOrCompiled, clearCapability, clearCapabilityIsFrequent, clearLive, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getNamePrefix, getNodeComponent, getUserData, isCompiled, isLive, isLiveOrCompiled, setCapability, setCapabilityIsFrequent, setCompiled, setDefaultReadCapabilities, setLive, setName, setUserData, toString, updateNodeReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DepthComponentFloat

DepthComponentFloat()

Package scope defualt constructor used by cloneNodeComponent

DepthComponentFloat

public DepthComponentFloat(int width,
                   int height)

Constructs a new floating-point depth (z-buffer) component object with the specified width and height.

Parameters:

width - the width of the array of depth values

height - the height of the array of depth values

Method Detail

setDepthData

public void setDepthData(float[] depthData)

Copies the specified depth data to this object.

Parameters:

depthData - array of floats containing the depth data

Throws:

RestrictedAccessException - if the method is called when this object is part of live or compiled scene graph.

getDepthData

public void getDepthData(float[] depthData)

Copies the depth data from this object to the specified array. The array must be large enough to hold all of the floats.

Parameters:

depthData - array of floats that will receive a copy of the depth data

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

createRetained

void createRetained()

Creates a retained mode DepthComponentFloatRetained object that this DepthComponentFloat component object will point to.

Overrides:

createRetained in class NodeComponent

cloneNodeComponent

public NodeComponent cloneNodeComponent()

Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate)

Overrides:

cloneNodeComponent in class NodeComponent

duplicateAttributes

void duplicateAttributes(NodeComponent originalNodeComponent,
                       boolean forceDuplicate)

Copies all node information from originalNodeComponent into the current node. This method is called from the duplicateNode method. This routine does the actual duplication of all "local data" (any data defined in this object).

Overrides:

duplicateAttributes in class NodeComponent

Parameters:

originalNodeComponent - the original node to duplicate.

forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.

See Also:

Node.cloneTree(), NodeComponent.setDuplicateOnCloneTree(boolean)