Slicer  5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMRMLInteractionEventData Class Reference

#include <Libs/MRML/DisplayableManager/vtkMRMLInteractionEventData.h>

Inheritance diagram for vtkMRMLInteractionEventData:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLInteractionEventData:
Collaboration graph
[legend]

Public Types

enum  MRMLInteractionEvents { LeftButtonClickEvent = vtkCommand::UserEvent + 300, MiddleButtonClickEvent, RightButtonClickEvent }
 Extends vtkCommand events. More...
 
typedef vtkEventDataDevice3D Superclass
 

Public Member Functions

vtkCellPicker * GetAccuratePicker () const
 
virtual const char * GetClassName ()
 
int GetComponentIndex () const
 
int GetComponentType () const
 
void GetDisplayPosition (int v[2]) const
 
const int * GetDisplayPosition () const
 
const std::string & GetInteractionContextName ()
 
char GetKeyCode ()
 
int GetKeyRepeatCount ()
 
const std::string & GetKeySym ()
 
double GetLastRotation () const
 
double GetLastScale () const
 
const double * GetLastTranslation () const
 
int GetModifiers ()
 
bool GetMouseMovedSinceButtonDown () const
 
vtkRenderer * GetRenderer () const
 
double GetRotation () const
 
double GetScale () const
 
const double * GetTranslation () const
 
vtkMRMLAbstractViewNodeGetViewNode () const
 
double GetWorldToPhysicalScale () const
 
virtual int IsA (const char *type)
 
bool IsDisplayPositionValid ()
 
void SetAccuratePicker (vtkCellPicker *picker)
 
void SetAttributesFromInteractor (vtkRenderWindowInteractor *interactor)
 Set Modifiers and Key... attributes from interactor. More...
 
void SetComponentIndex (int componentIndex)
 
void SetComponentType (int componentType)
 
void SetDisplayPosition (const int p[2])
 
void SetDisplayPositionInvalid ()
 
void SetInteractionContextName (const std::string &v)
 
void SetKeyCode (char v)
 
void SetKeyRepeatCount (char v)
 
void SetKeySym (const std::string &v)
 
void SetLastRotation (double v)
 
void SetLastScale (double scale)
 
void SetLastTranslation (const double translation[2])
 
void SetModifiers (int v)
 
void SetMouseMovedSinceButtonDown (bool moved)
 
void SetRenderer (vtkRenderer *ren)
 
void SetRotation (double v)
 
void SetScale (double scale)
 
void SetTranslation (const double translation[2])
 
void SetType (unsigned long v)
 
void SetViewNode (vtkMRMLAbstractViewNode *viewNode)
 
void SetWorldToPhysicalScale (double v)
 
void WorldToDisplay (const double worldPosition[3], double displayPosition[3])
 
void SetWorldPosition (const double p[3], bool accurate=true)
 
bool IsWorldPositionValid ()
 
bool IsWorldPositionAccurate ()
 
void SetWorldPositionInvalid ()
 
bool ComputeAccurateWorldPosition (bool force=false)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLInteractionEventDataNew ()
 
static vtkMRMLInteractionEventDataSafeDownCast (vtkObject *o)
 

Protected Member Functions

bool Equivalent (const vtkEventData *e) const override
 
 vtkMRMLInteractionEventData ()
 
 ~vtkMRMLInteractionEventData () override=default
 

Protected Attributes

vtkCellPicker * AccuratePicker
 
int ComponentIndex
 
int ComponentType
 
bool ComputeAccurateWorldPositionAttempted
 
int DisplayPosition [2]
 
bool DisplayPositionValid
 
std::string InteractionContextName
 Name of interaction context. In case of the mouse, it is empty string. More...
 
int Modifiers
 
bool MouseMovedSinceButtonDown
 
vtkRenderer * Renderer
 
vtkMRMLAbstractViewNodeViewNode
 
bool WorldPositionAccurate
 
bool WorldPositionValid
 
double WorldToPhysicalScale
 
double WorldToViewTransformMatrix [16]
 
bool WorldToViewTransformMatrixValid
 
char KeyCode
 For KeyPressEvent. More...
 
int KeyRepeatCount
 
std::string KeySym
 
double Rotation
 macOS touchpad events More...
 
double LastRotation
 
double Scale
 
double LastScale
 
double Translation [2]
 
double LastTranslation [2]
 

Detailed Description

Class for storing all relevant details of mouse and keyboard events. It stores additional information that is expensive to compute (such as 3D position) or not always easy to get (such as modifiers).

Definition at line 35 of file vtkMRMLInteractionEventData.h.

Member Typedef Documentation

◆ Superclass

typedef vtkEventDataDevice3D vtkMRMLInteractionEventData::Superclass

Definition at line 38 of file vtkMRMLInteractionEventData.h.

Member Enumeration Documentation

◆ MRMLInteractionEvents

Extends vtkCommand events.

Enumerator
LeftButtonClickEvent 
MiddleButtonClickEvent 
RightButtonClickEvent 

Definition at line 42 of file vtkMRMLInteractionEventData.h.

Constructor & Destructor Documentation

◆ vtkMRMLInteractionEventData()

vtkMRMLInteractionEventData::vtkMRMLInteractionEventData ( )
protected

◆ ~vtkMRMLInteractionEventData()

vtkMRMLInteractionEventData::~vtkMRMLInteractionEventData ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeAccurateWorldPosition()

bool vtkMRMLInteractionEventData::ComputeAccurateWorldPosition ( bool  force = false)

◆ Equivalent()

bool vtkMRMLInteractionEventData::Equivalent ( const vtkEventData *  e) const
overrideprotected

◆ GetAccuratePicker()

vtkCellPicker* vtkMRMLInteractionEventData::GetAccuratePicker ( ) const

◆ GetClassName()

virtual const char* vtkMRMLInteractionEventData::GetClassName ( )
virtual

◆ GetComponentIndex()

int vtkMRMLInteractionEventData::GetComponentIndex ( ) const

◆ GetComponentType()

int vtkMRMLInteractionEventData::GetComponentType ( ) const

◆ GetDisplayPosition() [1/2]

void vtkMRMLInteractionEventData::GetDisplayPosition ( int  v[2]) const

◆ GetDisplayPosition() [2/2]

const int* vtkMRMLInteractionEventData::GetDisplayPosition ( ) const

◆ GetInteractionContextName()

const std::string& vtkMRMLInteractionEventData::GetInteractionContextName ( )

◆ GetKeyCode()

char vtkMRMLInteractionEventData::GetKeyCode ( )

◆ GetKeyRepeatCount()

int vtkMRMLInteractionEventData::GetKeyRepeatCount ( )

◆ GetKeySym()

const std::string& vtkMRMLInteractionEventData::GetKeySym ( )

◆ GetLastRotation()

double vtkMRMLInteractionEventData::GetLastRotation ( ) const

◆ GetLastScale()

double vtkMRMLInteractionEventData::GetLastScale ( ) const

◆ GetLastTranslation()

const double* vtkMRMLInteractionEventData::GetLastTranslation ( ) const

◆ GetModifiers()

int vtkMRMLInteractionEventData::GetModifiers ( )

◆ GetMouseMovedSinceButtonDown()

bool vtkMRMLInteractionEventData::GetMouseMovedSinceButtonDown ( ) const

◆ GetRenderer()

vtkRenderer* vtkMRMLInteractionEventData::GetRenderer ( ) const

◆ GetRotation()

double vtkMRMLInteractionEventData::GetRotation ( ) const

◆ GetScale()

double vtkMRMLInteractionEventData::GetScale ( ) const

◆ GetTranslation()

const double* vtkMRMLInteractionEventData::GetTranslation ( ) const

◆ GetViewNode()

vtkMRMLAbstractViewNode* vtkMRMLInteractionEventData::GetViewNode ( ) const

◆ GetWorldToPhysicalScale()

double vtkMRMLInteractionEventData::GetWorldToPhysicalScale ( ) const

◆ IsA()

virtual int vtkMRMLInteractionEventData::IsA ( const char *  type)
virtual

◆ IsDisplayPositionValid()

bool vtkMRMLInteractionEventData::IsDisplayPositionValid ( )

◆ IsTypeOf()

static int vtkMRMLInteractionEventData::IsTypeOf ( const char *  type)
static

◆ IsWorldPositionAccurate()

bool vtkMRMLInteractionEventData::IsWorldPositionAccurate ( )

◆ IsWorldPositionValid()

bool vtkMRMLInteractionEventData::IsWorldPositionValid ( )

◆ New()

static vtkMRMLInteractionEventData* vtkMRMLInteractionEventData::New ( )
static

◆ SafeDownCast()

static vtkMRMLInteractionEventData* vtkMRMLInteractionEventData::SafeDownCast ( vtkObject *  o)
static

◆ SetAccuratePicker()

void vtkMRMLInteractionEventData::SetAccuratePicker ( vtkCellPicker *  picker)

◆ SetAttributesFromInteractor()

void vtkMRMLInteractionEventData::SetAttributesFromInteractor ( vtkRenderWindowInteractor *  interactor)

Set Modifiers and Key... attributes from interactor.

◆ SetComponentIndex()

void vtkMRMLInteractionEventData::SetComponentIndex ( int  componentIndex)

◆ SetComponentType()

void vtkMRMLInteractionEventData::SetComponentType ( int  componentType)

◆ SetDisplayPosition()

void vtkMRMLInteractionEventData::SetDisplayPosition ( const int  p[2])

◆ SetDisplayPositionInvalid()

void vtkMRMLInteractionEventData::SetDisplayPositionInvalid ( )

◆ SetInteractionContextName()

void vtkMRMLInteractionEventData::SetInteractionContextName ( const std::string &  v)

◆ SetKeyCode()

void vtkMRMLInteractionEventData::SetKeyCode ( char  v)

◆ SetKeyRepeatCount()

void vtkMRMLInteractionEventData::SetKeyRepeatCount ( char  v)

◆ SetKeySym()

void vtkMRMLInteractionEventData::SetKeySym ( const std::string &  v)

◆ SetLastRotation()

void vtkMRMLInteractionEventData::SetLastRotation ( double  v)

◆ SetLastScale()

void vtkMRMLInteractionEventData::SetLastScale ( double  scale)

◆ SetLastTranslation()

void vtkMRMLInteractionEventData::SetLastTranslation ( const double  translation[2])

◆ SetModifiers()

void vtkMRMLInteractionEventData::SetModifiers ( int  v)

◆ SetMouseMovedSinceButtonDown()

void vtkMRMLInteractionEventData::SetMouseMovedSinceButtonDown ( bool  moved)

◆ SetRenderer()

void vtkMRMLInteractionEventData::SetRenderer ( vtkRenderer *  ren)

◆ SetRotation()

void vtkMRMLInteractionEventData::SetRotation ( double  v)

◆ SetScale()

void vtkMRMLInteractionEventData::SetScale ( double  scale)

◆ SetTranslation()

void vtkMRMLInteractionEventData::SetTranslation ( const double  translation[2])

◆ SetType()

void vtkMRMLInteractionEventData::SetType ( unsigned long  v)

◆ SetViewNode()

void vtkMRMLInteractionEventData::SetViewNode ( vtkMRMLAbstractViewNode viewNode)

◆ SetWorldPosition()

void vtkMRMLInteractionEventData::SetWorldPosition ( const double  p[3],
bool  accurate = true 
)

It may be expensive to compute world position accurately (e.g., in a 3D view). If accurate parameter is set to false then it indicates that the position may be inaccurate.

◆ SetWorldPositionInvalid()

void vtkMRMLInteractionEventData::SetWorldPositionInvalid ( )

◆ SetWorldToPhysicalScale()

void vtkMRMLInteractionEventData::SetWorldToPhysicalScale ( double  v)

◆ WorldToDisplay()

void vtkMRMLInteractionEventData::WorldToDisplay ( const double  worldPosition[3],
double  displayPosition[3] 
)

Member Data Documentation

◆ AccuratePicker

vtkCellPicker* vtkMRMLInteractionEventData::AccuratePicker
protected

Definition at line 129 of file vtkMRMLInteractionEventData.h.

◆ ComponentIndex

int vtkMRMLInteractionEventData::ComponentIndex
protected

Definition at line 131 of file vtkMRMLInteractionEventData.h.

◆ ComponentType

int vtkMRMLInteractionEventData::ComponentType
protected

Definition at line 130 of file vtkMRMLInteractionEventData.h.

◆ ComputeAccurateWorldPositionAttempted

bool vtkMRMLInteractionEventData::ComputeAccurateWorldPositionAttempted
protected

Definition at line 126 of file vtkMRMLInteractionEventData.h.

◆ DisplayPosition

int vtkMRMLInteractionEventData::DisplayPosition[2]
protected

Definition at line 122 of file vtkMRMLInteractionEventData.h.

◆ DisplayPositionValid

bool vtkMRMLInteractionEventData::DisplayPositionValid
protected

Definition at line 123 of file vtkMRMLInteractionEventData.h.

◆ InteractionContextName

std::string vtkMRMLInteractionEventData::InteractionContextName
protected

Name of interaction context. In case of the mouse, it is empty string.

Definition at line 159 of file vtkMRMLInteractionEventData.h.

◆ KeyCode

char vtkMRMLInteractionEventData::KeyCode
protected

For KeyPressEvent.

Definition at line 138 of file vtkMRMLInteractionEventData.h.

◆ KeyRepeatCount

int vtkMRMLInteractionEventData::KeyRepeatCount
protected

Definition at line 139 of file vtkMRMLInteractionEventData.h.

◆ KeySym

std::string vtkMRMLInteractionEventData::KeySym
protected

Definition at line 140 of file vtkMRMLInteractionEventData.h.

◆ LastRotation

double vtkMRMLInteractionEventData::LastRotation
protected

Definition at line 147 of file vtkMRMLInteractionEventData.h.

◆ LastScale

double vtkMRMLInteractionEventData::LastScale
protected

Definition at line 149 of file vtkMRMLInteractionEventData.h.

◆ LastTranslation

double vtkMRMLInteractionEventData::LastTranslation[2]
protected

Definition at line 151 of file vtkMRMLInteractionEventData.h.

◆ Modifiers

int vtkMRMLInteractionEventData::Modifiers
protected

Definition at line 121 of file vtkMRMLInteractionEventData.h.

◆ MouseMovedSinceButtonDown

bool vtkMRMLInteractionEventData::MouseMovedSinceButtonDown
protected

Definition at line 132 of file vtkMRMLInteractionEventData.h.

◆ Renderer

vtkRenderer* vtkMRMLInteractionEventData::Renderer
protected

Definition at line 128 of file vtkMRMLInteractionEventData.h.

◆ Rotation

double vtkMRMLInteractionEventData::Rotation
protected

macOS touchpad events

Definition at line 146 of file vtkMRMLInteractionEventData.h.

◆ Scale

double vtkMRMLInteractionEventData::Scale
protected

Definition at line 148 of file vtkMRMLInteractionEventData.h.

◆ Translation

double vtkMRMLInteractionEventData::Translation[2]
protected

Definition at line 150 of file vtkMRMLInteractionEventData.h.

◆ ViewNode

vtkMRMLAbstractViewNode* vtkMRMLInteractionEventData::ViewNode
protected

Definition at line 127 of file vtkMRMLInteractionEventData.h.

◆ WorldPositionAccurate

bool vtkMRMLInteractionEventData::WorldPositionAccurate
protected

Definition at line 125 of file vtkMRMLInteractionEventData.h.

◆ WorldPositionValid

bool vtkMRMLInteractionEventData::WorldPositionValid
protected

Definition at line 124 of file vtkMRMLInteractionEventData.h.

◆ WorldToPhysicalScale

double vtkMRMLInteractionEventData::WorldToPhysicalScale
protected

For VR events World to physical scale: Value greater than 1 means that objects appear larger in VR than their real world size.

Definition at line 156 of file vtkMRMLInteractionEventData.h.

◆ WorldToViewTransformMatrix

double vtkMRMLInteractionEventData::WorldToViewTransformMatrix[16]
protected

Definition at line 133 of file vtkMRMLInteractionEventData.h.

◆ WorldToViewTransformMatrixValid

bool vtkMRMLInteractionEventData::WorldToViewTransformMatrixValid
protected

Definition at line 134 of file vtkMRMLInteractionEventData.h.


The documentation for this class was generated from the following file: