01: /*
02: * $RCSfile: WakeupOnActivation.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 the first time an active Viewplatform's
36: * activation
37: * volume intersects with this object's scheduling region.
38: * This gives the behavior an explicit means of executing code when
39: * it is activated.
40: */
41: public final class WakeupOnActivation extends WakeupCriterion {
42:
43: // different types of WakeupIndexedList that use in BehaviorStructure
44: static final int COND_IN_BS_LIST = 0;
45:
46: // total number of different IndexedUnorderedSet types
47: static final int TOTAL_INDEXED_UNORDER_SET_TYPES = 1;
48:
49: /**
50: * Constructs a new WakeupOnActivation criterion.
51: */
52: public WakeupOnActivation() {
53: WakeupIndexedList.init(this , TOTAL_INDEXED_UNORDER_SET_TYPES);
54: }
55:
56: /**
57: * This is a callback from BehaviorStructure. It is
58: * used to add wakeupCondition to behavior structure.
59: */
60: void addBehaviorCondition(BehaviorStructure bs) {
61: behav.wakeupArray[BehaviorRetained.WAKEUP_ACTIVATE_INDEX]++;
62: behav.wakeupMask |= BehaviorRetained.WAKEUP_ACTIVATE;
63: bs.wakeupOnActivation.add(this );
64: }
65:
66: /**
67: * This is a callback from BehaviorStructure. It is
68: * used to remove wakeupCondition from behavior structure.
69: */
70: void removeBehaviorCondition(BehaviorStructure bs) {
71: behav.wakeupArray[BehaviorRetained.WAKEUP_ACTIVATE_INDEX]--;
72: if (behav.wakeupArray[BehaviorRetained.WAKEUP_ACTIVATE_INDEX] == 0) {
73: behav.wakeupMask &= ~BehaviorRetained.WAKEUP_ACTIVATE;
74: }
75: bs.wakeupOnActivation.remove(this );
76: }
77:
78: /**
79: * Perform task in addBehaviorCondition() that has to be
80: * set every time the condition met.
81: */
82: void resetBehaviorCondition(BehaviorStructure bs) {
83: }
84: }
|