01: /*
02: * $RCSfile: WakeupOnDeactivation.java,v $
03: *
04: * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06: *
07: * This code is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU General Public License version 2 only, as
09: * published by the Free Software Foundation. Sun designates this
10: * particular file as subject to the "Classpath" exception as provided
11: * by Sun in the LICENSE file that accompanied this code.
12: *
13: * This code is distributed in the hope that it will be useful, but WITHOUT
14: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16: * version 2 for more details (a copy is included in the LICENSE file that
17: * accompanied this code).
18: *
19: * You should have received a copy of the GNU General Public License version
20: * 2 along with this work; if not, write to the Free Software Foundation,
21: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
22: *
23: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
24: * CA 95054 USA or visit www.sun.com if you need additional information or
25: * have any questions.
26: *
27: * $Revision: 1.5 $
28: * $Date: 2008/02/28 20:17:33 $
29: * $State: Exp $
30: */
31:
32: package javax.media.j3d;
33:
34: /**
35: * Class specifying a wakeup on first detection of a Viewplatform's
36: * activation volume no longer intersecting with this object's scheduling
37: * region. This gives the behavior an explicit means of executing code
38: * when it is deactivated.
39: */
40: public final class WakeupOnDeactivation extends WakeupCriterion {
41:
42: // different types of WakeupIndexedList that use in BehaviorStructure
43: static final int COND_IN_BS_LIST = 0;
44:
45: // total number of different IndexedUnorderedSet types
46: static final int TOTAL_INDEXED_UNORDER_SET_TYPES = 1;
47:
48: /**
49: * Constructs a new WakeupOnDeactivation criterion.
50: */
51: public WakeupOnDeactivation() {
52: WakeupIndexedList.init(this , TOTAL_INDEXED_UNORDER_SET_TYPES);
53: }
54:
55: /**
56: * Set the Criterion's trigger flag to true.
57: * No need to check for scheduling region in this case
58: */
59: void setTriggered() {
60: this .triggered = true;
61: if (this .parent == null) {
62: super .setConditionMet(id, Boolean.FALSE);
63: } else {
64: parent.setConditionMet(id, Boolean.FALSE);
65: }
66: }
67:
68: /**
69: * This is a callback from BehaviorStructure. It is
70: * used to add wakeupCondition to behavior structure.
71: */
72: void addBehaviorCondition(BehaviorStructure bs) {
73: behav.wakeupArray[BehaviorRetained.WAKEUP_DEACTIVATE_INDEX]++;
74: behav.wakeupMask |= BehaviorRetained.WAKEUP_DEACTIVATE;
75: bs.wakeupOnDeactivation.add(this );
76: }
77:
78: /**
79: * This is a callback from BehaviorStructure. It is
80: * used to remove wakeupCondition from behavior structure.
81: */
82: void removeBehaviorCondition(BehaviorStructure bs) {
83: behav.wakeupArray[BehaviorRetained.WAKEUP_DEACTIVATE_INDEX]--;
84: if (behav.wakeupArray[BehaviorRetained.WAKEUP_DEACTIVATE_INDEX] == 0) {
85: behav.wakeupMask &= ~BehaviorRetained.WAKEUP_DEACTIVATE;
86: }
87: bs.wakeupOnDeactivation.remove(this );
88: }
89:
90: /**
91: * Perform task in addBehaviorCondition() that has to be
92: * set every time the condition met.
93: */
94: void resetBehaviorCondition(BehaviorStructure bs) {
95: }
96: }
|