Computer Assited Medical Intervention Tool Kit  version 5.0
VolumeRenderingAction Class Reference

This action perform a volume rendering. More...

#include <VolumeRenderingAction.h>

+ Inheritance diagram for VolumeRenderingAction:
+ Collaboration diagram for VolumeRenderingAction:

Public Slots

virtual camitk::Action::ApplyStatus apply () override
 this method is automatically called when the action is triggered. More...
 
virtual QWidget * getWidget () override
 
- 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

void createVolumeRendering ()
 create the volume rendering component actors (remove previous one if existed) More...
 
QAction * getQAction (camitk::Component *target=nullptr) override
 Get the corresponding QAction (overriden to update the checked status) More...
 
 VolumeRenderingAction (camitk::ActionExtension *)
 Default Constructor. More...
 
virtual ~VolumeRenderingAction ()=default
 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 QWidget * getWidget ()
 This method has to be redefined in your Action only if: 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::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...
 
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...
 
ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component. More...
 

Private Attributes

camitk::ImageComponentimage
 currently managed/selected image; More...
 
VolumeRenderingWidgetmyWidget
 no default widget but a VolumeRenderingWidget displaied when necessary More...
 
QString volumeName
 Name given to the Volume rendering actor attached to the Volume Rendering subComponant of a volume image. More...
 

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 perform a volume rendering.

Take as an input a gray-level camitk::ImageComponent and renders a 3D color image.

Constructor & Destructor Documentation

◆ VolumeRenderingAction()

VolumeRenderingAction::VolumeRenderingAction ( camitk::ActionExtension extension)

Default Constructor.

◆ ~VolumeRenderingAction()

virtual VolumeRenderingAction::~VolumeRenderingAction ( )
virtualdefault

Default Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus VolumeRenderingAction::apply ( )
overridevirtualslot

this method is automatically called when the action is triggered.

Call getTargets() method to get the list of components to use.

Note
getTargets() is automatically filtered so that it only contains compatible components, i.e., instances of ImageComponent (or a subclass).

References camitk::Action::ABORTED, CAMITK_WARNING, createVolumeRendering(), camitk::Component::getProp(), camitk::ImageComponent::getVolumeRenderingChild(), image, myWidget, camitk::refresh(), camitk::Component::setVisibility(), camitk::Action::SUCCESS, and volumeName.

Referenced by getWidget().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createVolumeRendering()

void VolumeRenderingAction::createVolumeRendering ( )

create the volume rendering component actors (remove previous one if existed)

References camitk::Component::addProp(), VolumeRenderingWidget::getAmbient(), VolumeRenderingWidget::getColorPoints(), VolumeRenderingWidget::getDiffuse(), camitk::ImageComponent::getImageData(), VolumeRenderingWidget::getOpacityPoints(), camitk::Component::getProp(), VolumeRenderingWidget::getSpecular(), camitk::Component::getTransform(), VolumeRenderingWidget::getTransparencyPoints(), camitk::ImageComponent::getVolumeRenderingChild(), image, myWidget, camitk::Component::removeProp(), camitk::renderer, and volumeName.

Referenced by apply().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getQAction()

QAction * VolumeRenderingAction::getQAction ( camitk::Component target = nullptr)
overridevirtual

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

Reimplemented from camitk::Action.

References camitk::Component::getProp(), camitk::Component::getVisibility(), camitk::ImageComponent::getVolumeRenderingChild(), and volumeName.

Referenced by getWidget().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getWidget

QWidget * VolumeRenderingAction::getWidget ( )
overridevirtualslot

References apply(), camitk::Component::getName(), camitk::Component::getProp(), getQAction(), camitk::Action::getTargets(), camitk::Component::getVisibility(), camitk::ImageComponent::getVolumeRenderingChild(), image, myWidget, camitk::refresh(), VolumeRenderingWidget::updateUI(), and volumeName.

+ Here is the call graph for this function:

Member Data Documentation

◆ image

camitk::ImageComponent* VolumeRenderingAction::image
private

currently managed/selected image;

Referenced by apply(), createVolumeRendering(), and getWidget().

◆ myWidget

VolumeRenderingWidget* VolumeRenderingAction::myWidget
private

no default widget but a VolumeRenderingWidget displaied when necessary

Referenced by apply(), createVolumeRendering(), and getWidget().

◆ volumeName

QString VolumeRenderingAction::volumeName
private

Name given to the Volume rendering actor attached to the Volume Rendering subComponant of a volume image.

Referenced by apply(), createVolumeRendering(), getQAction(), and getWidget().


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