javax.media.j3d
Class TransformGroup

java.lang.Object
  |
  +--javax.media.j3d.SceneGraphObject
        |
        +--javax.media.j3d.Node
              |
              +--javax.media.j3d.Group
                    |
                    +--javax.media.j3d.TransformGroup

public class TransformGroup

extends Group

Group node that contains a transform.

Field Summary

static int	ALLOW_TRANSFORM_READ Specifies that the node allows access to its object's transform information.
static int	ALLOW_TRANSFORM_WRITE Specifies that the node allows writing its object's transform information.

Fields inherited from class javax.media.j3d.Group

ALLOW_CHILDREN_EXTEND, ALLOW_CHILDREN_READ, ALLOW_CHILDREN_WRITE, ALLOW_COLLISION_BOUNDS_READ, ALLOW_COLLISION_BOUNDS_WRITE

Fields inherited from class javax.media.j3d.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_PICK, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

TransformGroup()
Constructs and initializes a TransformGroup using an identity transform.

TransformGroup(Transform3D t1)
Constructs and initializes a TransformGroup from the Transform passed.

Method Summary

Node	cloneNode(boolean forceDuplicate) Creates a new instance of the node.
void	duplicateNode(Node originalNode, boolean forceDuplicate) Copies all node information from originalNode into the current node.
void	getTransform(Transform3D t1) Copies the transform component of this TransformGroup into the passed transform object.
void	setTransform(Transform3D t1) Sets the transform component of this TransformGroup to the value of the passed transform.

Methods inherited from class javax.media.j3d.Group

addChild, getAllChildren, getAlternateCollisionTarget, getChild, getCollisionBounds, insertChild, moveTo, numChildren, removeChild, setAlternateCollisionTarget, setChild, setCollisionBounds

Methods inherited from class javax.media.j3d.Node

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

Methods inherited from class javax.media.j3d.SceneGraphObject

clearCapability, duplicateSceneGraphObject, getCapability, getUserData, isCompiled, isLive, setCapability, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_TRANSFORM_READ

public static final int ALLOW_TRANSFORM_READ

Specifies that the node allows access to its object's transform information.

ALLOW_TRANSFORM_WRITE

public static final int ALLOW_TRANSFORM_WRITE

Specifies that the node allows writing its object's transform information.

Constructor Detail

TransformGroup

public TransformGroup()

Constructs and initializes a TransformGroup using an identity transform.

TransformGroup

public TransformGroup(Transform3D t1)

Constructs and initializes a TransformGroup from the Transform passed.

Parameters:

t1 - the transform3D object

Throws:

BadTransformException - if the transform is not affine.

Method Detail

setTransform

public final void setTransform(Transform3D t1)

Sets the transform component of this TransformGroup to the value of the passed transform.

Parameters:

t1 - the transform to be copied.

Throws:

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

BadTransformException - if the transform is not affine.

getTransform

public final void getTransform(Transform3D t1)

Copies the transform component of this TransformGroup into the passed transform object.

Parameters:

t1 - the transform object to be copied into.

Throws:

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

cloneNode

public Node cloneNode(boolean forceDuplicate)

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

Overrides:

cloneNode in class Group

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(javax.media.j3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)

duplicateNode

public void duplicateNode(Node originalNode,
                          boolean forceDuplicate)

Copies all node information from originalNode into the current node. This method is called from the cloneNode method which is, in turn, called by the cloneTree method.

For any NodeComponent objects contained by the object being duplicated, each NodeComponent object's duplicateOnCloneTree value is used to determine whether the NodeComponent should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting the forceDuplicate parameter in the cloneTree method to true.

Overrides:

duplicateNode in class Group

Parameters:

originalNode - 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:

Group.cloneNode(boolean), Node.duplicateNode(javax.media.j3d.Node, boolean), Node.cloneTree(), NodeComponent.setDuplicateOnCloneTree(boolean)