All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.WakeupOnCollisionEntry

java.lang.Object
   |
   +----java.media.j3d.WakeupCondition
           |
           +----java.media.j3d.WakeupCriterion
                   |
                   +----java.media.j3d.WakeupOnCollisionEntry

public final class WakeupOnCollisionEntry
extends WakeupCriterion
Class specifying a wakeup when the specified object collides with any other object in the scene graph.


Variable Index

 o USE_BOUNDS
Use geometric bounds as an approximation in computing collisions.
 o USE_GEOMETRY
Use geometry in computing collisions.

Constructor Index

 o WakeupOnCollisionEntry(Bounds)
Constructs a new WakeupOnCollisionEntry criterion.
 o WakeupOnCollisionEntry(Node)
Constructs a new WakeupOnCollisionEntry criterion.
 o WakeupOnCollisionEntry(Node, int)
Constructs a new WakeupOnCollisionEntry criterion.
 o WakeupOnCollisionEntry(SceneGraphPath)
Constructs a new WakeupOnCollisionEntry criterion.
 o WakeupOnCollisionEntry(SceneGraphPath, int)
Constructs a new WakeupOnCollisionEntry criterion.

Method Index

 o getArmingBounds()
Returns the bounds object used in specifying the collision condition.
 o getArmingPath()
Returns the path used in specifying the collision condition.
 o getTriggeringBounds()
Retrieves the Bounds object that caused the collision
 o getTriggeringPath()
Retrieves the path describing the object causing the collision.

Variables

 o USE_GEOMETRY
 public static final int USE_GEOMETRY
Use geometry in computing collisions.

 o USE_BOUNDS
 public static final int USE_BOUNDS
Use geometric bounds as an approximation in computing collisions.

Constructors

 o WakeupOnCollisionEntry
 public WakeupOnCollisionEntry(SceneGraphPath armingPath)
Constructs a new WakeupOnCollisionEntry criterion.

Parameters:
armingPath - the path used to arm collision detection
 o WakeupOnCollisionEntry
 public WakeupOnCollisionEntry(SceneGraphPath armingPath,
                               int speedHint)
Constructs a new WakeupOnCollisionEntry criterion.

Parameters:
armingPath - the path used to arm collision detection
speedHint - one of USE_GEOMETRY or USE_BOUNDS, specifies how accurately Java 3D will perform collision detection
Throws: IllegalArgumentException
if hint is not one of USE_GEOMETRY or USE_BOUNDS.
 o WakeupOnCollisionEntry
 public WakeupOnCollisionEntry(Node armingNode)
Constructs a new WakeupOnCollisionEntry criterion.

Parameters:
armingNode - the Group, Shape, or Morph node used to arm collision detection
Throws: IllegalArgumentException
if object is other than a Group, Shape3D, or Morph node.
 o WakeupOnCollisionEntry
 public WakeupOnCollisionEntry(Node armingNode,
                               int speedHint)
Constructs a new WakeupOnCollisionEntry criterion.

Parameters:
armingNode - the Group, Shape, or Morph node used to arm collision detection
speedHint - one of USE_GEOMETRY or USE_BOUNDS, specifies how accurately Java 3D will perform collision detection
Throws: IllegalArgumentException
if hint is not one of USE_GEOMETRY or USE_BOUNDS.
Throws: IllegalArgumentException
if object is other than a Group, Shape3D, or Morph node.
 o WakeupOnCollisionEntry
 public WakeupOnCollisionEntry(Bounds armingBounds)
Constructs a new WakeupOnCollisionEntry criterion.

Parameters:
armingBounds - the bounds object used to arm collision detection

Methods

 o getArmingPath
 public SceneGraphPath getArmingPath()
Returns the path used in specifying the collision condition.

Returns:
the SceneGraphPath object generated when arming this criterion---null implies that a bounds object armed this criteria
 o getArmingBounds
 public Bounds getArmingBounds()
Returns the bounds object used in specifying the collision condition.

Returns:
the Bounds object generated when arming this criterion---null implies that a SceneGraphPath armed this criteria
 o getTriggeringPath
 public SceneGraphPath getTriggeringPath()
Retrieves the path describing the object causing the collision.

Returns:
the SceneGraphPath that describes the triggering object.
 o getTriggeringBounds
 public Bounds getTriggeringBounds()
Retrieves the Bounds object that caused the collision

Returns:
the colliding Bounds object.

All Packages  Class Hierarchy  This Package  Previous  Next  Index