IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::CrossHairSpatialObject Class Reference

This class represents a cross hair spatial object. More...

#include <igstkCrossHairSpatialObject.h>

Inheritance diagram for igstk::CrossHairSpatialObject:
Inheritance graph
[legend]
Collaboration diagram for igstk::CrossHairSpatialObject:
Collaboration graph
[legend]

Public Types

typedef SpatialObject SpatialObjectType
typedef
SpatialObjectType::BoundingBoxType 
BoundingBoxType
typedef SpatialObjectType::Pointer SpatialObjectPointerType

Public Member Functions

bool IsToolSpatialObjectSet ()
 Inquiry if a tool spatial object is set.
bool IsInsideBounds ()
 Inquiry if tool position is inside bounds.
void RequestGetCrossHairPosition ()
 Request get cross hair position.
void RequestSetToolSpatialObject (const SpatialObjectType *spatialObject)
 Request set tool spatial object.
void RequestSetBoundingBoxProviderSpatialObject (const SpatialObjectType *spatialObject)
 Request set bounding box provider spatial object.
void RequestSetCursorPosition (PointType point)
 Request set cursor position.
igstk::Transform GetToolTransform () const
 Get tool transform.
double GetBoundingBoxDimensionByIndex (unsigned int index) const
 Get boundings by index.
- Public Member Functions inherited from igstk::SpatialObject
 igstkLoadedObjectEventMacro (BoundingBoxEvent, IGSTKEvent, BoundingBoxType)
void RequestGetBounds ()
void RequestGetBounds () const
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Public Attributes

igstkStandardClassTraitsMacro(CrossHairSpatialObject,
SpatialObject) typedef igstk
typedef
igstk::Transform::VectorType 
VectorType
 Macro with standard traits declarations.
- Public Attributes inherited from igstk::SpatialObject
igstkStandardClassTraitsMacro(SpatialObject,
Object) public typedef
SpatialObjectType::BoundingBoxType 
BoundingBoxType
 Macro with standard traits declarations.

Protected Member Functions

 CrossHairSpatialObject (void)
 ~CrossHairSpatialObject (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.
 igstkObserverMacro (ImageTransform, CoordinateSystemTransformToEvent, CoordinateSystemTransformToResult)
- Protected Member Functions inherited from igstk::SpatialObject
 SpatialObject (void)
 The constructor of this class is declared protected to enforce the use of SmartPointers syntax when instantiating objects of this class.
 ~SpatialObject (void)
 The destructor should be overriden in derived classes that allocate memory for member variables.
void RequestSetInternalSpatialObject (SpatialObjectType *object)
 Replacement for RequestSetSpatialObject().
SpatialObjectType * GetInternalSpatialObject () const
 Returns the ITK spatial object that is contained inside this IGSTK spatial object.
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
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.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Additional Inherited Members

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

Detailed Description

This class represents a cross hair spatial object.

This class is used to indicate a position in an input image. The position could be manually set using RequestSetCursorPostion or specified using a reslicing tool transform RequestSetToolSpatialObject

Definition at line 42 of file igstkCrossHairSpatialObject.h.

Member Typedef Documentation

Definition at line 54 of file igstkCrossHairSpatialObject.h.

typedef SpatialObjectType::BoundingBoxType igstk::CrossHairSpatialObject::BoundingBoxType

Definition at line 56 of file igstkCrossHairSpatialObject.h.

Definition at line 57 of file igstkCrossHairSpatialObject.h.

Constructor & Destructor Documentation

igstk::CrossHairSpatialObject::CrossHairSpatialObject ( void  )
protected
igstk::CrossHairSpatialObject::~CrossHairSpatialObject ( void  )
protected

Member Function Documentation

bool igstk::CrossHairSpatialObject::IsToolSpatialObjectSet ( )

Inquiry if a tool spatial object is set.

bool igstk::CrossHairSpatialObject::IsInsideBounds ( )

Inquiry if tool position is inside bounds.

void igstk::CrossHairSpatialObject::RequestGetCrossHairPosition ( )

Request get cross hair position.

void igstk::CrossHairSpatialObject::RequestSetToolSpatialObject ( const SpatialObjectType spatialObject)

Request set tool spatial object.

void igstk::CrossHairSpatialObject::RequestSetBoundingBoxProviderSpatialObject ( const SpatialObjectType spatialObject)

Request set bounding box provider spatial object.

void igstk::CrossHairSpatialObject::RequestSetCursorPosition ( PointType  point)

Request set cursor position.

igstk::Transform igstk::CrossHairSpatialObject::GetToolTransform ( ) const

Get tool transform.

double igstk::CrossHairSpatialObject::GetBoundingBoxDimensionByIndex ( unsigned int  index) const

Get boundings by index.

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

Print object information.

Reimplemented from igstk::SpatialObject.

igstk::CrossHairSpatialObject::igstkObserverMacro ( ImageTransform  ,
CoordinateSystemTransformToEvent  ,
CoordinateSystemTransformToResult   
)
protected

Member Data Documentation

igstkStandardClassTraitsMacro ( CrossHairSpatialObject, SpatialObject ) typedef igstk typedef igstk::Transform::VectorType igstk::CrossHairSpatialObject::VectorType

Macro with standard traits declarations.

Typedefs

Definition at line 48 of file igstkCrossHairSpatialObject.h.


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