javax.media.j3d

Class WakeupOnBehaviorPost

java.lang.Object

javax.media.j3d.WakeupCondition

javax.media.j3d.WakeupCriterion

javax.media.j3d.WakeupOnBehaviorPost

public final class WakeupOnBehaviorPost
extends WakeupCriterion

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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Behavior	armingBehavior
(package private) static int	COND_IN_BS_LIST
(package private) int	post
(package private) static int	TOTAL_INDEXED_UNORDER_SET_TYPES
(package private) Behavior	triggeringBehavior
(package private) int	triggeringPost

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

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	addBehaviorCondition(BehaviorStructure bs) This is a callback from BehaviorStructure.
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.
(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.

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

TOTAL_INDEXED_UNORDER_SET_TYPES

static final int TOTAL_INDEXED_UNORDER_SET_TYPES

See Also:

Constant Field Values

armingBehavior

Behavior armingBehavior

triggeringBehavior

Behavior triggeringBehavior

post

int post

triggeringPost

int triggeringPost

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.

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

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