javax.media.j3d
Class WakeupOnSensorExit

java.lang.Object
  extended by javax.media.j3d.WakeupCondition
      extended by javax.media.j3d.WakeupCriterion
          extended by javax.media.j3d.WakeupOnSensorExit

public final class WakeupOnSensorExit
extends WakeupCriterion

Class specifying a wakeup on first detection of sensors no longer intersecting the specified boundary.


Field Summary
(package private)  Sensor armingSensor
           
(package private) static int COND_IN_BS_LIST
           
(package private)  Bounds region
           
(package private) static int SENSOREXIT_IN_BS_LIST
           
(package private) static int TOTAL_INDEXED_UNORDER_SET_TYPES
           
(package private)  Bounds transformedRegion
           
 
Fields inherited from class javax.media.j3d.WakeupCriterion
triggered
 
Fields inherited from class javax.media.j3d.WakeupCondition
ALL_ELEMENTS, allEnum, behav, conditionMet, id, listIdx, parent, trigEnum, TRIGGERED_ELEMENTS
 
Constructor Summary
WakeupOnSensorExit(Bounds region)
          Constructs a new WakeupOnExit criterion.
 
Method Summary
(package private)  void addBehaviorCondition(BehaviorStructure bs)
          This is a callback from BehaviorStructure.
 Bounds getBounds()
          Returns this object's bounds specification
 Sensor getTriggeringSensor()
          Retrieves the Sensor object that caused the wakeup.
(package private)  void removeBehaviorCondition(BehaviorStructure bs)
          This is a callback from BehaviorStructure.
(package private)  void resetBehaviorCondition(BehaviorStructure bs)
          Perform task in addBehaviorCondition() that has to be set every time the condition met.
(package private)  void setTarget(Sensor sensor)
          Set the sensor that trigger this behavior
(package private)  void updateTransformRegion()
          Update the cached Transfrom Region, call from BehaviorStructure
 
Methods inherited from class javax.media.j3d.WakeupCriterion
buildTree, cleanTree, hasTriggered, resetTree, setTriggered
 
Methods inherited from class javax.media.j3d.WakeupCondition
allElements, reInsertElapseTimeCond, setConditionMet, triggeredElements
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COND_IN_BS_LIST

static final int COND_IN_BS_LIST
See Also:
Constant Field Values

SENSOREXIT_IN_BS_LIST

static final int SENSOREXIT_IN_BS_LIST
See Also:
Constant Field Values

TOTAL_INDEXED_UNORDER_SET_TYPES

static final int TOTAL_INDEXED_UNORDER_SET_TYPES
See Also:
Constant Field Values

region

Bounds region

transformedRegion

Bounds transformedRegion

armingSensor

Sensor armingSensor
Constructor Detail

WakeupOnSensorExit

public WakeupOnSensorExit(Bounds region)
Constructs a new WakeupOnExit criterion.

Parameters:
region - the region that will trigger a wakeup if a Sensor intersects.
Method Detail

getBounds

public Bounds getBounds()
Returns this object's bounds specification

Returns:
the bounds used in constructing this WakeupCriterion.

updateTransformRegion

void updateTransformRegion()
Update the cached Transfrom Region, call from BehaviorStructure


addBehaviorCondition

void addBehaviorCondition(BehaviorStructure bs)
This is a callback from BehaviorStructure. It is used to add wakeupCondition to behavior structure.

Specified by:
addBehaviorCondition in class WakeupCriterion

removeBehaviorCondition

void removeBehaviorCondition(BehaviorStructure bs)
This is a callback from BehaviorStructure. It is used to remove wakeupCondition from behavior structure.

Specified by:
removeBehaviorCondition in class WakeupCriterion

setTarget

void setTarget(Sensor sensor)
Set the sensor that trigger this behavior


getTriggeringSensor

public Sensor getTriggeringSensor()
Retrieves the Sensor object that caused the wakeup.

Returns:
the triggering Sensor object
Throws:
java.lang.IllegalStateException - if not called from within a behavior's processStimulus method which was awoken by a sensor exit.
Since:
Java 3D 1.2

resetBehaviorCondition

void resetBehaviorCondition(BehaviorStructure bs)
Perform task in addBehaviorCondition() that has to be set every time the condition met.

Specified by:
resetBehaviorCondition in class WakeupCriterion


Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.