SoEvent.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,92   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 $
 |
 |   Classes:
 |      SoEvent
 |
 |   Author(s): David Mott, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_EVENT_
#define  _SO_EVENT_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>
#include <Inventor/SoType.h>
 
 
 
class INVENTOR_API SoEvent {
  public:
 
    enum MouseButtonsMask {
      NO_MOUSEBUTTON_MASK = 0,
      LEFT_MOUSEBUTTON_MASK = 1,
      MIDDLE_MOUSEBUTTON_MASK = 2,
      RIGHT_MOUSEBUTTON_MASK = 4,
      ALL_MOUSEBUTTONS_MASK = LEFT_MOUSEBUTTON_MASK + MIDDLE_MOUSEBUTTON_MASK + RIGHT_MOUSEBUTTON_MASK
    };
 
    SoEvent();
    virtual ~SoEvent();
 
    virtual SoType      getTypeId() const;
 
    static SoType       getClassTypeId() { return classTypeId; }
 
    bool                isOfType(SoType type) const;
 
    void                setTime(SbTime t)               { timestamp = t; }
    SbTime              getTime() const                 { return timestamp; }
 
    void                setPosition(const SbVec2s &p)   { position = p; }
 
    const SbVec2s &     getPosition() const             { return position; }
 
    const SbVec2s &     getPosition(const SbViewportRegion &vpRgn) const;
 
    const SbVec2f & getNormalizedPosition(const SbViewportRegion &vpRgn) const;
 
    void                setShiftDown(bool isDown)     { shiftDown = isDown; }
    void                setCtrlDown(bool isDown)      { ctrlDown = isDown; }
    void                setAltDown(bool isDown)       { altDown = isDown; }
 
    bool                wasShiftDown() const            { return shiftDown; }
    bool                wasCtrlDown() const             { return ctrlDown; }
    bool                wasAltDown() const              { return altDown; }
    
    void                setMouseButtonMask(int mask)    { mouseButtonMask = mask; }
    int                 getMouseButtonMask() const      { return mouseButtonMask; }
 
  SoINTERNAL public:
    static void         initClass();
 
    static void         initClasses();
    
  private:
    SbTime              timestamp;  
    bool                shiftDown;  
    bool                ctrlDown;   
    bool                altDown;    
 
    int                 mouseButtonMask; 
 
    SbVec2s             position;   
    SbVec2s             viewportPos;    
    SbVec2f             normalizedPos;  
 
    static SoType       classTypeId; 
};
 
 
#endif /* _SO_EVENT_ */