Implementation of a MicroBird tool. More...

#include <mitkMicroBirdTool.h>

Inheritance diagram for mitk::MicroBirdTool:

Collaboration diagram for mitk::MicroBirdTool:

Public Member Functions
	mitkClassMacro (MicroBirdTool, InternalTrackingTool)

Pointer	Clone () const

Public Member Functions inherited from mitk::InternalTrackingTool
	mitkClassMacro (InternalTrackingTool, TrackingTool)

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const override

virtual void	GetPosition (Point3D &position) const override
	returns the current position of the tool as an array of three floats (in the tracking device coordinate system) More...

virtual void	GetOrientation (Quaternion &orientation) const override
	returns the current orientation of the tool as a quaternion (in the tracking device coordinate system) More...

virtual bool	Enable () override
	enablea the tool, so that it will be tracked. Returns true if enabling was successfull More...

virtual bool	Disable () override
	disables the tool, so that it will not be tracked anymore. Returns true if disabling was successfull More...

virtual bool	IsEnabled () const override
	returns whether the tool is enabled or disabled More...

virtual bool	IsDataValid () const override
	returns true if the current position data is valid (no error during tracking, tracking error below threshold, ...) More...

virtual float	GetTrackingError () const override
	return one value that corresponds to the overall tracking error. The dimension of this value is specific to each tracking device More...

virtual bool	IsTooltipSet () const
	returns true if a tooltip is set, false if not More...

virtual void	SetToolName (const std::string _arg)
	Sets the name of the tool. More...

virtual void	SetToolName (const char *_arg)
	Sets the name of the tool. More...

virtual void	SetPosition (Point3D position)
	sets the position More...

virtual void	SetOrientation (Quaternion orientation)
	sets the orientation as a quaternion More...

virtual void	SetTrackingError (float error)
	sets the tracking error More...

virtual void	SetDataValid (bool _arg)
	sets if the tracking data (position & Orientation) is valid More...

virtual void	SetErrorMessage (const char *_arg)
	sets the error message More...

virtual void	SetToolTip (Point3D toolTipPosition, Quaternion orientation=Quaternion(0, 0, 0, 1), ScalarType eps=0.0) override
	defines a tool tip for this tool in tool coordinates. GetPosition() and GetOrientation() return the data of the tool tip if it is defined. By default no tooltip is defined. More...

Public Member Functions inherited from mitk::TrackingTool
	mitkClassMacroItkParent (TrackingTool, itk::Object)

virtual const char *	GetToolName () const
	every tool has a name that can be used to identify it. More...

virtual const char *	GetErrorMessage () const
	if the data is not valid, ErrorMessage should contain a string explaining why it is invalid (the Set-method should be implemented in subclasses, it should not be accessible by the user) More...

virtual void	SetIGTTimeStamp (double _arg)

virtual double	GetIGTTimeStamp () const
	Sets the IGT timestamp of the tracking tool object (time in milliseconds) More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	MicroBirdTool ()

virtual	~MicroBirdTool ()

Protected Member Functions inherited from mitk::InternalTrackingTool
Pointer	Clone () const

	InternalTrackingTool ()

virtual	~InternalTrackingTool ()

Protected Member Functions inherited from mitk::TrackingTool
	TrackingTool ()
	Gets the IGT timestamp of the tracking tool object (time in milliseconds). Returns 0 if the timestamp was not set. More...

virtual	~TrackingTool ()

Additional Inherited Members
Static Protected Member Functions inherited from mitk::InternalTrackingTool
static Pointer	New ()

Protected Attributes inherited from mitk::InternalTrackingTool
Point3D	m_Position
	holds the position of the tool More...

Quaternion	m_Orientation
	holds the orientation of the tool More...

float	m_TrackingError
	holds the tracking error of the tool More...

bool	m_Enabled
	if true, tool is enabled and should receive tracking updates from the tracking device More...

bool	m_DataValid
	if true, data in m_Position and m_Orientation is valid, e.g. true tracking data More...

Point3D	m_ToolTip

Quaternion	m_ToolTipRotation

bool	m_ToolTipSet

Protected Attributes inherited from mitk::TrackingTool
std::string	m_ToolName
	every tool has a name that can be used to identify it. More...

std::string	m_ErrorMessage
	if a tool is invalid, this member should contain a human readable explanation of why it is invalid More...

double	m_IGTTimeStamp
	contains the time at which the tracking data was recorded More...

itk::FastMutexLock::Pointer	m_MyMutex
	mutex to control concurrent access to the tool More...

Detailed Description

Implementation of a MicroBird tool.

Definition at line 31 of file mitkMicroBirdTool.h.

Constructor & Destructor Documentation

mitk::MicroBirdTool::MicroBirdTool ( )

protected

Definition at line 19 of file mitkMicroBirdTool.cpp.

mitk::MicroBirdTool::~MicroBirdTool ( )

protectedvirtual

Definition at line 24 of file mitkMicroBirdTool.cpp.

Member Function Documentation

Pointer mitk::MicroBirdTool::Clone ( ) const

mitk::MicroBirdTool::mitkClassMacro	(	MicroBirdTool	,
		InternalTrackingTool
	)

static Pointer mitk::MicroBirdTool::New ( )

static

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation