Computer Assited Medical Intervention Tool Kit  version 4.1
Public Slots | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
FrameEditor Class Reference

This action allows you to apply a linear transformation (translation,rotation around axes) on the top level selected Frame. More...

#include <FrameEditor.h>

Inherits camitk::Action.

Public Slots

virtual ApplyStatus apply ()
 Update the component's frame with the translation and rotation parameters of the widget. More...
 
virtual void displayFrameToggled (bool)
 
virtual void frameSizeChanged (int val)
 
virtual void rotate ()
 
virtual void rotationChanged ()
 
virtual void setParentFrame ()
 
virtual void setRotation ()
 
virtual void setTransformation ()
 
virtual void setTranslation ()
 
virtual void transformationChanged ()
 
virtual void translate ()
 
virtual void translationChanged ()
 
- Public Slots inherited from camitk::Action
virtual 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...
 
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...
 
ApplyStatus trigger (QWidget *parent=nullptr)
 This method triggers the action. More...
 

Public Member Functions

 FrameEditor (camitk::ActionExtension *)
 the constructor More...
 
virtual QWidget * getWidget ()
 this method creates and returns the widget containing the user interface for the action More...
 
virtual ~FrameEditor ()
 Destructor. More...
 
- Public Member Functions inherited from camitk::Action
 Action (ActionExtension *)
 Default Constructor: the ActionExtension is needed. More...
 
ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component. More...
 
ComponentList getOutputComponents ()
 Returns the output Component(s) More...
 
void setInputComponent (Component *input)
 Specify the input Components in case of only one Component. 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...
 
 ~Action () override
 Destructor. More...
 
QAction * getQAction ()
 Get the corresponding QAction. 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...
 
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 PropertygetProperty (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...
 

Protected Member Functions

virtual void initializeDialogWithCurrentComponent ()
 
- 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...
 

Private Member Functions

void init ()
 initialize the dialog More...
 

Private Attributes

camitk::ComponentcurrentComponent
 
QWidget * myWidget
 
QVector< QVector< QLineEdit * > > transfromMatrixElements
 
Ui::FrameEditor ui
 the Qt Gui More...
 

Additional Inherited Members

- Public Types inherited from camitk::Action
enum  ApplyStatus {
  SUCCESS, ERROR, WARNING, ABORTED,
  TRIGGERED
}
 describes what happened during the application of an algorithm (i.e. results of the apply method) More...
 
- Static Public Member Functions inherited from camitk::Action
static QString getStatusAsString (ApplyStatus)
 
- Protected Attributes inherited from camitk::Action
QWidget * actionWidget
 the action widget More...
 

Detailed Description

This action allows you to apply a linear transformation (translation,rotation around axes) on the top level selected Frame.

Constructor & Destructor Documentation

◆ FrameEditor()

FrameEditor::FrameEditor ( camitk::ActionExtension extension)

◆ ~FrameEditor()

FrameEditor::~FrameEditor ( )
virtual

Destructor.

References myWidget.

Member Function Documentation

◆ apply

Action::ApplyStatus FrameEditor::apply ( )
virtualslot

Update the component's frame with the translation and rotation parameters of the widget.

This keeps synchronized the frame with the value selected by the user

References camitk::Action::SUCCESS.

◆ displayFrameToggled

void FrameEditor::displayFrameToggled ( bool  display)
virtualslot

◆ frameSizeChanged

void FrameEditor::frameSizeChanged ( int  val)
virtualslot

◆ getWidget()

QWidget * FrameEditor::getWidget ( )
virtual

this method creates and returns the widget containing the user interface for the action

Reimplemented from camitk::Action.

References currentComponent, camitk::Action::getTargets(), init(), initializeDialogWithCurrentComponent(), and myWidget.

◆ init()

void FrameEditor::init ( )
private

◆ initializeDialogWithCurrentComponent()

void FrameEditor::initializeDialogWithCurrentComponent ( )
protectedvirtual

◆ rotate

void FrameEditor::rotate ( )
virtualslot

◆ rotationChanged

void FrameEditor::rotationChanged ( )
virtualslot

References CAMITK_TRACE.

Referenced by init().

◆ setParentFrame

void FrameEditor::setParentFrame ( )
virtualslot

◆ setRotation

void FrameEditor::setRotation ( )
virtualslot

◆ setTransformation

void FrameEditor::setTransformation ( )
virtualslot

◆ setTranslation

void FrameEditor::setTranslation ( )
virtualslot

◆ transformationChanged

void FrameEditor::transformationChanged ( )
virtualslot

References transfromMatrixElements, and ui.

Referenced by init().

◆ translate

void FrameEditor::translate ( )
virtualslot

◆ translationChanged

void FrameEditor::translationChanged ( )
virtualslot

References CAMITK_TRACE.

Referenced by init().

Member Data Documentation

◆ currentComponent

camitk::Component* FrameEditor::currentComponent
private

◆ myWidget

QWidget* FrameEditor::myWidget
private

◆ transfromMatrixElements

QVector< QVector<QLineEdit*> > FrameEditor::transfromMatrixElements
private

◆ ui

Ui::FrameEditor FrameEditor::ui
private

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