SoPointerPosition.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2008, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_POINTER_POSITION_H
#define SO_POINTER_POSITION_H
 
#include "SoManagedInteractionSystem.h"
 
class SoState;
class SoHandleEventAction;
class SoInteractionHandler;
 
// This class is used by SoView2DExtensions for additional data, do not use
// it for other purposes!
class View2DPosition;
 
class SOMANAGEDINTERACTION_API SoPointerPosition
{
  friend class SoInteractionHandler;
 
public:
  SoPointerPosition();
 
  // Constructor given an array of two components.
  SoPointerPosition(const int v[2]);
 
  // Constructor given two individual components.
  SoPointerPosition(int x, int y);
 
  // Default copy constructor.
  SoPointerPosition(const SoPointerPosition& other) = default;
 
  bool isNull() const;
 
  int manhattanLength() const;
 
  int x() const { return _vec[0]; }
  int y() const { return _vec[1]; }
 
  void getValue(int &x, int &y) const;
 
  SoPointerPosition & setValue(const int v[2]);
 
  SoPointerPosition & setValue(int x, int y);
 
  int  operator [](int i) const { return (_vec[i]); }
 
  SoPointerPosition& operator =(const SoPointerPosition &u);
 
  friend SOMANAGEDINTERACTION_API bool operator ==(const SoPointerPosition &v1, const SoPointerPosition &v2);
  friend SOMANAGEDINTERACTION_API bool operator !=(const SoPointerPosition &v1, const SoPointerPosition &v2)
    { return !(v1 == v2); }
 
  SoHandleEventAction* getAction() const { return _action; }
 
  SoState* getState() const;
 
  template <class T>
  void set(T* data) { _data = data; }
 
  template <class T>
  T* get() const { return static_cast<T*>(_data); }
 
  const View2DPosition* getView2DPosition() const { return get<View2DPosition>(); }
 
private:
  void setAction(SoHandleEventAction* action) { _action = action; }
 
  int _vec[2];
 
  // The action from which the event originated, from which the position was taken
  SoHandleEventAction* _action;
 
  // This pointer is used by SoView2D and SoDiagram2D for additional data:
  void* _data;
};
 
#endif  // __SoPointerPosition_H