SoEventCallback.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : David Mott (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_EVENT_CALLBACK_
#define  _SO_EVENT_CALLBACK_
 
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/SoPath.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/actions/SoHandleEventAction.h>
 
class SoEvent;
class SoEventCallback;
 
// callback function prototypes
typedef void SoEventCallbackCB(void *userData, SoEventCallback *node);
 
//
//  Class: SoEventCallback
//
 
class  SoEventCallback : public SoNode {
 
  SO_NODE_HEADER(SoEventCallback);
 
 public:
  SoEventCallback();
    
  void                setPath(SoPath *path);
  const SoPath *      getPath()               { return pathOfInterest; }
 
  void                addEventCallback(SoType eventType,
                                       SoEventCallbackCB *f,
                                       void *userData = NULL);
 
  template<typename EventType>
  void addEventCallback( SoEventCallbackCB* f, void* userData = nullptr )
  {
    addEventCallback( EventType::getClassTypeId(), f, userData );
  }
 
  void                removeEventCallback(SoType eventType,
                                          SoEventCallbackCB *f,
                                          void *userData = NULL);
 
  template<typename EventType>
  void removeEventCallback( SoEventCallbackCB* f, void* userData = nullptr )
  {
    removeEventCallback( EventType::getClassTypeId(), f, userData );
  }
 
  //
  // These all provide information to callback functions. They
  // return NULL when called from anywhere but a callback function.
  //
    
  SoHandleEventAction *       getAction() const { return eventAction; }
 
  const SoEvent *             getEvent() const
    { return (eventAction != NULL ? eventAction->getEvent() : NULL); }
 
  const SoPickedPoint *       getPickedPoint() const
    { return (eventAction != NULL ? eventAction->getPickedPoint() : NULL);}
    
  //
 
  void                setHandled()
    { if (eventAction != NULL) eventAction->setHandled(); }
 
  SbBool              isHandled() const
    { return (eventAction != NULL) ? eventAction->isHandled() : FALSE; }
    
  void                grabEvents()
    { if (eventAction != NULL) eventAction->setGrabber(this); }
 
  void                releaseEvents()
    { if (eventAction != NULL) eventAction->releaseGrabber(); }
 
 private:
  // This will be called during handleEventAction traversal.
  virtual void        handleEvent(SoHandleEventAction *ha);
 
 private:
  static void         initClass();    // initialize the class
  static void         exitClass();
 
 private:
  // Destructor - protected since ref/unref is what should destroy this
  virtual ~SoEventCallback();
    
 private:
  // Only invoke callbacks if this path was picked.
  // If path is NULL, always invoke callbacks.
  SoPath              *pathOfInterest;
    
  // List of callback functions, event types, and user data.
  SbPList *           cblist;
    
  // This is set for each SoHandleEventAction traversal of this node
  // so that the apps callback routine can invoke methods on the action.
  SoHandleEventAction *eventAction;
};
 
#endif /* _SO_EVENT_CALLBACK_ */