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

This class represents the frame of a coordinate reference system. More...

#include <igstkCoordinateSystem.h>

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

Public Member Functions

 igstkStandardClassTraitsMacro (CoordinateSystem, Object) void RequestSetTransformAndParent(const Transform &t
 Macro with standard traits declarations. More...
 
void RequestUpdateTransformToParent (const Transform &t)
 
void RequestGetTransformToParent ()
 Request the transform to parent. More...
 
void RequestComputeTransformTo (const CoordinateSystem *targetCoordSys)
 Request that a transform is computed to targetCoordSys This method generates three possible events: CoordinateSystemTransformToEvent CoordinateSystemTransformToNullTargetEvent CoordinateSystemTransformToDisconnectedEvent. More...
 
void RequestDetachFromParent ()
 Request that the coordinate system be detached from its parent. More...
 
 igstkSetStringMacro (Name)
 Coordinate systems have a name to facilitate future export of the scene graph as a diagram. More...
 
 igstkGetStringMacro (Name)
 
 igstkSetStringMacro (Type)
 Set/Get the type as a string. More...
 
 igstkGetStringMacro (Type)
 
- 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
 

Public Attributes

const CoordinateSystemparent
 

Protected Member Functions

 CoordinateSystem (void)
 Constructor. More...
 
 ~CoordinateSystem (void)
 Destructor. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () 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< 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

This class represents the frame of a coordinate reference system.

The class is intended to be used as an anchor relative to which you can position Spatial Objects in the graph scene. The class is not exposed to the API of IGSTK, instead it is used internally in the SpatialObject, Tracker, TrackerTool and View classes in order to provide a scaffolding in which each one of these classes can be attached as nodes of a scene graph.

http://en.wikipedia.org/wiki/Scene_graph

The following diagram illustrates the state machine of the CoordinateSystem class

igstkCoordinateSystem.png
CoordinateSystem

State Machine Diagram"

State Machine Diagram"

Definition at line 85 of file igstkCoordinateSystem.h.

Constructor & Destructor Documentation

igstk::CoordinateSystem::CoordinateSystem ( void  )
protected

Constructor.

igstk::CoordinateSystem::~CoordinateSystem ( void  )
protected

Destructor.

Member Function Documentation

igstk::CoordinateSystem::igstkStandardClassTraitsMacro ( CoordinateSystem  ,
Object   
) const

Macro with standard traits declarations.

Tries to set the parent coordinate system and the transform from this coordinate system to the parent.

void igstk::CoordinateSystem::RequestUpdateTransformToParent ( const Transform t)
void igstk::CoordinateSystem::RequestGetTransformToParent ( )

Request the transform to parent.

void igstk::CoordinateSystem::RequestComputeTransformTo ( const CoordinateSystem targetCoordSys)

Request that a transform is computed to targetCoordSys This method generates three possible events: CoordinateSystemTransformToEvent CoordinateSystemTransformToNullTargetEvent CoordinateSystemTransformToDisconnectedEvent.

CoordinateSystemTransformToEvent is returned if the transform is successfully computed. Otherwise, one of the other events is generated.

void igstk::CoordinateSystem::RequestDetachFromParent ( )

Request that the coordinate system be detached from its parent.

igstk::CoordinateSystem::igstkSetStringMacro ( Name  )

Coordinate systems have a name to facilitate future export of the scene graph as a diagram.

These macros get and set the name.

igstk::CoordinateSystem::igstkGetStringMacro ( Name  )
igstk::CoordinateSystem::igstkSetStringMacro ( Type  )

Set/Get the type as a string.

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

Print object information.

Reimplemented from igstk::Object.

Member Data Documentation

const CoordinateSystem* igstk::CoordinateSystem::parent

Definition at line 97 of file igstkCoordinateSystem.h.


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