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

Geometrical abstraction of physical objects present in the surgical scene. More...

#include <igstkSpatialObject.h>

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

Public Member Functions

 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(SpatialObject,
Object) public typedef
SpatialObjectType::BoundingBoxType 
BoundingBoxType
 Macro with standard traits declarations.

Protected Member Functions

 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().
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
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

- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs.
typedef ::itk::Object Superclass
typedef ::itk::SmartPointer< SelfPointer
typedef ::itk::SmartPointer
< const Self
ConstPointer
typedef igstk::Logger LoggerType
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)

Detailed Description

Geometrical abstraction of physical objects present in the surgical scene.

This class is intended to describe objects in the surgical scenario. Subclasses of this class will be used for representing, for example, surgical instruments such as needles, catheters and guide wires; as well as pre-operative and intra-operative images.

This class encapsulates an ITK spatial object with the goal of restricting access to functionalities that are not essential for IGS applications, or to functionalities thay may present risks and unnecessary flexibility. This is an abstract class, you should use the derived classes that represent specific shapes.

igstkSpatialObject.png
SpatialObject State Machine Diagram

Definition at line 57 of file igstkSpatialObject.h.

Constructor & Destructor Documentation

igstk::SpatialObject::SpatialObject ( void  )
protected

The constructor of this class is declared protected to enforce the use of SmartPointers syntax when instantiating objects of this class.

This constructor will be called indirectly by the ::New() method. It will initialize the internal state machine of this class.

igstk::SpatialObject::~SpatialObject ( void  )
protected

The destructor should be overriden in derived classes that allocate memory for member variables.

Member Function Documentation

igstk::SpatialObject::igstkLoadedObjectEventMacro ( BoundingBoxEvent  ,
IGSTKEvent  ,
BoundingBoxType   
)
void igstk::SpatialObject::RequestGetBounds ( )
void igstk::SpatialObject::RequestGetBounds ( ) const
void igstk::SpatialObject::RequestSetInternalSpatialObject ( SpatialObjectType *  object)
protected

Replacement for RequestSetSpatialObject().

Internal is added to the name to clarify that this is used with the ITK spatial object as argument

virtual void igstk::SpatialObject::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
SpatialObjectType* igstk::SpatialObject::GetInternalSpatialObject ( ) const
protected

Returns the ITK spatial object that is contained inside this IGSTK spatial object.

Member Data Documentation

igstkStandardClassTraitsMacro ( SpatialObject, Object ) public typedef SpatialObjectType::BoundingBoxType igstk::SpatialObject::BoundingBoxType

Macro with standard traits declarations.

Typedefs

Definition at line 63 of file igstkSpatialObject.h.


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