SoControllerButtonEvent.h

/*=======================================================================
 *** 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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Modified (MMM yyyy)
**=======================================================================*/
 
#ifndef  _SO_CONTROLLER_BUTTON_EVENT_
#define  _SO_CONTROLLER_BUTTON_EVENT_
 
#include <Inventor/events/SoButtonEvent.h>
#include <Inventor/events/SbTrackerInfo.h>
 
// some convenience macros for determining if an event matches
 
#define SO_CONTROLLER_PRESS_EVENT(EVENT,BUTTON) \
    (SoControllerButtonEvent::isButtonPressEvent(EVENT,SoControllerButtonEvent::BUTTON))
 
#define SO_CONTROLLER_RELEASE_EVENT(EVENT,BUTTON) \
    (SoControllerButtonEvent::isButtonReleaseEvent(EVENT,SoControllerButtonEvent::BUTTON))
 

class  SoControllerButtonEvent : public SoButtonEvent {
 
  SO_EVENT_HEADER();
 
 public:

  enum Button {
    ANY     = 0,
    BUTTON1 = 1,
    BUTTON2 = 2,
    BUTTON3 = 3
  };

  SoControllerButtonEvent();
#ifndef HIDDEN_FROM_DOC
  virtual ~SoControllerButtonEvent();
#endif // HIDDEN_FROM_DOC

  void                setButton(SoControllerButtonEvent::Button b)  { button = b; }
  SoControllerButtonEvent::Button     getButton() const { return button; }

  void                setPosition3(const SbVec3f &p)
    { m_trackerInfo.setPosition3( p ); }

  const SbVec3f &     getPosition3() const
    { return m_trackerInfo.getPosition3(); }

  void  setOrientation( float x, float y, float z)
    { m_trackerInfo.setOrientation( x, y, z ); }

  void  setOrientation( SbRotation orientation )
    { m_trackerInfo.setOrientation( orientation ); }

  void  setOrientation(const SbVec3f &axis, float angle)
    { m_trackerInfo.setOrientation( axis, angle ); }

  const SbRotation & getOrientation() const
    { return m_trackerInfo.getOrientation(); }

  const SbLine getRay() const
    { return m_trackerInfo.getRay(); }
 
 
  // Imports declaration from SoEvent.
  using SoEvent::getTrackerInfo;

  virtual const SbTrackerInfo *getTrackerInfo() const
    { return &m_trackerInfo; }

  virtual const SbTrackerInfo & trackerInfo() const
    { return m_trackerInfo; }

  static SbBool       isButtonPressEvent(
                                         const SoEvent *e,
                                         SoControllerButtonEvent::Button whichButton);

  static SbBool       isButtonReleaseEvent(
                                           const SoEvent *e,
                                           SoControllerButtonEvent::Button whichButton);
 
 private:
  static void         initClass();
  static void exitClass();
 
 private:
  Button        button;       // which button
  SbTrackerInfo m_trackerInfo;
 
};
 
#endif /* _SO_CONTROLLER_BUTTON_EVENT_ */