camitk::SimplisticComponent Class Reference

This class has been implemented to be able to instantiate a very basic component with NO_REPRESENTATION. More...

#include <SimplisticComponent.h>

Inheritance diagram for camitk::SimplisticComponent:

Collaboration diagram for camitk::SimplisticComponent:

Public Member Functions
bool	addProperty (Property *) override
	This simplistic component cannot have properties If you need properties, it means that you need a particualr component to handle them.
void	initRepresentation () override
	this component has no representation
Public Member Functions inherited from camitk::Component
	Component (QString file, QString name, Representation rep=NO_REPRESENTATION, bool createDefaultFrame=true)
	Component constructor for top-level component (please use the other constructor for sub-level components).
	Component (Component *parentComponent, const QString &name, Representation rep=NO_REPRESENTATION, bool createDefaultFrame=true)
	Component constructor for a Component that is a child of another Component You should not use this constructor for a top-level component.
virtual	~Component () override
	default destructor.
Representation	getRepresentation () const
	return the type of representation concretely implemented by this Component in the InteractiveViewer.
bool	isTopLevel () const
	return true if this component is a top-level component
Component *	getParentComponent ()
	get the parent component
Component *	getTopLevelComponent ()
	get the top-level component
virtual void	setModified (bool modified=true)
	set the modified flag
virtual bool	getModified () const
	set the modified flag
virtual void	setVisibility (QString, bool)
	set the visibility inside the viewer of the given name (the viewer needs to be a registered viewer)
virtual bool	getVisibility (QString) const
	get the visibility inside the viewer of the given name
virtual void	refresh ()
	refresh all the viewer that are currently displaying this Component At the end the InterfaceNode modification flag is reset.
virtual bool	isSelected () const
	Check if this data component is selected.
virtual void	setSelected (const bool b, const bool recursive=true)
	Update the selection flag.
const QString	getFileName () const
	get the file name where the data have to be stored/were stored
void	setFileName (const QString &)
	set the file name where the data have to be stored
bool	event (QEvent *e) override
	Overriden from QObject, this one is only intercepting signal for dynamic property changed (see constructor).
QMenu *	getActionMenu ()
	Get a QMenu that contains all the action that can be applied to this component.
virtual QVariant	toVariant () const override
virtual void	fromVariant (const QVariant &) override
	Load data from a QVariant to initialize the current object.
virtual QUuid	getUuid () const override
	Get the unique ID of the component.
virtual bool	setUuid (QUuid) override
	Set the unique ID of the component.
QStringList	getHierarchy () const override
bool	isInstanceOf (QString className) const override
	Assert that a Component instance really inherits from a given className.
unsigned int	getNumberOfPropertyWidget () override
	get the number of alternative property widgets
QWidget *	getPropertyWidgetAt (unsigned int) override
	Get the ith alternative property widget.
QObject *	getPropertyObject () override
	Get the property object that could be understood by PropertyEditor.
const QObject *	getPropertyObject () const override
void	propertyValueChanged (QString name) override
	This method is called when a dynamic property value has been modified.
void	setIndexOfPropertyExplorerTab (unsigned int index) override final
	Set the index of the tab in the ProperlyExplorer to select for display.
unsigned int	getIndexOfPropertyExplorerTab () override
	Get the index of the tab in the ProperlyExplorer to select for display.
Q_INVOKABLE camitk::Property *	getProperty (QString name) override
	Get a Property given its name.
virtual QVariant	getPropertyValue (const QString &name) const override
	get the property QVariant (same as property(const char*)) but check if it exists first.
virtual bool	setPropertyValue (const QString &name, QVariant newValue) override
	set the property QVariant value (same as setProperty(const char*, newValue)) but check if it exists first.
void	removeChild (InterfaceNode *) override
	remove a child node.
void	setParent (InterfaceNode *) override
	set the parent Component.
bool	doubleClicked () override
	This method is called each time the InterfaceNode is double clicked by the user.
void	addChild (InterfaceNode *) override
	add a child Component (sub item in the hierarchy), and modify the child's parent to be equal to this instance
void	attachChild (InterfaceNode *) override
	add a child Component (but leave its parent unchanged)
void	deleteChildren () override final
	delete all sub Component, but do not delete the pointer (only the top-level component has the right to do that)
QString	getName () const override
	get the name to be displayed
void	setName (const QString &) override
	set the name to be displayed
const ComponentList &	getChildren () const override
	get the list of the InterfaceNode children (sub items in the hierarchy)
InterfaceNode *	getParent () override
	get the parent Component
QPixmap	getIcon () override
	Get the pixmap that will be displayed for this node.
void	setNodeModified (bool) override final
	Set up the node modification flag.
bool	getNodeModified () const override
	Get the current modification flag.
bool	inItalic () const override
	A component name is not displayed in italic by default.
QMenu *	getPopupMenu (QWidget *parent=nullptr) override
	get the popup menu to display (always return nullptr, overwrite this method if you want to give here you own popup)
virtual void	setFrame (const std::shared_ptr< FrameOfReference > &frame) override
	Set the FrameOfReference of this object.
virtual const FrameOfReference *	getFrame () const override
	Get the pointer to this object's FrameOfReference.
virtual QMultiMap< const FrameOfReference *, Component * >	getAllFrames (bool includeChildrenFrames=true) override
	Get all FrameOfReference owned by this object.
virtual QMultiMap< const Transformation *, Component * >	getAllTransformations (bool includeChildrenTransformations=true) override
	Get all Transformation owned by this object.
virtual void	setFrameFrom (const InterfaceFrame *) override
	Modify this object's frame using the given object's frame.
virtual void	resetFrame () override
	Reset this object's FrameOfReference, that is call setFrame with a newly created frame of reference.
vtkSmartPointer< vtkAxesActor >	getFrameAxisActor (QString viewerName) override
	get the Frame Actor for a viewer
virtual bool	getFrameVisibility (QString viewerName) const override
	get the visibility of the Frame axis actor in the named viewer
virtual void	setFrameVisibility (QString viewerName, bool visibility) override
	set the visibility of the Frame axis actor
	delegateGet0 (myGeometry, getPointSet, vtkSmartPointer< vtkPointSet >) delegate1(myGeometry
vtkSmartPointer< vtkPointSet >	delegate1 (myGeometry, setPointData, vtkSmartPointer< vtkDataArray >) delegateConstGet0(myGeometry
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput >	delegate1 (myGeometry, setDataConnection, vtkSmartPointer< vtkAlgorithmOutput >) delegateGet1(myGeometry
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput > const RenderingModes	delegate1 (myGeometry, setColorMode, int) delegate1(myGeometry
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput > const RenderingModes const QString &vtkSmartPointer< vtkProp >	getProp (const QString &param) override
	Return the vtkProp (actors, volumes and annotations) corresponding to the given name.
unsigned int	getNumberOfProp () const override
	return the number of additional prop
vtkSmartPointer< vtkProp >	getProp (unsigned int index) override
	return an additional prop by its index
bool	addProp (const QString &name, vtkSmartPointer< vtkProp > prop) override
	insert an additional prop, defining it by its name (default visibility = false).
bool	removeProp (const QString &name) override
	remove a given additional prop.
void	pointPicked (vtkIdType, bool) override
	an inherited class can redefine this method something specific.
void	cellPicked (vtkIdType, bool) override
	an inherited class can redefine this method something specific.
virtual vtkSmartPointer< vtkActor >	get3DCursor ()
	Return an Actor for a 3D cursor on the picked location This should be redefined into something specific.
void	getBounds (double *bounds) override
	compute the object's bounding box [xmin,xmax, ymin,ymax, zmin,zmax], see Component.cpp
double	getBoundingRadius () override
	compute the object's bounding sphere radius,
	delegate4 (myGeometry, setPointPosition, const unsigned int, const double, const double, const double) delegateAndInvokeChildren1(myGeometry
const RenderingModes const InterfaceGeometry::RenderingModes	getRenderingModes () const override
	see Component.cpp
	delegateAndInvokeChildren1 (myGeometry, setEnhancedModes, const EnhancedModes) virtual const EnhancedModes getEnhancedModes() const override
	delegateAndInvokeChildren1Array (myGeometry, setActorColor, const RenderingModes, double, 4) delegateAndInvokeChildren4(myGeometry
const const const const double void	getActorColor (const RenderingModes, double[4], bool ignoreEnhancedModes=false) const override
	see Component.cpp
	delegateAndInvokeChildren3 (myGeometry, setColor, const double, const double, const double) delegateAndInvokeChildren4(myGeometry
const const const const double	delegateAndInvokeChildren2 (myGeometry, setActorOpacity, const RenderingModes, const double) delegateConstGet1(myGeometry
const const const const double const RenderingModes	delegateAndInvokeChildren1 (myGeometry, setOpacity, const double) delegate2(myGeometry
const const const const double const RenderingModes double	delegate1 (myGeometry, setTexture, vtkSmartPointer< vtkTexture >) void setGlyphType(const GlyphTypes type
virtual void	setLinesAsTubes (bool isTubes=true, bool radiusFromLength=true, double radiusFactor=1.0/40.0, int numberOfSides=5) override
	Set the lines as tubes (works only for vtkDataSet representation that contains lines)
vtkSmartPointer< vtkImageData >	delegate1 (mySlice, setOriginalVolume, vtkSmartPointer< vtkImageData >) delegateConstGet0(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor >	delegateConstGet0 (mySlice, get3DImageActor, vtkSmartPointer< vtkImageActor >) delegateConstGet0(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor >	delegateGet0 (mySlice, getPixelActor, vtkSmartPointer< vtkActor >) delegate3(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double	delegate0 (mySlice, updatePickPlane) delegate1(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double int	delegate3 (mySlice, setSlice, double, double, double) delegateConstGet0(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double int int	delegate3 (mySlice, setPixelRealPosition, double, double, double) delegate1(mySlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double int int vtkSmartPointer< vtkTransform > int	getNumberOfSlices () const override
	see Component.cpp
int	getSlice () const override
	see Component.cpp
Public Member Functions inherited from camitk::InterfaceProperty
	~InterfaceProperty ()=default
	empty virtual destructor, to avoid memory leak
Public Member Functions inherited from camitk::InterfaceNode
virtual	~InterfaceNode ()=default
	empty virtual destructor, to avoid memory leak
Public Member Functions inherited from camitk::InterfaceGeometry
virtual	~InterfaceGeometry ()=default
	empty virtual destructor, to avoid memory leak
virtual vtkSmartPointer< vtkPointSet >	getPointSet ()=0
virtual void	setPointSet (vtkSmartPointer< vtkPointSet >)=0
	set the low-level data set.
virtual void	setPointData (vtkSmartPointer< vtkDataArray >)=0
	set the point data (may contains a lookup table).
virtual void	setMeshWorldTransform (vtkSmartPointer< vtkTransform >)=0
	set the transformation for 3D representation
virtual vtkSmartPointer< vtkAlgorithmOutput >	getDataPort () const =0
	get the custom algorithm pipeline input.
virtual void	setDataConnection (vtkSmartPointer< vtkAlgorithmOutput >)=0
	Set/reset the connection for the InterfaceGeometry internal algorithm.
virtual void	setTexture (vtkSmartPointer< vtkTexture >)=0
	Set a texture to this object.
virtual vtkSmartPointer< vtkActor >	getActor (const RenderingModes)=0
	Return the actor for the representation mode, nullptr if the actor doesn't exist.
virtual void	updateLabel (const QString &label)=0
	update position and text of the label prop
virtual void	setPointPosition (const unsigned int orderNumber, const double x, const double y, const double z)=0
	set a given point position
virtual void	setRenderingModes (const RenderingModes)=0
virtual void	setEnhancedModes (const EnhancedModes)=0
	set the enhanced mode
virtual const EnhancedModes	getEnhancedModes () const =0
	get the current enhanced mode
virtual void	setActorColor (const RenderingModes, double *color)=0
	Set the color of given representation modes.
virtual void	setActorColor (const RenderingModes, const double, const double, const double)=0
	Set the color of given representation modes.
virtual void	getActorColor (const RenderingModes mode, double *color, bool ignoreEnhancedModes=false) const =0
	Get the color of given representation modes in the second parameter.
virtual void	setColor (const double, const double, const double)=0
	Set an (r,g,b) color to all representation modes, without changing the opacity.
virtual void	setColor (const double, const double, const double, const double)=0
	Set an (r,g,b,a) color to all representation modes.
virtual void	setActorOpacity (const RenderingModes, const double)=0
	Set the opacity of this representation modes. WARNING color field (surfaceColor, ...) are not modified!
virtual double	getActorOpacity (const RenderingModes) const =0
	Return the opacity of a given renderng mode.
virtual void	setOpacity (const double)=0
	Set the opacity of this object. WARNING color field (surfaceColor, ...) are not modified!
virtual void	setMapperScalarRange (double min, double max)=0
	Set the mapper scalar range.
virtual void	setGlyphType (const GlyphTypes type, const double size=0.0)=0
	Set the glyph type (a glyph is a geometric representation attached to every point in the input dataset).
virtual void	setColorMode (int vtkColorMode=VTK_COLOR_MODE_DEFAULT)=0
Public Member Functions inherited from camitk::InterfaceBitMap
virtual vtkSmartPointer< vtkImageActor >	get2DImageActor () const =0
	Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D viewers.
virtual vtkSmartPointer< vtkImageActor >	get3DImageActor () const =0
	Return the vtkImageActor (vtkProp) representing a slice to be displayed in 3D viewers.
virtual vtkSmartPointer< vtkImageData >	getImageData () const =0
	Returns the encapsultaed data structure: the image as a vtkImageData.
virtual int	getNumberOfColors () const =0
	Return the number of colors in the images.
virtual vtkSmartPointer< vtkActor >	getPickPlaneActor () const =0
	Return the vtkActor used to pick pixels in the slices.
virtual vtkSmartPointer< vtkActor >	getPixelActor ()=0
	Return the vtkActor used to pick pixels in the slices.
virtual void	pixelPicked (double, double, double)=0
	This method is called when the associated plane has been picked in the InteractiveViewer, the given coordinates is position where the plane was picked.
virtual void	setArbitraryTransform (vtkSmartPointer< vtkTransform >)=0
	Set the pointer to the image transformation.
virtual void	setOriginalVolume (vtkSmartPointer< vtkImageData >)=0
	set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline
virtual void	setPixelRealPosition (double, double, double)=0
	move the pixel selection green indicator (pixelActor) to the given real position
virtual void	setSlice (double x, double y, double z)=0
	Set the slice corresponding to the given image coordinates (in RAI convention)
virtual void	setSlice (int s)=0
	Set the current slice index.
virtual void	updatePickPlane ()=0
	update the position of the plane surrounding the currently selected slice
virtual	~InterfaceBitMap ()=default
	virtual destructor
Public Member Functions inherited from camitk::InterfaceFrame
virtual	~InterfaceFrame ()=default
	empty virtual destructor, to avoid memory leak
Public Member Functions inherited from camitk::InterfacePersistence
virtual	~InterfacePersistence ()=default

Static Public Member Functions
static SimplisticComponent *	createInstance (QString name)

Additional Inherited Members
Public Types inherited from camitk::Component
enum	Representation { GEOMETRY , SLICE , NO_REPRESENTATION }
	The different representation that can be implemented to represent this Component in the InteractiveViewer. More...
Public Types inherited from camitk::InterfaceGeometry
enum	EnhancedMode { Normal = 0x0 , Hidden = 0x1 , Shaded = 0x2 , Highlighted = 0x4 }
	(and QFlags EnhancedModes) handle the way the rendering actors will be enhanced or not (from completely hidden to highlighted) More...
enum	GlyphType { NoGlyph = 0x0 , Sphere = 0x1 }
	(and QFlags GlyphTypes) is the type of glyph attached to the geometry representation More...
enum	RenderingMode { None = 0x0 , Surface = 0x1 , Wireframe = 0x2 , Points = 0x4 }
	(and QFlags RenderingModes) handle actor rendering options (render this InterfaceGeometry as a surface, a wireframe and set of points). More...
Public Attributes inherited from camitk::Component
	setPointSet
vtkSmartPointer< vtkPointSet >	getDataPort
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput >	getActor
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput >	vtkSmartPointer< vtkActor >
vtkSmartPointer< vtkPointSet > vtkSmartPointer< vtkAlgorithmOutput > const RenderingModes	updateLabel
	setRenderingModes
	setActorColor
const	RenderingModes
const const	double
const const const	double
	setColor
const	double
const const const const double	getActorOpacity
const const const const double	double
const const const const double const RenderingModes	setMapperScalarRange
const const const const double const RenderingModes	double
const const const const double const RenderingModes double const double	size = 0.0) override
	getImageData
vtkSmartPointer< vtkImageData >	get2DImageActor
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor >	getPickPlaneActor
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor >	pixelPicked
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor >	double
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double	setSlice
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double int	getNumberOfColors
vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > double int int	setArbitraryTransform
Protected Attributes inherited from camitk::Component
ComponentList	childrenComponent
	The explorer sub items.
std::shared_ptr< FrameOfReference >	frameOfReference = nullptr
	The FrameOfReference in which this component's data is represented.
unsigned int	indexOfPropertyExplorerTab
	The PropertyExplorer tab index to select once refreshed.
bool	isSelectedFlag
	tells if this particular Component is selected or not
bool	modifiedFlag
	the modification flag (could be extended to manage a undo/redo list)
QString	myFileName
	the file name from which the Component is loaded
InterfaceGeometry *	myGeometry
	myGeometry is the 3d representation of this Component, the Component delegates all InterfaceGeometry activity to myGeometry (delegation pattern)
InterfaceNode *	myParentNode
	who is the boss? The Component!
InterfaceBitMap *	mySlice
	mySlice is the slice representation of this data component, the Component delegates all InterfaceBitMap activity to mySlice (delegation pattern)

Detailed Description

This class has been implemented to be able to instantiate a very basic component with NO_REPRESENTATION.

Caution ! The class Component has been created non instantiable on purpose ! This class SHOULD not replace a real Component inherited class handing data. It is a helper class for those who need to use Interface node and/or Interface frame only.

This is why this class should be final (no inheritance allowed) if it was writen in Java, has no representation (neither Slice nor Geometry) and reimplements addProperty to prevent from adding property (if you need a property, this means that you handle data, this means that you need a proper component).

Member Function Documentation

addProperty()

bool SimplisticComponent::addProperty ( camitk::Property *  p )

overridevirtual

This simplistic component cannot have properties If you need properties, it means that you need a particualr component to handle them.

Reimplemented from camitk::Component.

References CAMITK_INFO.

createInstance()

SimplisticComponent * SimplisticComponent::createInstance ( QString  name )

static

initRepresentation()

void camitk::SimplisticComponent::initRepresentation ( )

inlineoverridevirtual

this component has no representation

Implements camitk::Component.

---

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

• SimplisticComponent.h
• SimplisticComponent.cpp