001: /*
002: * $RCSfile: WakeupOnSensorExit.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 specifying a wakeup on first detection of sensors no
036: * longer intersecting the specified boundary.
037: */
038: public final class WakeupOnSensorExit extends WakeupCriterion {
039:
040: // different types of WakeupIndexedList that use in BehaviorStructure
041: static final int COND_IN_BS_LIST = 0;
042: static final int SENSOREXIT_IN_BS_LIST = 1;
043:
044: // total number of different IndexedUnorderedSet types
045: static final int TOTAL_INDEXED_UNORDER_SET_TYPES = 2;
046:
047: Bounds region;
048: // Transformed region used by BehaviorStructure
049: Bounds transformedRegion;
050:
051: Sensor armingSensor;
052:
053: /**
054: * Constructs a new WakeupOnExit criterion.
055: * @param region the region that will trigger a wakeup if a Sensor
056: * intersects.
057: */
058: public WakeupOnSensorExit(Bounds region) {
059: this .region = (Bounds) region.clone();
060: WakeupIndexedList.init(this , TOTAL_INDEXED_UNORDER_SET_TYPES);
061: }
062:
063: /**
064: * Returns this object's bounds specification
065: * @return the bounds used in constructing this WakeupCriterion.
066: */
067: public Bounds getBounds() {
068: return (Bounds) region.clone();
069: }
070:
071: /**
072: * Update the cached Transfrom Region, call from BehaviorStructure
073: */
074: void updateTransformRegion() {
075: if (transformedRegion != null) {
076: transformedRegion.set(region);
077: } else {
078: // region is read only once initialize (since there is no
079: // set method for region). So no need to use cloneWithLock()
080: transformedRegion = (Bounds) region.clone();
081: }
082: transformedRegion
083: .transform(behav.getCurrentLocalToVworld(null));
084: }
085:
086: /**
087: * This is a callback from BehaviorStructure. It is
088: * used to add wakeupCondition to behavior structure.
089: */
090: void addBehaviorCondition(BehaviorStructure bs) {
091: bs.addSensorExitCondition(this );
092: if ((behav != null) && behav.enable) {
093: bs.activeWakeupOnSensorCount++;
094: }
095: }
096:
097: /**
098: * This is a callback from BehaviorStructure. It is
099: * used to remove wakeupCondition from behavior structure.
100: */
101: void removeBehaviorCondition(BehaviorStructure bs) {
102: bs.removeSensorExitCondition(this );
103: if ((behav != null) && behav.enable) {
104: bs.activeWakeupOnSensorCount--;
105: }
106: }
107:
108: /**
109: * Set the sensor that trigger this behavior
110: */
111: void setTarget(Sensor sensor) {
112: this .armingSensor = sensor;
113: }
114:
115: /**
116: * Retrieves the Sensor object that caused the wakeup.
117: *
118: * @return the triggering Sensor object
119: *
120: * @exception IllegalStateException if not called from within
121: * a behavior's processStimulus method which was awoken by a sensor
122: * exit.
123: *
124: * @since Java 3D 1.2
125: */
126: public Sensor getTriggeringSensor() {
127: if (behav == null) {
128: throw new IllegalStateException(J3dI18N
129: .getString("WakeupOnSensorExit0"));
130: }
131:
132: synchronized (behav) {
133: if (!behav.inCallback) {
134: throw new IllegalStateException(J3dI18N
135: .getString("WakeupOnSensorExit0"));
136: }
137: }
138: return armingSensor;
139: }
140:
141: /**
142: * Perform task in addBehaviorCondition() that has to be
143: * set every time the condition met.
144: */
145: void resetBehaviorCondition(BehaviorStructure bs) {
146: }
147: }
|