SoHandleEventAction.h

/*=======================================================================
 * 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      : Paul S. Strauss (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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_HANDLE_EVENT_ACTION_
#define  _SO_HANDLE_EVENT_ACTION_
 
#include <Inventor/SbViewportRegion.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/actions/SoRayPickAction.h>
 
class SoEvent;
class SoPickedPoint;
 
//
//  Class: SoHandleEventAction
//
//  Event handling action. This traverses a graph looking for a node
//  or nodes interested in a particular event.
//
 
class  SoHandleEventAction : public SoAction {
 
  SO_ACTION_HEADER(SoHandleEventAction);
 
 public:
  SoHandleEventAction(const SbViewportRegion &viewportRegion);
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoHandleEventAction();
#endif // HIDDEN_FROM_DOC
 
  void                setViewportRegion(const SbViewportRegion &newRegion);
 
 
  const SbViewportRegion &getViewportRegion() const   { return vpRegion; }
 
  virtual void clearApplyResult();
 
  void                setEvent(const SoEvent *ev)     { event = ev; }
  const SoEvent *     getEvent() const                { return event; }
 
  void                setHandled()            { setTerminated(TRUE); }
  SbBool              isHandled() const       { return hasTerminated(); }
 
  void                setGrabber(SoNode *node);
  void                releaseGrabber()            { setGrabber(NULL); }
  SoNode *            getGrabber() const          { return eventGrabber; }
 
  void                setPickRoot(SoNode *node);
  SoNode *            getPickRoot() const             { return pickRoot; }
 
  void                setPickRadius(float radiusInPixels) 
    { pickAct->setRadius(radiusInPixels); }
 
  float               getPickRadius() const
    { return pickAct->getRadius(); }
 
  void enableRadiusForTriangles(SbBool flag);
 
  const SoPickedPoint *getPickedPoint();
 
  const SoPickedPointList &getPickedPointList();
 
 private:
  void                setPickedPoint( SoPickedPoint *point = NULL );
 
 private:
  static void         initClass();
  static void         exitClass();
 
 private:
  // Initiates action on graph
  virtual void        beginTraversal(SoNode *node);
 
 private:
  const SoEvent       *event;         // Event being handled
  SoNode              *pickRoot;      // Root node for initiating picking
  SoPickedPoint       *pickedPoint;   // PickedPoint from last pick
  SbBool              pickValid;      // Whether last pick is still valid
  SbBool              usedPickAll;    // TRUE if last pick used pickAll=TRUE
  SoRayPickAction     *pickAct;       // Pick action
  SoNode              *eventGrabber;  // Event grabber - gets all events
  SbViewportRegion    vpRegion;       // Current viewport region
  SbBool              pickedPtSet;    // TRUE if picked pt was set by app
 
};
 
#endif /* _SO_HANDLE_EVENT_ACTION_ */