org.scijava.java3d

Class WakeupOnBehaviorPost

java.lang.Object

org.scijava.java3d.WakeupCondition

org.scijava.java3d.WakeupCriterion

org.scijava.java3d.WakeupOnBehaviorPost

public final class WakeupOnBehaviorPost
extends WakeupCriterion

Class that specifies a Behavior wakeup when a specific behavior object posts a specific event

Constructor Summary

Constructors

Constructor and Description
WakeupOnBehaviorPost(Behavior behavior, int postId) Constructs a new WakeupOnBehaviorPost criterion.

Method Summary

Methods

Modifier and Type	Method and Description
Behavior	getBehavior() Returns the behavior specified in this object's constructor.
int	getPostId() Retrieve the WakeupCriterion's specified postId
Behavior	getTriggeringBehavior() Returns the behavior that triggered this wakeup.
int	getTriggeringPostId() Returns the postId that caused the behavior to wakeup.

Methods inherited from class org.scijava.java3d.WakeupCriterion

hasTriggered

Methods inherited from class org.scijava.java3d.WakeupCondition

allElements, triggeredElements

Methods inherited from class java.lang.Object

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

Constructor Detail

WakeupOnBehaviorPost

public WakeupOnBehaviorPost(Behavior behavior,
                    int postId)

Constructs a new WakeupOnBehaviorPost criterion. A behavior of null specifies a wakeup from any behavior on the specified postId. A postId of 0 specifies a wakeup on any postId from the specified behavior. A behavior of null AND a postId of 0 specify a wakeup on any postId from any behavior.

Parameters:

behavior - the behavior that must be the source of the post, if behavior == null, then any behavior posting the postId will cause the wakeup.

postId - the postId that will trigger a wakeup if posted by the specified behavior, if postId == 0, then any post by the specified behavior will cause the wakeup.

Method Detail

getPostId

public int getPostId()

Retrieve the WakeupCriterion's specified postId

Returns:

the post id specified in this object's construction.

getBehavior

public Behavior getBehavior()

Returns the behavior specified in this object's constructor.

Returns:

the arming behavior

getTriggeringPostId

public int getTriggeringPostId()

Returns the postId that caused the behavior to wakeup. If the postId used to construct this wakeup criterion was not zero, then the triggering postId will always be equal to the postId used in the constructor.

getTriggeringBehavior

public Behavior getTriggeringBehavior()

Returns the behavior that triggered this wakeup. If the arming behavior used to construct this object was not null, then the triggering behavior will be the same as the arming behavior.