This class encapsulates the details of setting parent and child relationships between coordinate systems. More...

Collaboration diagram for igstk::CoordinateSystemSetTransformResult:

Public Member Functions
	CoordinateSystemSetTransformResult ()
	Constructor.
	CoordinateSystemSetTransformResult (const CoordinateSystemSetTransformResult &in)
	Copy constructor.
const CoordinateSystemSetTransformResult &	operator= (const CoordinateSystemSetTransformResult &in)
	Assignment operator.
void	Clear ()
	Clears the pointers that the event is holding.
void	Initialize (const Transform &transform, const CoordinateSystem source, const CoordinateSystem destination, bool isAttaching)
	Sets the transform, source, and destination coordinate systems.
template<class TSource , class TDestination >
void	Initialize (const Transform &transform, const TSource sourceObject, const TDestination destinationObject, bool isAttaching)
	Sets the transform, source, and destination coordinate systems from two given objects that respectively own coordinate systems.
const Transform &	GetTransform () const
	Returns the computed transform.
const CoordinateSystem *	GetSource () const
	Returns the source coordinate system.
const CoordinateSystem *	GetDestination () const
	Returns the destination coordinate system.
bool	IsAttach () const
	Returns whether this result is being used for attach or detach.

Detailed Description

This class encapsulates the details of setting parent and child relationships between coordinate systems.

It is meant to be used as payload in an event that is created after a successful call to RequestSetParentAndTransform().

Constructor & Destructor Documentation

igstk::CoordinateSystemSetTransformResult::CoordinateSystemSetTransformResult ( )

Constructor.

igstk::CoordinateSystemSetTransformResult::CoordinateSystemSetTransformResult ( const CoordinateSystemSetTransformResult & in )

Copy constructor.

const CoordinateSystemSetTransformResult& igstk::CoordinateSystemSetTransformResult::operator= ( const CoordinateSystemSetTransformResult & in )

Assignment operator.

void igstk::CoordinateSystemSetTransformResult::Clear ( )

Clears the pointers that the event is holding.

This should be called after the event is received to remove unnecessary smart pointer references to coordinate systems.

void igstk::CoordinateSystemSetTransformResult::Initialize	(	const Transform &	transform,
		const CoordinateSystem *	source,
		const CoordinateSystem *	destination,
		bool	isAttaching
	)

Sets the transform, source, and destination coordinate systems.

template<class TSource , class TDestination >

void igstk::CoordinateSystemSetTransformResult::Initialize	(	const Transform &	transform,
		const TSource *	sourceObject,
		const TDestination *	destinationObject,
		bool	isAttaching
	)		`[inline]`

Sets the transform, source, and destination coordinate systems from two given objects that respectively own coordinate systems.

const Transform& igstk::CoordinateSystemSetTransformResult::GetTransform ( ) const

Returns the computed transform.

const CoordinateSystem* igstk::CoordinateSystemSetTransformResult::GetSource ( ) const

Returns the source coordinate system.

const CoordinateSystem* igstk::CoordinateSystemSetTransformResult::GetDestination ( ) const

Returns the destination coordinate system.

bool igstk::CoordinateSystemSetTransformResult::IsAttach ( ) const

Returns whether this result is being used for attach or detach.

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