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 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 | SoEventCallback node class - invokes callbacks when the handle 00048 | event action is applied to this node. 00049 | 00050 | Author(s): David Mott 00051 | 00052 ______________ S I L I C O N G R A P H I C S I N C . ____________ 00053 _______________________________________________________________________ 00054 */ 00055 00056 #ifndef _SO_EVENT_CALLBACK_ 00057 #define _SO_EVENT_CALLBACK_ 00058 00059 #include <Inventor/misc/SoCallbackList.h> 00060 #include <Inventor/SoPath.h> 00061 #include <Inventor/nodes/SoSubNode.h> 00062 #include <Inventor/actions/SoHandleEventAction.h> 00063 00064 class SoEvent; 00065 class SoEventCallback; 00066 00068 typedef void INVENTOR_API SoEventCallbackCB(void *userData, SoEventCallback *node); 00069 00070 00073 00095 00096 00097 class INVENTOR_API SoEventCallback : public SoNode { 00098 00099 SO_NODE_HEADER(SoEventCallback); 00100 00101 public: 00102 00105 SoEventCallback(); 00106 00108 void setPath(SoPath *path); 00116 const SoPath * getPath() { return pathOfInterest; } 00117 00129 void addEventCallback(SoType eventType, 00130 SoEventCallbackCB *f, 00131 void *userData = NULL); 00133 void removeEventCallback(SoType eventType, 00134 SoEventCallbackCB *f, 00135 void *userData = NULL); 00136 00138 // 00139 // These all provide information to callback functions. They 00140 // return NULL when called from anywhere but a callback function. 00141 // 00142 00146 SoHandleEventAction * getAction() const { return eventAction; } 00147 00151 const SoEvent * getEvent() const 00152 { return (eventAction != NULL ? eventAction->getEvent() : NULL); } 00153 00157 const SoPickedPoint * getPickedPoint() const 00158 { return (eventAction != NULL ? eventAction->getPickedPoint() : NULL);} 00159 00161 00169 void setHandled() 00170 { if (eventAction != NULL) eventAction->setHandled(); } 00171 00174 SbBool isHandled() const 00175 { return (eventAction != NULL) ? eventAction->isHandled() : FALSE; } 00176 00181 void grabEvents() 00182 { if (eventAction != NULL) eventAction->setGrabber(this); } 00183 00186 void releaseEvents() 00187 { if (eventAction != NULL) eventAction->releaseGrabber(); } 00188 00189 SoINTERNAL public: 00190 static void initClass(); 00191 00192 protected: 00194 virtual ~SoEventCallback(); 00195 00197 virtual void handleEvent(SoHandleEventAction *ha); 00198 00199 private: 00202 SoPath *pathOfInterest; 00203 00205 SbPList * cblist; 00206 00209 SoHandleEventAction *eventAction; 00210 00213 void invokeCallbacks(const SoEvent *e); 00214 }; 00215 00216 #endif /* _SO_EVENT_CALLBACK_ */