SoHandleEventAction.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoHandleEventAction class
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_HANDLE_EVENT_ACTION_
#define  _SO_HANDLE_EVENT_ACTION_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/actions/SoRayPickAction.h>
 
class SoEvent;
 


 
class INVENTOR_API SoHandleEventAction : public SoAction {
 
    SO_ACTION_HEADER(SoHandleEventAction);
 
  public:

    SoHandleEventAction(const SbViewportRegion &viewportRegion);

    virtual ~SoHandleEventAction();

    void                setViewportRegion(const SbViewportRegion &newRegion);

    const SbViewportRegion &getViewportRegion() const   { return vpRegion; }

    void                setEvent(const SoEvent *ev)     { event = ev; }
    const SoEvent *     getEvent() const                { return event; }

    void                setHandled()            { setTerminated(TRUE); }
    bool                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); }

    const SoPickedPoint *getPickedPoint();

    const SoPickedPointList &getPickedPointList();
 
  SoINTERNAL public:
    static void         initClass();
 
  protected:
    virtual void        beginTraversal(SoNode *node);
 
  private:
    const SoEvent       *event;         
    SoNode              *pickRoot;      
    SoPickedPoint       *pickedPoint;   
    bool                pickValid;      
    bool                usedPickAll;    
    SoRayPickAction     *pickAct;       
    SoNode              *eventGrabber;  
    SbViewportRegion    vpRegion;       
};
 
#endif /* _SO_HANDLE_EVENT_ACTION_ */