camitk::InterfaceFrame Class Reference

This class describes the methods to implement in order to manage a Component position in space. More...

#include <InterfaceFrame.h>

Inheritance diagram for camitk::InterfaceFrame:

Collaboration diagram for camitk::InterfaceFrame:

Public Member Functions
virtual QMultiMap< const FrameOfReference *, Component * >	getAllFrames (bool includeChildrenFrames=true)=0
	Get all FrameOfReference owned by this object.
virtual QMultiMap< const Transformation *, Component * >	getAllTransformations (bool includeChildrenTransformations=true)=0
	Get all Transformation owned by this object.
virtual const FrameOfReference *	getFrame () const =0
	Get the pointer to this object's FrameOfReference.
virtual vtkSmartPointer< vtkAxesActor >	getFrameAxisActor (QString)=0
	add a 3D Actor representing the Frame FIXME
virtual bool	getFrameVisibility (QString) const =0
	get the visibility of the Frame axis actor FIXME
virtual void	resetFrame ()=0
	Reset this object's FrameOfReference, that is call setFrame with a newly created frame of reference.
virtual void	setFrame (const std::shared_ptr< FrameOfReference > &frame)=0
	Set the FrameOfReference of this object.
virtual void	setFrameFrom (const InterfaceFrame *)=0
	Modify this object's frame using the given object's frame.
virtual void	setFrameVisibility (QString, bool)=0
	set the visibility of the Frame axis actor FIXME
virtual	~InterfaceFrame ()=default
	empty virtual destructor, to avoid memory leak

Detailed Description

This class describes the methods to implement in order to manage a Component position in space.

Each Component has a frame of reference which is used to define its relation to other objects. You can define new frames and transformations between frames as required, but all FrameOfReference and Transformation objects must be managed by the TransformationManager.

See also

TransformationManager

Constructor & Destructor Documentation

~InterfaceFrame()

virtual camitk::InterfaceFrame::~InterfaceFrame ( )

virtualdefault

empty virtual destructor, to avoid memory leak

Member Function Documentation

getAllFrames()

virtual QMultiMap< const FrameOfReference *, Component * > camitk::InterfaceFrame::getAllFrames ( bool  includeChildrenFrames = true )

pure virtual

Get all FrameOfReference owned by this object.

• includeChildrenFrames Include the frames of this object's children along with its own

Implemented in camitk::ArbitrarySingleImageComponent, camitk::Component, and camitk::ImageComponent.

getAllTransformations()

virtual QMultiMap< const Transformation *, Component * > camitk::InterfaceFrame::getAllTransformations ( bool  includeChildrenTransformations = true )

pure virtual

Get all Transformation owned by this object.

• includeChildrenTransformations Include the Transformation of this object's children along with its own

Implemented in camitk::ArbitrarySingleImageComponent, camitk::Component, and camitk::ImageComponent.

getFrame()

virtual const FrameOfReference * camitk::InterfaceFrame::getFrame ( ) const

pure virtual

Get the pointer to this object's FrameOfReference.

Note

Please use TransformationManager::getFrameOfReferenceOwnership(FrameOfReference*)

Implemented in camitk::Component.

Referenced by camitk::Component::setFrameFrom().

Here is the caller graph for this function:

getFrameAxisActor()

virtual vtkSmartPointer< vtkAxesActor > camitk::InterfaceFrame::getFrameAxisActor ( QString  )

pure virtual

add a 3D Actor representing the Frame FIXME

Note

this is temporary, the frame axis actor should be managed otherwise as the component might not be the sole owner of its frame

Implemented in camitk::Component.

getFrameVisibility()

virtual bool camitk::InterfaceFrame::getFrameVisibility ( QString  ) const

pure virtual

get the visibility of the Frame axis actor FIXME

Note

this is temporary, the frame axis actor should be managed otherwise as the component might not be the sole owner of its frame

Implemented in camitk::Component.

resetFrame()

virtual void camitk::InterfaceFrame::resetFrame ( )

pure virtual

Reset this object's FrameOfReference, that is call setFrame with a newly created frame of reference.

Note

you can reimplement this method if you need to manage more than this frame of reference (

See also

ImageComponent::setFrameFrom())

Implemented in camitk::Component, and camitk::ImageComponent.

setFrame()

virtual void camitk::InterfaceFrame::setFrame ( const std::shared_ptr< FrameOfReference > &  frame )

pure virtual

Set the FrameOfReference of this object.

Note that this methods will take ownership of the given frame thanks to the shared_ptr.

Implemented in camitk::ArbitrarySingleImageComponent, camitk::Component, and camitk::ImageComponent.

setFrameFrom()

virtual void camitk::InterfaceFrame::setFrameFrom ( const InterfaceFrame *  )

pure virtual

Modify this object's frame using the given object's frame.

Note

you can reimplement this method if you need to manage more than this frame of reference (

See also

ImageComponent::setFrameFrom())

Implemented in camitk::Component, and camitk::ImageComponent.

setFrameVisibility()

virtual void camitk::InterfaceFrame::setFrameVisibility ( QString  , bool    )

pure virtual

set the visibility of the Frame axis actor FIXME

Note

this is temporary, the frame axis actor should be managed otherwise as the component might not be the sole owner of its frame

Implemented in camitk::Component.

---

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

• InterfaceFrame.h