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