mitk::StateEvent Class Reference [Interaction Classes]

Class holding an mitk-event and the mitk-event-number for a statechange. More...

#include <mitkStateEvent.h>

Collaboration diagram for mitk::StateEvent:

List of all members.

Public Member Functions
	StateEvent ()
	StateEvent (int id, Event const *event=NULL)
	Constructor.
	~StateEvent ()
void	Set (int id, Event const *event)
	to set the params and reuse an object
int	GetId () const
mitk::Event const *	GetEvent () const

---

Detailed Description

Class holding an mitk-event and the mitk-event-number for a statechange.

Holds an event, with which a statechange of a statemachine shall be done. iD represents the mitk-event-number, event all further necessary information like the MousePosition or a key. Not derived from event to hold only one object stateevent, pass it to the statemachines, set the next event and reuse this object

Examples:

mitkMoveSurfaceInteractor.cpp, and mitkMoveSurfaceInteractor.h.

Definition at line 36 of file mitkStateEvent.h.

---

Constructor & Destructor Documentation

mitk::StateEvent::StateEvent

(

)

Definition at line 27 of file mitkStateEvent.cpp.

:m_Id(0), m_Event(0)
{
}

mitk::StateEvent::StateEvent	(	int	id,
		Event const *	event = NULL
	)

Constructor.

Parameters:

id,:	mitk internal EventID
event,:	the information about the appeared event

Definition at line 22 of file mitkStateEvent.cpp.

:m_Id(id), m_Event(event)
{
}

mitk::StateEvent::~StateEvent

(

)

Definition at line 32 of file mitkStateEvent.cpp.

{
}

---

Member Function Documentation

mitk::Event const * mitk::StateEvent::GetEvent

(

)

const

Examples:

mitkMoveSurfaceInteractor.cpp.

Definition at line 47 of file mitkStateEvent.cpp.

Referenced by mitk::SurfaceInteractor::CanHandleEvent(), mitk::SurfaceDeformationInteractor3D::CanHandleEvent(), mitk::PointSetInteractor::CanHandleEvent(), mitk::PlanarFigureInteractor::CanHandleEvent(), mitk::MouseMovePointSetInteractor::CanHandleEvent(), mitk::Interactor::CanHandleEvent(), mitk::ConnectPointsInteractor::CanHandleEvent(), mitk::AffineInteractor::CanHandleEvent(), mitk::SurfaceDeformationInteractor3D::ExecuteAction(), mitk::SlicesRotator::ExecuteAction(), mitk::SeedsInteractor::ExecuteAction(), mitk::PositionTracker::ExecuteAction(), mitk::PointSetInteractor::ExecuteAction(), mitk::PointSelectorInteractor::ExecuteAction(), mitk::PointInteractor::ExecuteAction(), mitk::PlanarFigureInteractor::ExecuteAction(), mitk::MoveSurfaceInteractor::ExecuteAction(), mitk::ExtrudedContourInteractor::ExecuteAction(), mitk::DisplayVectorInteractor::ExecuteAction(), mitk::DisplayPointSetInteractor::ExecuteAction(), mitk::CoordinateSupplier::ExecuteAction(), mitk::ContourInteractor::ExecuteAction(), mitk::ConnectPointsInteractor::ExecuteAction(), mitk::AffineInteractor::ExecuteAction(), mitk::Interactor::HandleEvent(), mitk::PlanarFigureInteractor::IsPositionInsideMarker(), mitk::PlanarFigureInteractor::IsPositionOverFigure(), mitk::SetRegionTool::OnInvertLogic(), mitk::SegTool2D::OnInvertLogic(), mitk::SegTool2D::OnMouseMoved(), mitk::RegionGrowingTool::OnMouseMoved(), mitk::PaintbrushTool::OnMouseMoved(), mitk::CorrectorTool2D::OnMouseMoved(), mitk::ContourTool::OnMouseMoved(), mitk::SetRegionTool::OnMousePressed(), mitk::SegTool2D::OnMousePressed(), mitk::RegionGrowingTool::OnMousePressed(), mitk::PaintbrushTool::OnMousePressed(), mitk::CorrectorTool2D::OnMousePressed(), mitk::ContourTool::OnMousePressed(), mitk::RegionGrowingTool::OnMousePressedInside(), mitk::RegionGrowingTool::OnMousePressedOutside(), mitk::SetRegionTool::OnMouseReleased(), mitk::SegTool2D::OnMouseReleased(), mitk::RegionGrowingTool::OnMouseReleased(), mitk::CorrectorTool2D::OnMouseReleased(), mitk::ContourTool::OnMouseReleased(), mitk::SpaceNavigatorVtkCameraController::OnSpaceNavigatorEvent(), mitk::TDMouseVtkCameraController::OnTDMouseEvent(), mitk::EventMapper::RefreshStateEvent(), mitk::PlanarFigureInteractor::TransformPositionEventToPoint2D(), and mitk::PaintbrushTool::UpdateContour().

{
  return m_Event;
}

int mitk::StateEvent::GetId

(

)

const

Definition at line 42 of file mitkStateEvent.cpp.

Referenced by mitk::SurfaceDeformationInteractor3D::CanHandleEvent(), mitk::PointSetInteractor::CanHandleEvent(), mitk::PlanarFigureInteractor::CanHandleEvent(), mitk::MouseMovePointSetInteractor::CanHandleEvent(), mitk::Interactor::CanHandleEvent(), mitk::ConnectPointsInteractor::CanHandleEvent(), mitk::StateMachine::HandleEvent(), mitkEventMapperTest(), and mitk::PaintbrushTool::OnMouseMoved().

{
  return m_Id;
}

void mitk::StateEvent::Set	(	int	id,
		Event const *	event
	)

to set the params and reuse an object

Definition at line 36 of file mitkStateEvent.cpp.

Referenced by mitkEventMapperTest(), mitkInteractorTest(), and mitk::EventMapper::RefreshStateEvent().

{
  m_Id = id;
  m_Event = event;
}

---

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

• mitkStateEvent.h
• mitkStateEvent.cpp