Open Inventor Reference
|
00001 /* 00002 * 00003 * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved. 00004 * 00005 * This library is free software; you can redistribute it and/or 00006 * modify it under the terms of the GNU Lesser General Public 00007 * License as published by the Free Software Foundation; either 00008 * version 2.1 of the License, or (at your option) any later version. 00009 * 00010 * This library is distributed in the hope that it will be useful, 00011 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00013 * Lesser General Public License for more details. 00014 * 00015 * Further, this software is distributed without any warranty that it is 00016 * free of the rightful claim of any third person regarding infringement 00017 * or the like. Any license provided herein, whether implied or 00018 * otherwise, applies only to this software file. Patent licenses, if 00019 * any, provided herein do not apply to combinations of this program with 00020 * other software, or any other product whatsoever. 00021 * 00022 * You should have received a copy of the GNU Lesser General Public 00023 * License along with this library; if not, write to the Free Software 00024 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 00025 * 00026 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy, 00027 * Mountain View, CA 94043, or: 00028 * 00029 * http://www.sgi.com 00030 * 00031 * For further information regarding this notice, see: 00032 * 00033 * http://oss.sgi.com/projects/GenInfo/NoticeExplan/ 00034 * 00035 */ 00036 00037 00038 /* 00039 * Copyright (C) 1990,91,92 Silicon Graphics, Inc. 00040 * 00041 _______________________________________________________________________ 00042 ______________ S I L I C O N G R A P H I C S I N C . ____________ 00043 | 00044 | $Revision: 1.1.1.1 $ 00045 | 00046 | Description: 00047 | Abstract base class for all sensors that are added to the delay 00048 | queue, which means that they will be executed at some time in the 00049 | future (when there is idle time, or when a user-defined timeout 00050 | occurs-- see SoDB::setDelaySensorTimeout()). 00051 | 00052 | Sensors in the delay queue are sorted by priorities. A priority of 00053 | 0 indicates that the sensor is immediate and should be triggered 00054 | immediately when it is scheduled. Sensors with other priorities 00055 | are sorted by increasing priority. 00056 | 00057 | Author(s) : Nick Thompson, Paul Strauss, Gavin Bell 00058 | 00059 ______________ S I L I C O N G R A P H I C S I N C . ____________ 00060 _______________________________________________________________________ 00061 */ 00062 00063 #ifndef _SO_DELAY_QUEUE_SENSOR_ 00064 #define _SO_DELAY_QUEUE_SENSOR_ 00065 00066 00067 #include <Inventor/sensors/SoSensor.h> 00068 00071 00108 00109 00110 class INVENTOR_API SoDelayQueueSensor : public SoSensor { 00111 00112 public: 00114 SoDelayQueueSensor(); 00115 SoDelayQueueSensor(SoSensorCB *func, void *data); 00116 00118 virtual ~SoDelayQueueSensor(); 00119 00124 void setPriority(uint32_t pri); 00126 uint32_t getPriority() const { return priority; } 00127 00129 static uint32_t getDefaultPriority() { return 100; } 00130 00143 virtual void schedule(); 00146 virtual void unschedule(); 00150 virtual SbBool isScheduled() const; 00151 00155 virtual SbBool isIdleOnly() const; 00156 SoINTERNAL public: 00160 void setCounter(uint32_t c) { counter = c; } 00161 uint32_t getCounter() const { return counter; } 00162 00163 protected: 00167 virtual void trigger(); 00168 00169 SbBool scheduled; 00170 00171 private: 00172 uint32_t priority; 00173 uint32_t counter; 00174 00177 virtual SbBool isBefore(const SoSensor *s) const; 00178 }; 00179 00180 #endif /* _SO_DELAY_QUEUE_SENSOR_ */