javax.media.j3d

Class WakeupCriterion

java.lang.Object

javax.media.j3d.WakeupCondition

javax.media.j3d.WakeupCriterion

Direct Known Subclasses:

WakeupOnActivation, WakeupOnAWTEvent, WakeupOnBehaviorPost, WakeupOnCollisionEntry, WakeupOnCollisionExit, WakeupOnCollisionMovement, WakeupOnDeactivation, WakeupOnElapsedFrames, WakeupOnElapsedTime, WakeupOnSensorEntry, WakeupOnSensorExit, WakeupOnTransformChange, WakeupOnViewPlatformEntry, WakeupOnViewPlatformExit

public abstract class WakeupCriterion
extends WakeupCondition

An abstract class specifying a singleton wakeup Criterion. This class consists of several subclasses, each of which specifies one particular wakeup criterion, that criterion's associated arguments (if any), and either a flag that indicates whether this criterion caused a Behavior object to awaken or a return field containing the information that caused the Behavior object to awaken.

Note that a unique WakeupCriterion object must be used with each instance of a Behavior. Sharing wakeup criteria among different instances of a Behavior is illegal. Similarly, a unique WakeupCriterion object must be used for each individual element in the set of arrays used to construct WakeupOr, WakeupAnd, WakeupOrOfAnds, and WakeupAndOfOrs objects.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	triggered Flag specifying whether this criterion triggered a wakeup

Fields inherited from class javax.media.j3d.WakeupCondition

ALL_ELEMENTS, allEnum, behav, conditionMet, id, listIdx, parent, trigEnum, TRIGGERED_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
WakeupCriterion()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) abstract void	addBehaviorCondition(BehaviorStructure bs) This is a callback from BehaviorStructure.
(package private) void	buildTree(WakeupCondition parent, int id, BehaviorRetained b) Initialize And/Or tree and add criterion to the BehaviourStructure.
(package private) void	cleanTree(BehaviorStructure bs) This goes through the AndOr tree to remove the various criterion from the BehaviorStructure.
boolean	hasTriggered() Returns true if this criterion triggered the wakeup.
(package private) abstract void	removeBehaviorCondition(BehaviorStructure bs) This is a callback from BehaviorStructure.
(package private) abstract void	resetBehaviorCondition(BehaviorStructure bs) It is used reset wakeupCondition when it is reused.
(package private) void	resetTree() This goes through the AndOr tree to reset various criterion.
(package private) void	setTriggered() Set the Criterion's trigger flag to true.

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

triggered

boolean triggered

Flag specifying whether this criterion triggered a wakeup

Constructor Detail

WakeupCriterion

public WakeupCriterion()

Method Detail

hasTriggered

public boolean hasTriggered()

Returns true if this criterion triggered the wakeup.

Returns:

true if this criterion triggered the wakeup.

setTriggered

void setTriggered()

Set the Criterion's trigger flag to true.

buildTree

void buildTree(WakeupCondition parent,
             int id,
             BehaviorRetained b)

Initialize And/Or tree and add criterion to the BehaviourStructure.

Overrides:

buildTree in class WakeupCondition

cleanTree

void cleanTree(BehaviorStructure bs)

This goes through the AndOr tree to remove the various criterion from the BehaviorStructure. We can't use behav.universe.behaviorStructure since behav may reassign to another universe at this time.

Overrides:

cleanTree in class WakeupCondition

resetTree

void resetTree()

This goes through the AndOr tree to reset various criterion.

Overrides:

resetTree in class WakeupCondition

addBehaviorCondition

abstract void addBehaviorCondition(BehaviorStructure bs)

This is a callback from BehaviorStructure. It is used to add wakeupCondition to behavior structure.

removeBehaviorCondition

abstract void removeBehaviorCondition(BehaviorStructure bs)

This is a callback from BehaviorStructure. It is used to remove wakeupCondition from behavior structure.

resetBehaviorCondition

abstract void resetBehaviorCondition(BehaviorStructure bs)

It is used reset wakeupCondition when it is reused.