This action allows you to show/hide the 3D axes representation of the component's frame. More...

#include <ShowFrame.h>

Inheritance diagram for ShowFrame:

Collaboration diagram for ShowFrame:

Public Slots
virtual camitk::Action::ApplyStatus	apply () override
	show/hide the frame depending on the user choice More...

Public Slots inherited from camitk::Action
virtual camitk::Action::ApplyStatus	apply ()=0
	This method is called when the action has to be applied on the target list (get the target lists using getTargets()) It calls the algorithm of your action on the target list of components. More...

camitk::Action::ApplyStatus	applyAndRegister ()
	This method is called whenever the action has to be applied on the target list (like the apply()) method AND registered within the application history of actions. More...

camitk::Action::ApplyStatus	trigger (QWidget *parent=nullptr)
	This method triggers the action. More...

Public Member Functions
virtual bool	event (QEvent *e) override
	manage change immediatly More...

QAction *	getQAction (camitk::Component *target=nullptr) override
	Get the corresponding QAction (overriden to update the checked status) More...

virtual QWidget *	getWidget () override
	update the property visibility More...

	ShowFrame (camitk::ActionExtension *)
	the constructor More...

virtual	~ShowFrame ()=default
	Destructor. More...

Public Member Functions inherited from camitk::Action
	Action (ActionExtension *)
	Default Constructor: the ActionExtension is needed. More...

	~Action () override
	Destructor. More...

QString	getName () const
	get the name of the action More...

QString	getDescription () const
	the description of the action More...

QString	getComponent () const
	the name of the component class that can be used by this action More...

QString	getFamily () const
	the name of the family in which this action is associated More...

QString	getExtensionName () const
	the name of the extension in the family in which this action is associated More...

QStringList	getTag () const
	the name of the tag called this action More...

bool	getEmbedded () const
	argument use to know if the widget is embedded or not More...

virtual QPixmap	getIcon ()
	the icon to personalize the action (no icon by default) More...

const ComponentList	getTargets () const
	the currently selected and valid (regarding the component property) components, for which this action is called More...

void	updateTargets ()
	update the target list using the currently selected components More...

bool	getAutoUpdateProperties () const

void	setAutoUpdateProperties (bool)
	are the properties to be udpated every time the user makes a change in the widget (default is false)? More...

virtual Q_INVOKABLE camitk::Property *	getProperty (QString name)
	Get a Property given its name. More...

virtual bool	addParameter (Property *)
	Add a new parameter to the action, using the CamiTK property class. More...

void	applyTargetPosition (Component input, Component target)
	Change the target frame according to the default frame policy regarding the input's one. More...

void	applyTargetPosition (Component input, Component target, Application::TargetPositionningPolicy policy)
	Change the target frame according to a given frame policy regarding the input's one. More...

ApplyStatus	applyInPipeline ()
	This method encapsulates the apply() method. More...

void	setInputComponents (ComponentList inputs)
	Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!! More...

void	setInputComponent (Component *input)
	Specify the input Components in case of only one Component. More...

ComponentList	getOutputComponents ()
	Returns the output Component(s) More...

Component *	getOutputComponent ()
	Returns the output Components in case of only one Component. More...

Private Member Functions
double	getFrameSize ()

Private Attributes
bool	blockAutoUpdate

camitk::Component *	comp

Additional Inherited Members
Public Types inherited from camitk::Action
enum	ApplyStatus { SUCCESS, ERROR, WARNING, ABORTED, TRIGGERED }

Static Public Member Functions inherited from camitk::Action
static QString	getStatusAsString (ApplyStatus)

Protected Member Functions inherited from camitk::Action
void	setName (QString name)

void	setDescription (QString description)
	the description of the action More...

void	setComponent (QString component)
	the name of the component class that can be used by this action More...

void	setFamily (QString family)
	the name of the family in which this action is associated More...

void	addTag (QString tag)
	add a tag to the tags list of this action More...

void	setEmbedded (bool isEmbedded)
	set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false) More...

void	setIcon (QPixmap)
	set the Pixmap More...

Protected Attributes inherited from camitk::Action
QWidget *	actionWidget
	the action widget More...

Detailed Description

This action allows you to show/hide the 3D axes representation of the component's frame.

Constructor & Destructor Documentation

◆ ShowFrame()

ShowFrame::ShowFrame ( camitk::ActionExtension * extension )

the constructor

References camitk::Action::addParameter(), camitk::Action::addTag(), comp, camitk::Property::setAttribute(), camitk::Action::setAutoUpdateProperties(), camitk::Action::setComponent(), camitk::Action::setDescription(), camitk::Action::setFamily(), and camitk::Action::setName().

Here is the call graph for this function:

◆ ~ShowFrame()

virtual ShowFrame::~ShowFrame ( )

virtualdefault

Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus ShowFrame::apply ( )

overridevirtualslot

show/hide the frame depending on the user choice

References camitk::Action::SUCCESS.

◆ event()

bool ShowFrame::event ( QEvent * e )

overridevirtual

manage change immediatly

References blockAutoUpdate, comp, camitk::InterfaceFrame::getFrameAxisActor(), getFrameSize(), camitk::refresh(), and camitk::InterfaceFrame::setFrameVisibility().

Here is the call graph for this function:

◆ getFrameSize()

double ShowFrame::getFrameSize ( )

private

References camitk::InteractiveViewer::getBoundsOfSelected().

Referenced by event(), and getWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQAction()

QAction * ShowFrame::getQAction ( camitk::Component * target = nullptr )

overridevirtual

Get the corresponding QAction (overriden to update the checked status)

Reimplemented from camitk::Action.

References camitk::InterfaceFrame::getFrameVisibility().

Here is the call graph for this function:

◆ getWidget()

QWidget * ShowFrame::getWidget ( )

overridevirtual

update the property visibility

Reimplemented from camitk::Action.

References blockAutoUpdate, comp, camitk::InterfaceFrame::getFrameAxisActor(), getFrameSize(), camitk::InterfaceFrame::getFrameVisibility(), camitk::Action::getTargets(), camitk::InteractiveViewer::refresh(), and camitk::InterfaceFrame::setFrameVisibility().

Here is the call graph for this function:

Member Data Documentation

◆ blockAutoUpdate

bool ShowFrame::blockAutoUpdate

private

Referenced by event(), and getWidget().

◆ comp

camitk::Component* ShowFrame::comp

private

Referenced by event(), getWidget(), and ShowFrame().

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

Public Slots

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShowFrame()

◆ ~ShowFrame()

Member Function Documentation

◆ apply

◆ event()

◆ getFrameSize()

◆ getQAction()

◆ getWidget()

Member Data Documentation

◆ blockAutoUpdate

◆ comp