This class represents the frame of a coordinate reference system. More...
#include <igstkCoordinateSystem.h>
Public Member Functions | |
igstkStandardClassTraitsMacro (CoordinateSystem, Object) void RequestSetTransformAndParent(const Transform &t | |
Macro with standard traits declarations. | |
void | RequestUpdateTransformToParent (const Transform &t) |
void | RequestGetTransformToParent () |
Request the transform to parent. | |
void | RequestComputeTransformTo (const CoordinateSystem *targetCoordSys) |
Request that a transform is computed to targetCoordSys This method generates three possible events: CoordinateSystemTransformToEvent CoordinateSystemTransformToNullTargetEvent CoordinateSystemTransformToDisconnectedEvent. | |
void | RequestDetachFromParent () |
Request that the coordinate system be detached from its parent. | |
igstkSetStringMacro (Name) | |
Coordinate systems have a name to facilitate future export of the scene graph as a diagram. | |
igstkGetStringMacro (Name) | |
igstkSetStringMacro (Type) | |
Set/Get the type as a string. | |
igstkGetStringMacro (Type) | |
Public Attributes | |
const CoordinateSystem * | parent |
Protected Member Functions | |
CoordinateSystem (void) | |
Constructor. | |
~CoordinateSystem (void) | |
Destructor. | |
virtual void | PrintSelf (std::ostream &os, itk::Indent indent) const |
Print object information. |
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
CoordinateSystem
State Machine Diagram
State Machine DiagramDefinition at line 85 of file igstkCoordinateSystem.h.
igstk::CoordinateSystem::CoordinateSystem | ( | void | ) | [protected] |
Constructor.
igstk::CoordinateSystem::~CoordinateSystem | ( | void | ) | [protected] |
Destructor.
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 [protected, virtual] |
Print object information.
Reimplemented from igstk::Object.
Definition at line 97 of file igstkCoordinateSystem.h.