Implementation of the Mouse TrackerTool class. More...

#include <igstkMouseTracker.h>

Inheritance diagram for igstk::MouseTracker:

Collaboration diagram for igstk::MouseTracker:

Public Member Functions
virtual double	GetScaleFactor ()

Public Member Functions inherited from igstk::Tracker
void	RequestOpen (void)
	The "RequestOpen" method attempts to open communication with the tracking device. More...

void	RequestClose (void)
	The "RequestClose" method closes communication with the device. More...

void	RequestReset (void)
	The "RequestReset" tracker method should be used to bring the tracker to some defined default state. More...

void	RequestStartTracking (void)
	The "RequestStartTracking" method readies the tracker for tracking the tools connected to the tracker. More...

void	RequestStopTracking (void)
	The "RequestStopTracking" stops tracker from tracking the tools. More...

void	RequestSetFrequency (double frequencyInHz)
	The "RequestSetFrequency" method defines the frequency at which the Transform information will be queried from the Tracker device. More...

void	RequestSetReferenceTool (TrackerToolType *trackerTool)
	Set a reference tracker tool. More...

virtual void	SetThreadingEnabled (bool _arg)
	SetThreadingEnabled(bool) : set m_ThreadingEnabled value. More...

virtual bool	GetThreadingEnabled ()
	GetThreadingEnabled(bool) : get m_ThreadingEnabled value. More...

Public Member Functions inherited from igstk::Object
virtual const char *	GetNameOfClass () const

void	SetLogger (LoggerType *logger)
	Connect the Logger for this class. More...

void	RemoveObserver (unsigned long tag) const

Protected Types
typedef Tracker::ResultType	ResultType

Protected Types inherited from igstk::Tracker
enum	ResultType { FAILURE =0, SUCCESS }

typedef Transform::TimePeriodType	TimePeriodType
	typedef for times used by the tracker More...

typedef Transform	TransformType
	typedefs from Transform class More...

typedef std::map< std::string, TrackerToolType * >	TrackerToolsContainerType
	typedefs from TrackerTool class More...

Protected Member Functions
	MouseTracker ()

virtual	~MouseTracker ()

virtual ResultType	InternalOpen (void)
	The "InternalOpen" method opens communication with a tracking device. More...

virtual ResultType	InternalStartTracking (void)
	The "InternalStartTracking" method starts tracking. More...

virtual ResultType	InternalUpdateStatus (void)
	The "InternalUpdateStatus" method updates tracker status. More...

virtual ResultType	InternalThreadedUpdateStatus (void)
	The "InternalThreadedUpdateStatus" method updates tracker status. More...

virtual ResultType	InternalReset (void)
	The "InternalReset" method resets tracker to a known configuration. More...

virtual ResultType	InternalStopTracking (void)
	The "InternalStopTracking" method stops tracking. More...

virtual ResultType	InternalClose (void)
	The "InternalClose" method closes communication with a tracking device. More...

virtual ResultType	VerifyTrackerToolInformation (const TrackerToolType *)
	Verify tracker tool information. More...

virtual ResultType	RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *)
	This method will remove entries of the traceker tool from internal data containers. More...

virtual ResultType	AddTrackerToolToInternalDataContainers (const TrackerToolType *)
	Add tracker tool entry to internal containers. More...

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const
	Print object information. More...

Protected Member Functions inherited from igstk::Tracker
	Tracker (void)

virtual	~Tracker (void)

virtual TimePeriodType	GetValidityTime ()
	Get the validity time. More...

virtual ResultType	ValidateSpecifiedFrequency (double frequencyInHz)
	The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used. More...

const TrackerToolsContainerType &	GetTrackerToolContainer () const
	Access method for the tracker tool container. More...

void	ReportTrackingToolNotAvailable (TrackerToolType *trackerTool) const
	Report to tracker tool that it is not available for tracking. More...

void	ReportTrackingToolVisible (TrackerToolType *trackerTool) const
	Report to tracker tool that it is visible. More...

void	SetTrackerToolRawTransform (TrackerToolType *trackerTool, const TransformType transform)
	Set tracker tool raw transform. More...

void	SetTrackerToolTransformUpdate (TrackerToolType *trackerTool, bool flag) const
	Turn on/off update flag of the tracker tool. More...

void	ExitTrackingStateProcessing (void)
	Depending on the tracker type, the tracking thread should be terminated or left untouched when we stop tracking. More...

void	ExitTrackingWithoutTerminatingTrackingThread ()
	Exit tracking without terminating tracking thread. More...

void	ExitTrackingTerminatingTrackingThread ()
	Exit tracking after terminating tracking thread. More...

Protected Member Functions inherited from igstk::Object
LoggerType *	GetLogger () const

	Object (void)
	Constructor is protected in order to enforce the use of the New() operator. More...

virtual	~Object (void)

void	RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
	Register observed objects in an internal array so that they can be disconnected upon destruction. More...

void	RemoveFromObservedObjects ()
	Remove observers that this object may have connected to other objects. More...

Additional Inherited Members
Public Types inherited from igstk::Object
typedef Object	Self
	General Typedefs. More...

typedef ::itk::Object	Superclass

typedef ::itk::SmartPointer< Self >	Pointer

typedef ::itk::SmartPointer < const Self >	ConstPointer

typedef igstk::Logger	LoggerType

Static Public Member Functions inherited from igstk::Object
static Pointer	New (void)

Public Attributes inherited from igstk::Tracker
igstkStandardAbstractClassTraitsMacro(Tracker, Object) public typedef TrackerTool	TrackerToolType
	Macro with standard traits declarations. More...

Detailed Description

Implementation of the Mouse TrackerTool class.

The purpose of this class is to provide a minimal implementation of a Tracker. This class is intended only for minimal demos and for debugging applications. It is not intended to be used in a real application to be deployed in a surgery room.

Definition at line 37 of file igstkMouseTracker.h.

Member Typedef Documentation

typedef Tracker::ResultType igstk::MouseTracker::ResultType

protected

Definition at line 56 of file igstkMouseTracker.h.

Constructor & Destructor Documentation

igstk::MouseTracker::MouseTracker ( )

protected

virtual igstk::MouseTracker::~MouseTracker ( )

protectedvirtual

Member Function Documentation

virtual double igstk::MouseTracker::GetScaleFactor ( )

virtual

virtual ResultType igstk::MouseTracker::InternalOpen ( void )

protectedvirtual

The "InternalOpen" method opens communication with a tracking device.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalStartTracking ( void )

protectedvirtual

The "InternalStartTracking" method starts tracking.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalUpdateStatus ( void )

protectedvirtual

The "InternalUpdateStatus" method updates tracker status.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalThreadedUpdateStatus ( void )

protectedvirtual

The "InternalThreadedUpdateStatus" method updates tracker status.

This method is called in a separate thread. This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalReset ( void )

protectedvirtual

The "InternalReset" method resets tracker to a known configuration.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalStopTracking ( void )

protectedvirtual

The "InternalStopTracking" method stops tracking.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::InternalClose ( void )

protectedvirtual

The "InternalClose" method closes communication with a tracking device.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::VerifyTrackerToolInformation ( const TrackerToolType * )

protectedvirtual

Verify tracker tool information.

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::RemoveTrackerToolFromInternalDataContainers ( const TrackerToolType * trackerTool )

protectedvirtual

This method will remove entries of the traceker tool from internal data containers.

Implements igstk::Tracker.

virtual ResultType igstk::MouseTracker::AddTrackerToolToInternalDataContainers ( const TrackerToolType * trackerTool )

protectedvirtual

Add tracker tool entry to internal containers.

Implements igstk::Tracker.

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

protectedvirtual

Print object information.

Reimplemented from igstk::Tracker.

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

/build/buildd/igstk-4.4.0/Source/igstkMouseTracker.h

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation