org.scijava.java3d

Class DecalGroup

java.lang.Object

org.scijava.java3d.SceneGraphObject

org.scijava.java3d.Node

org.scijava.java3d.Group

org.scijava.java3d.OrderedGroup

org.scijava.java3d.DecalGroup

public class DecalGroup
extends OrderedGroup

The DecalGroup node is an ordered group node used for defining decal geometry on top of other geometry. The DecalGroup node specifies that its children should be rendered in index order and that they generate coplanar objects. Examples of this include: painted decals or text on surfaces, a checkerboard layered on top of a table, etc.

The first child, at index 0, defines the surface on top of which all other children are rendered. The geometry of this child must encompass all other children, otherwise incorrect rendering may result. The polygons contained within each of the children must be facing the same way. If the polygons defined by the first child are front facing, then all other surfaces should be front facing. In this case, the polygons are rendered in order. The renderer can use knowledge of the coplanar nature of the surfaces to avoid Z-buffer collisions. If the main surface is back facing then all other surfaces should be back facing, and need not be rendered (even if back face culling is disabled).

Note that using the DecalGroup node does not guarantee that Z-buffer collisions are avoided. An implementation of Java 3D may fall back to treating DecalGroup node as an OrderedGroup node.

Field Summary

Fields inherited from class org.scijava.java3d.OrderedGroup

ALLOW_CHILD_INDEX_ORDER_READ, ALLOW_CHILD_INDEX_ORDER_WRITE

Fields inherited from class org.scijava.java3d.Group

ALLOW_CHILDREN_EXTEND, ALLOW_CHILDREN_READ, ALLOW_CHILDREN_WRITE, ALLOW_COLLISION_BOUNDS_READ, ALLOW_COLLISION_BOUNDS_WRITE

Fields inherited from class org.scijava.java3d.Node

ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

Constructors

Constructor and Description
DecalGroup() Constructs and initializes a new DecalGroup node object.

Method Summary

Methods

Modifier and Type	Method and Description
Node	cloneNode(boolean forceDuplicate) Used to create a new instance of the node.

Methods inherited from class org.scijava.java3d.OrderedGroup

addChild, addChild, getChildIndexOrder, insertChild, moveTo, removeAllChildren, removeChild, removeChild, setChildIndexOrder

Methods inherited from class org.scijava.java3d.Group

getAllChildren, getAlternateCollisionTarget, getChild, getCollisionBounds, indexOfChild, numChildren, setAlternateCollisionTarget, setChild, setCollisionBounds

Methods inherited from class org.scijava.java3d.Node

cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

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

DecalGroup

public DecalGroup()

Constructs and initializes a new DecalGroup node object.

Method Detail

cloneNode

public Node cloneNode(boolean forceDuplicate)

Used to create a new instance of the node. This routine is called by cloneTree to duplicate the current node.

Overrides:

cloneNode in class OrderedGroup

Parameters:

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(), Node.cloneNode(boolean), Node.duplicateNode(org.scijava.java3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)