SoEvent.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      : David Mott (MMM yyyy)
** Modified by : Gavin Bell (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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _SO_EVENT_
#define  _SO_EVENT_
 
#include <Inventor/SbBasic.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>
#include <Inventor/SoTypedObject.h>
 
class SbTrackerInfo;

class  SoEvent: public SoTypedObject {
 public:

  SoEvent();
  virtual ~SoEvent();

  virtual SoType      getTypeId() const;

  static SoType       getClassTypeId();

  virtual void        setTime(SbTime t)               { timestamp = t; }
  SbTime              getTime() const                 { return timestamp; }

  virtual void        setPosition(const SbVec2s &p)   { position = p;
                                                        positionFloat[0] = (float)position[0];
                                                        positionFloat[1] = (float)position[1];}

  virtual void        setPosition(const SbVec2f &p)   { positionFloat = p;
                                                        position[0] = (short)positionFloat[0];
                                                        position[1] = (short)positionFloat[1];}
 

  const SbVec2s &     getPosition() const             { return position; }

  const SbVec2f &     getPositionFloat() const             { return positionFloat; }

  const SbVec2s &     getPosition(const SbViewportRegion &vpRgn) const;

  const SbVec2f &     getPositionFloat(const SbViewportRegion &vpRgn) const;

  const SbVec2f & getNormalizedPosition(const SbViewportRegion &vpRgn) const;

  void                setShiftDown(SbBool isDown)     { shiftDown = isDown; }
  void                setCtrlDown(SbBool isDown)      { ctrlDown = isDown; }
  void                setAltDown(SbBool isDown)       { altDown = isDown; }
  void                setButton1Down(SbBool isDown)       { button1Down = isDown; }

  SbBool              wasShiftDown() const            { return shiftDown; }
  SbBool              wasCtrlDown() const             { return ctrlDown; }
  SbBool              wasAltDown() const              { return altDown; }
  SbBool              wasButton1Down() const              { return button1Down; }

  virtual const SbTrackerInfo *getTrackerInfo() const { return NULL; }

  inline SbTrackerInfo* getTrackerInfo();
 
 private:
  // Initializes base event class
  static void         initClass();
  static void exitClass();
 
  // Initialize ALL Inventor event classes
  static void         initClasses();
  static void exitClasses();
 
 private:
  // all of these are set according to when the event occurred
  SbTime              timestamp;   // time the event occurred
  SbBool              shiftDown;   // TRUE if shift key was down
  SbBool              ctrlDown;    // TRUE if ctrl key was down
  SbBool              altDown;     // TRUE if alt key was down
  SbBool              button1Down; // TRUE if first mouse button was down
 
  SbVec2s             position;         // locator position when event occurred
  SbVec2f             positionFloat;    // locator position when event occurred
  SbVec2s             viewportPos;      // position relative to viewport
  SbVec2f             viewportPosFloat;  // position relative to viewport
  SbVec2f             normalizedPos;    // normalized position
 
  static SoType      classTypeId; // base typeId for all events
};
 
SbTrackerInfo* SoEvent::getTrackerInfo()
{
  const ::SoEvent* constEvent = this;
  return const_cast< ::SbTrackerInfo* >(constEvent->getTrackerInfo());
}
 
#endif /* _SO_EVENT_ */