00001 /*======================================================================= 00002 * Copyright 1991-1996, Silicon Graphics, Inc. 00003 * ALL RIGHTS RESERVED 00004 * 00005 * UNPUBLISHED -- Rights reserved under the copyright laws of the United 00006 * States. Use of a copyright notice is precautionary only and does not 00007 * imply publication or disclosure. 00008 * 00009 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND: 00010 * Use, duplication or disclosure by the Government is subject to restrictions 00011 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights 00012 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or 00013 * in similar or successor clauses in the FAR, or the DOD or NASA FAR 00014 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc., 00015 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311. 00016 * 00017 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY 00018 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION, 00019 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY 00020 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON 00021 * GRAPHICS, INC. 00022 **=======================================================================*/ 00023 /*======================================================================= 00024 ** Author : David Mott (MMM yyyy) 00025 **=======================================================================*/ 00026 /*======================================================================= 00027 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), *** 00028 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. *** 00029 *** *** 00030 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS *** 00031 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR *** 00032 *** WRITTEN AUTHORIZATION OF FEI S.A.S. *** 00033 *** *** 00034 *** RESTRICTED RIGHTS LEGEND *** 00035 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS *** 00036 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN *** 00037 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT *** 00038 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN *** 00039 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. *** 00040 *** *** 00041 *** COPYRIGHT (C) 1996-2023 BY FEI S.A.S, *** 00042 *** BORDEAUX, FRANCE *** 00043 *** ALL RIGHTS RESERVED *** 00044 **=======================================================================*/ 00045 /*======================================================================= 00046 ** Modified by : VSG (MMM YYYY) 00047 **=======================================================================*/ 00048 00049 00050 #ifndef _SO_EVENT_CALLBACK_ 00051 #define _SO_EVENT_CALLBACK_ 00052 00053 #include <Inventor/misc/SoCallbackList.h> 00054 #include <Inventor/SoPath.h> 00055 #include <Inventor/nodes/SoNode.h> 00056 #include <Inventor/actions/SoHandleEventAction.h> 00057 00058 class SoEvent; 00059 class SoEventCallback; 00060 00061 // callback function prototypes 00065 typedef void SoEventCallbackCB(void *userData, SoEventCallback *node); 00066 00068 // 00069 // Class: SoEventCallback 00070 // 00072 00286 class SoEventCallback : public SoNode { 00287 00288 SO_NODE_HEADER(SoEventCallback); 00289 00290 public: 00295 SoEventCallback(); 00296 00303 void setPath(SoPath *path); 00308 const SoPath * getPath() { return pathOfInterest; } 00309 00321 void addEventCallback(SoType eventType, 00322 SoEventCallbackCB *f, 00323 void *userData = NULL); 00324 00331 template<typename EventType> 00332 void addEventCallback( SoEventCallbackCB* f, void* userData = nullptr ) 00333 { 00334 addEventCallback( EventType::getClassTypeId(), f, userData ); 00335 } 00336 00340 void removeEventCallback(SoType eventType, 00341 SoEventCallbackCB *f, 00342 void *userData = NULL); 00343 00350 template<typename EventType> 00351 void removeEventCallback( SoEventCallbackCB* f, void* userData = nullptr ) 00352 { 00353 removeEventCallback( EventType::getClassTypeId(), f, userData ); 00354 } 00355 00357 // 00358 // These all provide information to callback functions. They 00359 // return NULL when called from anywhere but a callback function. 00360 // 00361 00366 SoHandleEventAction * getAction() const { return eventAction; } 00367 00372 const SoEvent * getEvent() const 00373 { return (eventAction != NULL ? eventAction->getEvent() : NULL); } 00374 00390 const SoPickedPoint * getPickedPoint() const 00391 { return (eventAction != NULL ? eventAction->getPickedPoint() : NULL);} 00392 00393 // 00395 00403 void setHandled() 00404 { if (eventAction != NULL) eventAction->setHandled(); } 00405 00410 SbBool isHandled() const 00411 { return (eventAction != NULL) ? eventAction->isHandled() : FALSE; } 00412 00418 void grabEvents() 00419 { if (eventAction != NULL) eventAction->setGrabber(this); } 00420 00425 void releaseEvents() 00426 { if (eventAction != NULL) eventAction->releaseGrabber(); } 00427 00428 private: 00429 // This will be called during handleEventAction traversal. 00430 virtual void handleEvent(SoHandleEventAction *ha); 00431 00432 private: 00433 static void initClass(); // initialize the class 00434 static void exitClass(); 00435 00436 private: 00437 // Destructor - protected since ref/unref is what should destroy this 00438 virtual ~SoEventCallback(); 00439 00440 private: 00441 // Only invoke callbacks if this path was picked. 00442 // If path is NULL, always invoke callbacks. 00443 SoPath *pathOfInterest; 00444 00445 // List of callback functions, event types, and user data. 00446 SbPList * cblist; 00447 00448 // This is set for each SoHandleEventAction traversal of this node 00449 // so that the apps callback routine can invoke methods on the action. 00450 SoHandleEventAction *eventAction; 00451 }; 00452 00453 #endif /* _SO_EVENT_CALLBACK_ */ 00454 00455