edu.umd.cs.jazz
Class ZConstraintGroup

java.lang.Object
  |
  +--edu.umd.cs.jazz.ZSceneGraphObject
        |
        +--edu.umd.cs.jazz.ZNode
              |
              +--edu.umd.cs.jazz.ZGroup
                    |
                    +--edu.umd.cs.jazz.ZTransformGroup
                          |
                          +--edu.umd.cs.jazz.ZConstraintGroup

All Implemented Interfaces:

java.io.Serializable, ZSerializable, ZTransformable

Direct Known Subclasses:

ZStickyGroup

public class ZConstraintGroup

extends ZTransformGroup

implements java.io.Serializable

ZConstraintGroup is a transform group node that supports the application of a simple constraint to its children. Sub-classes must override the @link{#getTransform} and @link{#getTransformField} methods of @link{ZTransformGroup} to define the new transform. This class stores a reference to a camera so, for example, a sub-class could define a constraint dependent on the camera so that the children move whenever the camera view changes.

See Also:

Serialized Form

Field Summary

protected ZCamera

camera The camera the constraint is related to

Fields inherited from class edu.umd.cs.jazz.ZGroup

childrenFindable_DEFAULT, childrenPickable_DEFAULT, hasOneChild_DEFAULT

Fields inherited from class edu.umd.cs.jazz.ZNode

findable_DEFAULT, listenerList, pickable_DEFAULT, savable_DEFAULT

Fields inherited from class edu.umd.cs.jazz.ZSceneGraphObject

bounds, objRefTable, volatileBounds_DEFAULT

Constructor Summary

ZConstraintGroup()
Constructs a new constraint group.

ZConstraintGroup(ZCamera camera)
Constructs a new constraint group with a specified camera.

ZConstraintGroup(ZCamera camera, ZNode child)
Constructs a new constraint group with a specified camera that decorates the specified child.

ZConstraintGroup(ZNode child)
Constructs a new constraint group that decorates the specified child.

Method Summary

java.lang.Object	clone() Duplicates the current node by using the copy constructor.
java.awt.geom.AffineTransform	computeTransform() Computes the constraint that defines the child to not move even as the camera view changes.
void	duplicateObject(ZConstraintGroup refNode) Copies all object information from the reference object into the current object.
void	finalize() Disposes of this constraint group when it is no longer used.
ZCamera	getCamera() Get the camera that this node is related to.
protected void	init(ZCamera camera) Internal method to help node construction.
void	setCamera(ZCamera camera) Set the camera that this node is related to
void	setState(java.lang.String fieldType, java.lang.String fieldName, java.lang.Object fieldValue) Set some state of this object as it gets read back in.
protected void	updateTransform() Internal method to recompute the constraint transform.
void	writeObject(ZObjectOutputStream out) Write out all of this object's state.
void	writeObjectRecurse(ZObjectOutputStream out) Specify which objects this object references in order to write out the scenegraph properly

Methods inherited from class edu.umd.cs.jazz.ZTransformGroup

addTransformListener, animate, animate, animate, animate, computeBounds, computeInverseTransform, computeScale, concatenate, dump, duplicateObject, fireTransformEvent, getInverseTransform, getLocalToGlobalTransform, getMatrix, getRotation, getScale, getTransform, getTranslateX, getTranslateY, getTranslation, lerp, lerp, pick, position, position, preConcatenate, removeTransformListener, render, repaint, rotate, rotate, rotate, rotate, scale, scale, scale, scale, setRotation, setRotation, setRotation, setRotation, setScale, setScale, setScale, setScale, setTransform, setTransform, setTranslateX, setTranslateY, setTranslation, setTranslation, transform, transform, translate, translate

Methods inherited from class edu.umd.cs.jazz.ZGroup

addChild, addGroupListener, duplicateObject, fireGroupEvent, getChild, getChildren, getChildrenFindable, getChildrenIterator, getChildrenPickable, getNumChildren, hasOneChild, indexOf, insertAbove, lower, lowerTo, raise, raiseTo, remove, removeChild, removeGroupListener, setChildrenFindable, setChildrenPickable, setHasOneChild, trimToSize, updateVolatility

Methods inherited from class edu.umd.cs.jazz.ZNode

addClientProperty, addMouseListener, addMouseMotionListener, duplicateObject, editor, fireMouseEvent, getClientProperty, getGlobalBounds, getGlobalToLocalTransform, getParent, getRoot, globalToLocal, globalToLocal, hasMouseListener, isAncestorOf, isDescendentOf, isFindable, isPickable, isSavable, localToGlobal, localToGlobal, lower, lowerTo, putClientProperty, raise, raiseTo, removeMouseListener, removeMouseMotionListener, repaint, reparent, replaceWith, setEditorFactory, setFindable, setParent, setPickable, setSavable, updateBounds, updateObjectReferences, writeReplace

Methods inherited from class edu.umd.cs.jazz.ZSceneGraphObject

duplicateObject, getBounds, getVolatileBounds, reshape, setVolatileBounds

Methods inherited from class java.lang.Object

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

Field Detail

camera

protected ZCamera camera

The camera the constraint is related to

Constructor Detail

ZConstraintGroup

public ZConstraintGroup()

Constructs a new constraint group. This constructor does not specify a camera to be used in calculating the constraint. Set the camera separately to make the node behave properly.

See Also:

setCamera(edu.umd.cs.jazz.ZCamera)

ZConstraintGroup

public ZConstraintGroup(ZCamera camera)

Constructs a new constraint group with a specified camera.

Parameters:

camera - The camera the node is related to.

ZConstraintGroup

public ZConstraintGroup(ZNode child)

Constructs a new constraint group that decorates the specified child.

Parameters:

child - The child that should go directly below this node.

ZConstraintGroup

public ZConstraintGroup(ZCamera camera,
                        ZNode child)

Constructs a new constraint group with a specified camera that decorates the specified child.

Parameters:

camera - The camera the node is related to.

child - The child that should go directly below this node.

Method Detail

finalize

public void finalize()

Disposes of this constraint group when it is no longer used.

Overrides:

finalize in class java.lang.Object

init

protected void init(ZCamera camera)

Internal method to help node construction.

duplicateObject

public void duplicateObject(ZConstraintGroup refNode)

Copies all object information from the reference object into the current object. This method is called from the clone method. All ZSceneGraphObjects objects contained by the object being duplicated are duplicated, except parents which are set to null. This results in the sub-tree rooted at this object being duplicated.

Parameters:

refNode - The reference node to copy

clone

public java.lang.Object clone()

Duplicates the current node by using the copy constructor. The portion of the reference node that is duplicated is that necessary to reuse the node in a new place within the scenegraph, but the new node is not inserted into any scenegraph. The node must be attached to a live scenegraph (a scenegraph that is currently visible) or be registered with a camera directly in order for it to be visible.

Overrides:

clone in class ZTransformGroup

Returns:

A copy of this node.

See Also:

ZNode.updateObjectReferences(edu.umd.cs.jazz.util.ZObjectReferenceTable)

computeTransform

public java.awt.geom.AffineTransform computeTransform()

Computes the constraint that defines the child to not move even as the camera view changes. This is called whenever the camera view changes. This should be overrided by sub-classes defining constraints.

Returns:

The new transform

updateTransform

protected void updateTransform()

Internal method to recompute the constraint transform. This should be called whenever some internal state that can affect the constraint changes.

getCamera

public ZCamera getCamera()

Get the camera that this node is related to.

Returns:

the camera

setCamera

public void setCamera(ZCamera camera)

Set the camera that this node is related to

Parameters:

camera - The new camera

writeObject

public void writeObject(ZObjectOutputStream out)
                 throws java.io.IOException

Write out all of this object's state.

Overrides:

writeObject in class ZTransformGroup

Parameters:

out - The stream that this object writes into

writeObjectRecurse

public void writeObjectRecurse(ZObjectOutputStream out)
                        throws java.io.IOException

Specify which objects this object references in order to write out the scenegraph properly

Overrides:

writeObjectRecurse in class ZTransformGroup

Parameters:

out - The stream that this object writes into

setState

public void setState(java.lang.String fieldType,
                     java.lang.String fieldName,
                     java.lang.Object fieldValue)

Set some state of this object as it gets read back in. After the object is created with its default no-arg constructor, this method will be called on the object once for each bit of state that was written out through calls to ZObjectOutputStream.writeState() within the writeObject method.

Overrides:

setState in class ZTransformGroup

Parameters:

fieldType - The fully qualified type of the field

fieldName - The name of the field

fieldValue - The value of the field