SoEventCallback.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:
 |      SoEventCallback node class - invokes callbacks when the handle
 |   event action is applied to this node.
 |
 |   Author(s): David Mott
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_EVENT_CALLBACK_
#define  _SO_EVENT_CALLBACK_
 
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/SoPath.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/actions/SoHandleEventAction.h>
 
class SoEvent;
class SoEventCallback;
 
typedef void INVENTOR_API SoEventCallbackCB(void *userData, SoEventCallback *node);
 
 
 
 
class INVENTOR_API 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);
    void                removeEventCallback(SoType eventType,
                                            SoEventCallbackCB *f,
                                            void *userData = NULL);
 
    //
    // 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(); }
 
    bool                isHandled() const
        { return (eventAction != NULL) ? eventAction->isHandled() : FALSE; }
 
    void                grabEvents()
        { if (eventAction != NULL) eventAction->setGrabber(this); }
 
    void                releaseEvents()
        { if (eventAction != NULL) eventAction->releaseGrabber(); }
 
  SoINTERNAL public:
    static void         initClass();    
 
  protected:
    virtual ~SoEventCallback();
 
    virtual void        handleEvent(SoHandleEventAction *ha);
    
  private:
    SoPath              *pathOfInterest;
    
    SbPList *           cblist;
    
    SoHandleEventAction *eventAction;
    
    void                invokeCallbacks(const SoEvent *e);
};
 
#endif /* _SO_EVENT_CALLBACK_ */