org.scijava.java3d

Class DepthComponentFloat

java.lang.Object

org.scijava.java3d.SceneGraphObject

org.scijava.java3d.NodeComponent

org.scijava.java3d.DepthComponent

org.scijava.java3d.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 org.scijava.java3d.DepthComponent

ALLOW_DATA_READ, ALLOW_SIZE_READ

Constructor Summary

Constructors

Constructor and Description
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)
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 org.scijava.java3d.DepthComponent

getHeight, getWidth

Methods inherited from class org.scijava.java3d.NodeComponent

cloneNodeComponent, duplicateNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree

Methods inherited from class org.scijava.java3d.SceneGraphObject

clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString, updateNodeReferences

Methods inherited from class java.lang.Object

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

Constructor Detail

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

cloneNodeComponent

public NodeComponent cloneNodeComponent()

Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate)

Overrides:

cloneNodeComponent in class NodeComponent