mitkManipulator Class Reference

mitkManipulator - an abstract class to define an interface to implement mouse events processing in a scene More...

#include <mitkManipulator.h>

Inherits mitkObject.

Inherited by mitkImageViewManipulatorStandard, mitkMeshViewManipulatorStandard, and mitkPickManipulator.

Inheritance diagram for mitkManipulator:

[legend]Collaboration diagram for mitkManipulator:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
void	OnMouseDown (int mouseButton, bool ctrlDown, bool shiftDown, int xPos, int yPos)
void	OnMouseUp (int mouseButton, bool ctrlDown, bool shiftDown, int xPos, int yPos)
void	OnMouseMove (bool ctrlDown, bool shiftDown, int xPos, int yPos)
void	OnMouseWheel (bool ctrlDown, bool shiftDown, int xPos, int yPos, int delta)
void	SetScene (mitkScene *scene)
void	SetView (mitkView *view)
void	EnableLoD (bool enable=true)
bool	IsLoDEnabled ()

---

Detailed Description

mitkManipulator - an abstract class to define an interface to implement mouse events processing in a scene

mitkManipulator is an abstract class to define an interface to implement mouse events processing in a scene. Its purpose is to provide user a chance to override the default mouse events processing. All of its subclasses must implement OnMouseDown(), OnMouseUp(), OnMouseMove() functions to process mouse events in a scene properly.

---

Member Function Documentation

void mitkManipulator::EnableLoD (  bool  enable = true  )  [inline]

Enable or disable LoD mode. Parameters: enable  ture = enable LoD mode; false = disable LoD mode Note: It is only a hint to rendering method and depends on actual implementation. Maybe it will not take any effect.

bool mitkManipulator::IsLoDEnabled (   )  [inline]

Test if the LoD mode is enabled. Returns: Return true if the LoD mode is enabled, otherwise return false.

void mitkManipulator::OnMouseDown (  int  mouseButton, bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )

Deal with mouse down event. Parameters: mouseButton  indicates which mouse button is pressed ctrlDown  indicates if the key "Ctrl" is pressed shiftDown  indicates if the key "Shift" is pressed xPos  x-coordinate of the mouse position when mouse down event occurs yPos  y-coordinate of the mouse position when mouse down event occurs

void mitkManipulator::OnMouseMove (  bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )

Deal with mouse move event. Parameters: ctrlDown  indicates if the key "Ctrl" is pressed shiftDown  indicates if the key "Shift" is pressed xPos  x-coordinate of the mouse position when mouse move event occurs yPos  y-coordinate of the mouse position when mouse move event occurs

void mitkManipulator::OnMouseUp (  int  mouseButton, bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )

Deal with mouse up event. Parameters: mouseButton  indicates which mouse button was pressed and now released ctrlDown  indicates if the key "Ctrl" is pressed shiftDown  indicates if the key "Shift" is pressed xPos  x-coordinate of the mouse position when mouse up event occurs yPos  y-coordinate of the mouse position when mouse up event occurs

void mitkManipulator::OnMouseWheel (  bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos, int  delta )

Deal with mouse wheel rotate event. Parameters: ctrlDown  indicates if the key "Ctrl" is pressed shiftDown  indicates if the key "Shift" is pressed xPos  x-coordinate of the mouse position when mouse move event occurs yPos  y-coordinate of the mouse position when mouse move event occurs delta  the wheel rotation

virtual void mitkManipulator::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkObject. Reimplemented in mitkImageViewManipulatorStandard, mitkImageViewManipulatorWithWidgets, mitkMeshViewManipulatorStandard, mitkPickManipulator, and mitkWidgetsViewManipulator.

void mitkManipulator::SetScene (  mitkScene *  scene  )

Set the associated scene. The mouse events come from this scene. Parameters: scene  Specify the associated scene.

void mitkManipulator::SetView (  mitkView *  view  )

Set the associated view. The mouse events come from this view Parameters: view  Specify the associated view.

---

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

• mitkManipulator.h

---