001: /*
002: * $RCSfile: WakeupOnBehaviorPost.java,v $
003: *
004: * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
006: *
007: * This code is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU General Public License version 2 only, as
009: * published by the Free Software Foundation. Sun designates this
010: * particular file as subject to the "Classpath" exception as provided
011: * by Sun in the LICENSE file that accompanied this code.
012: *
013: * This code is distributed in the hope that it will be useful, but WITHOUT
014: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
015: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
016: * version 2 for more details (a copy is included in the LICENSE file that
017: * accompanied this code).
018: *
019: * You should have received a copy of the GNU General Public License version
020: * 2 along with this work; if not, write to the Free Software Foundation,
021: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
022: *
023: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
024: * CA 95054 USA or visit www.sun.com if you need additional information or
025: * have any questions.
026: *
027: * $Revision: 1.5 $
028: * $Date: 2008/02/28 20:17:33 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: /**
035: * Class that specifies a Behavior wakeup when a specific behavior object
036: * posts a specific event
037: */
038: public final class WakeupOnBehaviorPost extends WakeupCriterion {
039:
040: // different types of WakeupIndexedList that use in BehaviorStructure
041: static final int COND_IN_BS_LIST = 0;
042:
043: // total number of different IndexedUnorderedSet types
044: static final int TOTAL_INDEXED_UNORDER_SET_TYPES = 1;
045:
046: Behavior armingBehavior, triggeringBehavior;
047: int post, triggeringPost;
048:
049: /**
050: * Constructs a new WakeupOnBehaviorPost criterion. A behavior of null
051: * specifies a wakeup from any behavior on the specified postId. A postId
052: * of 0 specifies a wakeup on any postId from the specified behavior.
053: * A behavior of null AND a postId of 0 specify a wakeup on any postId
054: * from any behavior.
055: * @param behavior the behavior that must be the source of the post,
056: * if behavior == null, then any behavior posting the postId will cause
057: * the wakeup.
058: * @param postId the postId that will trigger a wakeup if posted by the
059: * specified behavior, if postId == 0, then any post by the specified
060: * behavior will cause the wakeup.
061: */
062: public WakeupOnBehaviorPost(Behavior behavior, int postId) {
063: this .armingBehavior = behavior;
064: this .post = postId;
065: triggeringPost = -1;
066: triggeringBehavior = null;
067: WakeupIndexedList.init(this , TOTAL_INDEXED_UNORDER_SET_TYPES);
068: }
069:
070: /**
071: * Retrieve the WakeupCriterion's specified postId
072: * @return the post id specified in this object's construction.
073: */
074: public int getPostId() {
075: return post;
076: }
077:
078: /**
079: * Returns the behavior specified in this object's constructor.
080: * @return the arming behavior
081: */
082: public Behavior getBehavior() {
083: return armingBehavior;
084: }
085:
086: /**
087: * Returns the postId that caused the behavior to wakeup. If the postId
088: * used to construct this wakeup criterion was not zero, then the
089: * triggering postId will always be equal to the postId used in the
090: * constructor.
091: */
092: public int getTriggeringPostId() {
093: return triggeringPost;
094: }
095:
096: /**
097: * Returns the behavior that triggered this wakeup. If the arming
098: * behavior used to construct this object was not null, then the
099: * triggering behavior will be the same as the arming behavior.
100: */
101: public Behavior getTriggeringBehavior() {
102: return triggeringBehavior;
103: }
104:
105: /**
106: * This is a callback from BehaviorStructure. It is
107: * used to add wakeupCondition to behavior structure.
108: */
109: void addBehaviorCondition(BehaviorStructure bs) {
110: bs.wakeupOnBehaviorPost.add(this );
111: }
112:
113: /**
114: * This is a callback from BehaviorStructure. It is
115: * used to remove wakeupCondition from behavior structure.
116: */
117: void removeBehaviorCondition(BehaviorStructure bs) {
118: bs.wakeupOnBehaviorPost.remove(this );
119: }
120:
121: /**
122: * Perform task in addBehaviorCondition() that has to be
123: * set every time the condition met.
124: */
125: void resetBehaviorCondition(BehaviorStructure bs) {
126: }
127: }
|