javax.media.j3d
Class Morph

java.lang.Object
  extended by javax.media.j3d.SceneGraphObject
      extended by javax.media.j3d.Node
          extended by javax.media.j3d.Leaf
              extended by javax.media.j3d.Morph

public class Morph
extends Leaf

The Morph leaf node permits an application to morph between multiple GeometryArrays. The Morph node contains a single Appearance node, an array of GeometryArray objects, and an array of corresponding weights. The Morph node combines these GeometryArrays into an aggregate shape based on each GeometryArray's corresponding weight. Typically, Behavior nodes will modify the weights to achieve various morphing effects.

The following restrictions apply to each GeometryArray object in the specified array of GeometryArray objects:

For IndexedGeometryArray objects, the vertex arrays are morphed before the indexes are applied. Only the indexes in the first geometry array (geometry[0]) are used when rendering the geometry.


Field Summary
static int ALLOW_APPEARANCE_OVERRIDE_READ
          Specifies that this node allows reading its appearance override enable flag.
static int ALLOW_APPEARANCE_OVERRIDE_WRITE
          Specifies that this node allows writing its appearance override enable flag.
static int ALLOW_APPEARANCE_READ
          Specifies that the node allows read access to its appearance information.
static int ALLOW_APPEARANCE_WRITE
          Specifies that the node allows write access to its appearance information.
static int ALLOW_COLLISION_BOUNDS_READ
          Specifies that the node allows reading its collision Bounds.
static int ALLOW_COLLISION_BOUNDS_WRITE
          Specifies the node allows writing its collision Bounds.
static int ALLOW_GEOMETRY_ARRAY_READ
          Specifies that the node allows read access to its geometry information.
static int ALLOW_GEOMETRY_ARRAY_WRITE
          Specifies that the node allows write access to its geometry information.
static int ALLOW_WEIGHTS_READ
          Specifies that the node allows read access to its morph weight vector.
static int ALLOW_WEIGHTS_WRITE
          Specifies that the node allows write access to its morph weight vector.
 
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_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING
 
Constructor Summary
Morph(GeometryArray[] geometryArrays)
          Constructs and initializes a Morph node with the specified array of GeometryArray objects.
Morph(GeometryArray[] geometryArrays, Appearance appearance)
          Constructs and initializes a Morph node with the specified array of GeometryArray objects and the specified appearance object.
 
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.
 Appearance getAppearance()
          Retrieves the appearance component of this morph node.
 boolean getAppearanceOverrideEnable()
          Retrieves the appearanceOverrideEnable flag for this node.
 Bounds getCollisionBounds()
          Returns the collision bounding object of this node.
 GeometryArray getGeometryArray(int index)
          Retrieves the geometryArray component of this Morph node.
 double[] getWeights()
          Retrieves the Morph node's morph weight vector.
 boolean intersect(SceneGraphPath path, PickRay pickRay, double[] dist)
          Checks whether the geometry in this morph node intersects with the specified pickRay.
 boolean intersect(SceneGraphPath path, PickShape pickShape)
          Checks whether the geometry in this morph node intersects with the specified pickShape.
 boolean intersect(SceneGraphPath path, PickShape pickShape, double[] dist)
          Checks whether the geometry in this morph node intersects with the specified pickShape.
 void setAppearance(Appearance appearance)
          Sets the appearance component of this Morph node.
 void setAppearanceOverrideEnable(boolean flag)
          Sets a flag that indicates whether this node's appearance can be overridden.
 void setCollisionBounds(Bounds bounds)
          Sets the collision bounds of a node.
 void setGeometryArrays(GeometryArray[] geometryArrays)
          Sets the geometryArrays component of the Morph node.
 void setWeights(double[] weights)
          Sets this Morph node's morph weight vector.
 
Methods inherited from class javax.media.j3d.Node
cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, getBounds, getBoundsAutoCompute, getCollidable, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable
 
Methods inherited from class javax.media.j3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setUserData, updateNodeReferences
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALLOW_GEOMETRY_ARRAY_READ

public static final int ALLOW_GEOMETRY_ARRAY_READ
Specifies that the node allows read access to its geometry information.

See Also:
Constant Field Values

ALLOW_GEOMETRY_ARRAY_WRITE

public static final int ALLOW_GEOMETRY_ARRAY_WRITE
Specifies that the node allows write access to its geometry information.

See Also:
Constant Field Values

ALLOW_APPEARANCE_READ

public static final int ALLOW_APPEARANCE_READ
Specifies that the node allows read access to its appearance information.

See Also:
Constant Field Values

ALLOW_APPEARANCE_WRITE

public static final int ALLOW_APPEARANCE_WRITE
Specifies that the node allows write access to its appearance information.

See Also:
Constant Field Values

ALLOW_WEIGHTS_READ

public static final int ALLOW_WEIGHTS_READ
Specifies that the node allows read access to its morph weight vector.

See Also:
Constant Field Values

ALLOW_WEIGHTS_WRITE

public static final int ALLOW_WEIGHTS_WRITE
Specifies that the node allows write access to its morph weight vector.

See Also:
Constant Field Values

ALLOW_COLLISION_BOUNDS_READ

public static final int ALLOW_COLLISION_BOUNDS_READ
Specifies that the node allows reading its collision Bounds.

See Also:
Constant Field Values

ALLOW_COLLISION_BOUNDS_WRITE

public static final int ALLOW_COLLISION_BOUNDS_WRITE
Specifies the node allows writing its collision Bounds.

See Also:
Constant Field Values

ALLOW_APPEARANCE_OVERRIDE_READ

public static final int ALLOW_APPEARANCE_OVERRIDE_READ
Specifies that this node allows reading its appearance override enable flag.

Since:
Java 3D 1.2
See Also:
Constant Field Values

ALLOW_APPEARANCE_OVERRIDE_WRITE

public static final int ALLOW_APPEARANCE_OVERRIDE_WRITE
Specifies that this node allows writing its appearance override enable flag.

Since:
Java 3D 1.2
See Also:
Constant Field Values
Constructor Detail

Morph

public Morph(GeometryArray[] geometryArrays)
Constructs and initializes a Morph node with the specified array of GeometryArray objects. Default values are used for all other parameters as follows:

A null appearance object specifies that default values are used for all appearance attributes.

Parameters:
geometryArrays - the geometry components of the morph; a null or zero-length array of GeometryArray objects is permitted, and specifies that no geometry is drawn. In this case, the array of weights is initialized to a zero-length array.
Throws:
java.lang.IllegalArgumentException - if any of the specified geometry array objects differ from each other in any of the following ways:
  • Type of geometry array object (subclass of GeometryArray)
  • vertexFormat
  • texCoordSetCount
  • texCoordSetMap
  • validVertexCount
  • validIndexCount, for IndexedGeometryArray objects
  • stripVertexCounts array, for GeometryStripArray objects
  • stripIndexCounts array, for IndexedGeometryStripArray objects
  • the array lengths of each enabled vertex component (coord, color, normal, texcoord), for indexed geometry by-reference

Morph

public Morph(GeometryArray[] geometryArrays,
             Appearance appearance)
Constructs and initializes a Morph node with the specified array of GeometryArray objects and the specified appearance object.

Parameters:
geometryArrays - the geometry components of the Morph node a null or zero-length array of GeometryArray objects is permitted, and specifies that no geometry is drawn. In this case, the array of weights is initialized to a zero-length array.
appearance - the appearance component of the Morph node
Throws:
java.lang.IllegalArgumentException - if any of the specified geometry array objects differ from each other in any of the following ways:
  • Type of geometry array object (subclass of GeometryArray)
  • vertexFormat
  • texCoordSetCount
  • texCoordSetMap
  • validVertexCount
  • validIndexCount, for IndexedGeometryArray objects
  • stripVertexCounts array, for GeometryStripArray objects
  • stripIndexCounts array, for IndexedGeometryStripArray objects
  • the array lengths of each enabled vertex component (coord, color, normal, texcoord), for indexed geometry by-reference
Method Detail

setCollisionBounds

public void setCollisionBounds(Bounds bounds)
Sets the collision bounds of a node.

Parameters:
bounds - the collision bounding object for a node
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getCollisionBounds

public Bounds getCollisionBounds()
Returns the collision bounding object of this node.

Returns:
the node's collision bounding object
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setGeometryArrays

public void setGeometryArrays(GeometryArray[] geometryArrays)
Sets the geometryArrays component of the Morph node. If the current array of GeometryArrays in this Morph object is non-null with a length greater than 0, the specified array of GeometryArrays must be the same length as the current array. If the current array of GeometryArrays in this Morph object is null or has a length of 0, and the specified array of GeometryArrays is non-null with a length greater than 0, the length of the incoming array defines the number of the geometry objects that will be morphed. In this case, the weights array is allocated to be of the same length as the geometry array; the first element (weights[0]) is initialized to 1.0 and all of the other weights are initialized to 0.0.

Parameters:
geometryArrays - the new geometryArrays component for the Morph node.
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

java.lang.IllegalArgumentException - if the length of the specified array of geometry arrays is not equal to the length of this Morph node's current array of geometry arrays (and the current array's length is non-zero), or if any of the specified geometry array objects differ from each other in any of the following ways:
  • Type of geometry array object (subclass of GeometryArray)
  • vertexFormat
  • texCoordSetCount
  • texCoordSetMap
  • validVertexCount
  • validIndexCount, for IndexedGeometryArray objects
  • stripVertexCounts array, for GeometryStripArray objects
  • stripIndexCounts array, for IndexedGeometryStripArray objects
  • the array lengths of each enabled vertex component (coord, color, normal, texcoord), for indexed geometry by-reference

getGeometryArray

public GeometryArray getGeometryArray(int index)
Retrieves the geometryArray component of this Morph node.

Parameters:
index - the index of GeometryArray to be returned
Returns:
the geometryArray component of this Morph node
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setAppearance

public void setAppearance(Appearance appearance)
Sets the appearance component of this Morph node. A null appearance component specifies that default values are used for all appearance attributes.

Parameters:
appearance - the new appearance component for this Morph node
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getAppearance

public Appearance getAppearance()
Retrieves the appearance component of this morph node.

Returns:
the appearance component of this morph node
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

intersect

public boolean intersect(SceneGraphPath path,
                         PickShape pickShape)
Checks whether the geometry in this morph node intersects with the specified pickShape.

Parameters:
path - the SceneGraphPath to this morph node
pickShape - the PickShape to be intersected
Returns:
true if the pick shape intersects this node; false otherwise.
Throws:
java.lang.IllegalArgumentException - if pickShape is a PickPoint. Java 3D doesn't have spatial information of the surface. Use PickBounds with BoundingSphere and a small radius, instead.
CapabilityNotSetException - if the Geometry.ALLOW_INTERSECT capability bit is not set in all of the Geometry objects referred to by this morph node.

intersect

public boolean intersect(SceneGraphPath path,
                         PickRay pickRay,
                         double[] dist)
Checks whether the geometry in this morph node intersects with the specified pickRay.

Parameters:
path - the SceneGraphPath to this morph node
pickRay - the PickRay to be intersected
dist - the closest distance of the intersection
Returns:
true if the pick shape intersects this node; false otherwise. If true, dist contains the closest distance of intersection.
Throws:
CapabilityNotSetException - if the Geometry.ALLOW_INTERSECT capability bit is not set in all of the Geometry objects referred to by this morph node.

intersect

public boolean intersect(SceneGraphPath path,
                         PickShape pickShape,
                         double[] dist)
Checks whether the geometry in this morph node intersects with the specified pickShape.

Parameters:
path - the SceneGraphPath to this morph node
pickShape - the PickShape to be intersected
dist - the closest distance of the intersection
Returns:
true if the pick shape intersects this node; false otherwise. If true, dist contains the closest distance of intersection.
Throws:
java.lang.IllegalArgumentException - if pickShape is a PickPoint. Java 3D doesn't have spatial information of the surface. Use PickBounds with BoundingSphere and a small radius, instead.
CapabilityNotSetException - if the Geometry.ALLOW_INTERSECT capability bit is not set in all of the Geometry objects referred to by this morph node.
Since:
Java 3D 1.3

setWeights

public void setWeights(double[] weights)
Sets this Morph node's morph weight vector. The Morph node "weights" the corresponding GeometryArray by the amount specified. The weights apply a morph weight vector component that creates the desired morphing effect. The length of the weights parameter must be equal to the length of the array with which this Morph node was created, otherwise an IllegalArgumentException is thown.

Parameters:
weights - the morph weight vector that the morph node will use in combining the node's geometryArrays. The morph node will "weight" the corresponding GeometryArray by the amount specified. N.B.: the sum of the weights should equal 1.0
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
java.lang.IllegalArgumentException - if sum of all 'weights' is NOT 1.0 or number of weights is NOT exqual to number of GeometryArrays.

getWeights

public double[] getWeights()
Retrieves the Morph node's morph weight vector.

Returns:
the morph weight vector component of this morph node
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setAppearanceOverrideEnable

public void setAppearanceOverrideEnable(boolean flag)
Sets a flag that indicates whether this node's appearance can be overridden. If the flag is true, this node's appearance may be overridden by an AlternateAppearance leaf node, regardless of the value of the ALLOW_APPEARANCE_WRITE capability bit. The default value is false.

Parameters:
flag - the apperance override enable flag
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
Since:
Java 3D 1.2
See Also:
AlternateAppearance

getAppearanceOverrideEnable

public boolean getAppearanceOverrideEnable()
Retrieves the appearanceOverrideEnable flag for this node.

Returns:
true if the appearance can be overridden; false otherwise.
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
Since:
Java 3D 1.2

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 Node
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.
NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.

Overrides:
duplicateNode in class Node
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.
Throws:
java.lang.ClassCastException - if originalNode is not an instance of Morph
See Also:
Node.cloneTree(), Node.cloneNode(boolean), NodeComponent.setDuplicateOnCloneTree(boolean)