This class manage an MML monitoring document ".mml". More...

#include <MMLComponent.h>

Public Member Functions
void	connectPml ()
	connect pml More...

MMLDisplay *	getDisplay ()
	get the display More...

virtual bool	getModified () const
	check if the mml or pml were modified in the UI More...

MonitoringGuiManager *	getMonitoringGuiManager ()
	get MonitoringGuiManager More...

PMLComponent *	getPMLComponent ()
	get Physical model manager More...

	MMLComponent (const QString &)
	Default constructor: give it the name of the file containing the data (.mml file) This method may throw an AbortException if a problem occurs. More...

void	saveMML ()
	save the mml in the current filename (and the pml if needed) More...

virtual	~MMLComponent ()
	destructor More...

Redefined from Component
bool	save ()
	save the current mml in the current file name. More...

void	initRepresentation ()
	init the representation (nothing to do, every 3D representation is managed by the PMLComponent) More...

virtual void	setSelected (const bool b, const bool recursive=true)
	Update the selection flag (this method is overridden in order to show the default modeling action when the component is selected for the first time). More...

Public Member Functions inherited from camitk::Component
	Component (QString file, QString name, Representation rep=NO_REPRESENTATION)
	Component constructor for top-level component (please use the other constructor for sub-level components). More...

	Component (Component *parentComponent, const QString &name, Representation rep=NO_REPRESENTATION)
	Component constructor for a Component that is a child of another Component You should not use this constructor for a top-level component. More...

	~Component () override
	default destructor. More...

Representation	getRepresentation () const
	return the type of representation concretely implemented by this Component in the InteractiveViewer. More...

bool	isTopLevel () const
	return true if this component is a top-level component More...

virtual Component *	getParentComponent ()
	get the parent component More...

virtual Component *	getTopLevelComponent ()
	get the top-level component More...

virtual InterfaceFrame *	getFrame ()
	get the associated frame More...

virtual void	setModified (bool modified=true)
	set the modified flag More...

virtual void	setVisibility (Viewer *, bool)
	set the visibility for a viewer More...

virtual bool	getVisibility (Viewer *) const
	get the visibility of a viewer More...

virtual void	refresh () const
	refresh all the viewer that are currently displaying this Component More...

virtual void	refreshInterfaceNode ()
	Asks all viewers that are currently displaying this Component to rebuild the representation of the InterfaceNode for this Component. More...

virtual bool	isSelected () const
	Check if this data component is selected. More...

const QString	getFileName () const
	get the file name where the data have to be stored/were stored More...

void	setFileName (const QString &)
	set the file name where the data have to be stored More...

bool	event (QEvent *e) override
	Overriden from QObject, this one is only intercepting signal for dynamic property changed (see constructor). More...

QMenu *	getActionMenu ()
	Get a QMenu that contains all the action that can be applied to this component. More...

QStringList	getHierarchy () const override

bool	isInstanceOf (QString className) const override
	Assert that a Component instance really inherits from a given className. More...

unsigned int	getNumberOfPropertyWidget ()
	get the number of alternative property widgets More...

QWidget *	getPropertyWidgetAt (unsigned int i)
	Get the ith alternative property widget. More...

QObject *	getPropertyObject ()
	Get the property object that could be understood by PropertyEditor. More...

void	updateProperty (QString name, QVariant value) override
	update property: if you this method, do not forget to call the superclass method for the property not managed locally in order to properly manage all inherited dynamic properties. More...

void	setIndexOfPropertyExplorerTab (unsigned int index)
	Set the index of the tab in the ProperlyExplorer to select for display. More...

unsigned int	getIndexOfPropertyExplorerTab ()
	Get the index of the tab in the ProperlyExplorer to select for display. More...

Q_INVOKABLE Property *	getProperty (QString name) override
	Get a Property given its name. More...

bool	addProperty (Property *) override
	Add a new CamiTK property to the component. More...

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 More...

void	attachChild (InterfaceNode *) override
	add a child Component (but leave its parent unchanged) More...

void	removeChild (InterfaceNode *) override
	remove from the the sub item vector. More...

void	setParent (InterfaceNode *) override
	set the parent Component. This method automatically remove this Component from its previous (if already had one parent Component) More...

void	deleteChildren () override
	delete all sub Component, but do not delete the pointer (only the top-level component has the right to do that) More...

QString	getName () const override
	get the name to be displayed More...

void	setName (const QString &) override
	set the name to be displayed More...

const ComponentList &	getChildren () override
	get the list of the InterfaceNode children (sub items in the hierarchy) More...

bool	doubleClicked () override
	this method is called each time the InterfaceNode is double clicked by the user. More...

InterfaceNode *	getParent () override
	get the parent Component More...

QPixmap	getIcon () override
	Get the pixmap that will be displayed for this node. More...

bool	inItalic () const override
	A component name is not displayed in italic by default. More...

QMenu *	getPopupMenu (QWidget *parent=nullptr)
	get the popup menu to display (always return NULL, overwrite this method if you want to give here you own popup) More...

const QString	getLabel () const override

void	setLabel (QString newName) override
	set the string used to display the label, do the same as setName More...

	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 vtkSmartPointer< vtkProp >	getProp (const QString &param)
	Return the vtkProp (actors, volumes and annotations) corresponding to the given name. More...

unsigned int	getNumberOfProp () const
	return the number of additional prop More...

vtkSmartPointer< vtkProp >	getProp (unsigned int index)
	return an additional prop by its index More...

bool	addProp (const QString &name, vtkSmartPointer< vtkProp > prop)
	insert an additional prop, defining it by its name (default visibility = false) More...

bool	removeProp (const QString &name)
	remove a given additional prop. More...

void	pointPicked (vtkIdType, bool)
	an inherited class can redefine this method something specific. More...

void	cellPicked (vtkIdType, bool)
	an inherited class can redefine this method something specific. More...

void	getBounds (double *bounds) override
	compute the object's bounding box [xmin,xmax, ymin,ymax, zmin,zmax], see Component.cpp More...

double	getBoundingRadius () override
	compute the object's bounding sphere radius, More...

	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 More...

	delegateAndInvokeChildren1 (myGeometry, setEnhancedModes, const EnhancedModes) delegateConstGet0(myGeometry

const EnhancedModes	delegateAndInvokeChildren1Array (myGeometry, setActorColor, const RenderingModes, double, 4) delegateAndInvokeChildren4(myGeometry

const EnhancedModes const const const const double void	getActorColor (const RenderingModes, double [4]) override
	see Component.cpp More...

	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

	delegate1 (myGeometry, setLinesAsTubes, bool) delegate1(myGeometry

	delegateConstGet0 (mySlice, getImageData, vtkSmartPointer< vtkImageData >) delegate1(mySlice

vtkSmartPointer< vtkImageData >	delegateConstGet0 (mySlice, get2DImageActor, vtkSmartPointer< vtkImageActor >) delegateConstGet0(mySlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor >	delegateConstGet0 (mySlice, getPickPlaneActor, vtkSmartPointer< vtkActor >) delegateGet0(mySlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor >	delegate3 (mySlice, pixelPicked, double, double, double) delegate0(mySlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane	delegate1 (mySlice, setSlice, int) delegate3(mySlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane double	delegateConstGet0 (mySlice, getNumberOfColors, int) delegate3(mySlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane double double	delegate1 (mySlice, setImageWorldTransform, vtkSmartPointer< vtkTransform >) int getNumberOfSlices() const override
	see Component.cpp More...

int	getSlice () const override
	see Component.cpp More...

const QString &	getFrameName () const override
	Hierarchy accessors / Modifyers. More...

	delegate1 (myFrame, setFrameName, QString) InterfaceFrame *getParentFrame() const override

void	setParentFrame (InterfaceFrame *frame, bool keepTransform=true) override
	Set the parent frame and update or not its transform during the parent transition. More...

const QVector< InterfaceFrame * > &	getChildrenFrame () const override
	Get the Children Frames from the current Frame in the Frame Hierarchy The Frame hierarchy may not be the same as the Component Hierarchy. More...

const vtkSmartPointer< vtkTransform >	getTransformFromWorld () const override
	Transforms accessors / Modifyers. More...

const vtkSmartPointer< vtkTransform >	getTransform () const override
	Get the transformation with respect to the parent frame. More...

const vtkSmartPointer< vtkTransform >	getTransformFromFrame (InterfaceFrame *frame) const override
	Compute the transformation from any other frame to the current frame. More...

	delegate1 (myFrame, setTransform, vtkSmartPointer< vtkTransform >) delegate0(myFrame

resetTransform	delegate3 (myFrame, translate, double, double, double) delegate3(myFrame

resetTransform double	delegate3 (myFrame, rotateVTK, double, double, double) delegate3(myFrame

resetTransform double double	delegate3 (myFrame, setTransformTranslationVTK, double, double, double) delegate3(myFrame

resetTransform double double double	delegate3 (myFrame, setTransformRotationVTK, double, double, double) vtkSmartPointer< vtkAxesActor > getFrameAxisActor() override

	delegate2 (myFrame, setFrameVisibility, Viewer , bool) bool getFrameVisibility(Viewer viewer) const override

	delegate1 (myFrame, addFrameChild, InterfaceFrame *) delegate1(myFrame

Public Member Functions inherited from camitk::InterfaceProperty
	~InterfaceProperty ()=default
	empty virtual destructor, to avoid memory leak More...

Public Member Functions inherited from camitk::InterfaceNode
virtual	~InterfaceNode ()=default
	empty virtual destructor, to avoid memory leak More...

Public Member Functions inherited from camitk::InterfaceGeometry
virtual	~InterfaceGeometry ()=default
	empty virtual destructor, to avoid memory leak More...

virtual vtkSmartPointer< vtkPointSet >	getPointSet ()=0

virtual void	setPointSet (vtkSmartPointer< vtkPointSet >)=0
	set the low-level data set. More...

virtual void	setPointData (vtkSmartPointer< vtkDataArray >)=0
	set the point data (may contains a lookup table). More...

virtual void	setMeshWorldTransform (vtkSmartPointer< vtkTransform >)=0
	set the transformation for 3D representation More...

virtual vtkSmartPointer< vtkAlgorithmOutput >	getDataPort () const =0
	get the custom algorithm pipeline input. More...

virtual void	setDataConnection (vtkSmartPointer< vtkAlgorithmOutput >)=0
	Set/reset the connection for the InterfaceGeometry internal algorithm. More...

virtual vtkSmartPointer< vtkActor >	getActor (const RenderingModes)=0
	Return the actor for the representation mode, NULL if the actor doesn't exist. More...

virtual void	setTexture (vtkSmartPointer< vtkTexture >)=0
	Set a texture to this object. More...

virtual void	setPointPosition (const unsigned int orderNumber, const double x, const double y, const double z)=0
	set a given point position More...

virtual void	setRenderingModes (const RenderingModes)=0

virtual void	setEnhancedModes (const EnhancedModes)=0
	set the enhanced mode More...

virtual const EnhancedModes	getEnhancedModes () const =0
	get the current enhanced mode More...

virtual void	setActorColor (const RenderingModes, double *color)=0
	Set the color of given representation modes. More...

virtual void	setActorColor (const RenderingModes, const double, const double, const double)=0
	Set the color of given representation modes. More...

virtual void	getActorColor (const RenderingModes, double *color)=0
	Get the color of given representation modes in the second parameter. More...

virtual void	setColor (const double, const double, const double)=0
	Set an (r,g,b) color to all representation modes, without changing the opacity. More...

virtual void	setColor (const double, const double, const double, const double)=0
	Set an (r,g,b,a) color to all representation modes. More...

virtual void	setActorOpacity (const RenderingModes, const double)=0
	Set the opacity of this representation modes. WARNING color field (surfaceColor, ...) are not modified! More...

virtual double	getActorOpacity (const RenderingModes) const =0
	Return the opacity of a given renderng mode. More...

virtual void	setOpacity (const double)=0
	Set the opacity of this object. WARNING color field (surfaceColor, ...) are not modified! More...

virtual void	setMapperScalarRange (double min, double max)=0
	Set the mapper scalar range. More...

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). More...

virtual void	setLinesAsTubes (bool)=0
	set the lines as tubes (works only for vtkDataSet representation that contains lines) More...

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. More...

virtual vtkSmartPointer< vtkImageActor >	get3DImageActor () const =0
	Return the vtkImageActor (vtkProp) representing a slice to be displayed in 3D viewers. More...

virtual vtkSmartPointer< vtkImageData >	getImageData () const =0
	Returns the encapsultaed data structure: the image as a vtkImageData. More...

virtual int	getNumberOfColors () const =0
	Return the number of colors in the images. More...

virtual int	getNumberOfSlices () const =0
	Return the number of slices in the image data set. More...

virtual vtkSmartPointer< vtkActor >	getPickPlaneActor () const =0
	Return the vtkActor used to pick pixels in the slices. More...

virtual vtkSmartPointer< vtkActor >	getPixelActor ()=0
	Return the vtkActor used to pick pixels in the slices. More...

virtual void	pixelPicked (double, double, double)=0
	Return 2D Axes at the proper slice origin. More...

virtual void	setImageWorldTransform (vtkSmartPointer< vtkTransform >)=0
	set the transformation for 3D image representation More...

virtual void	setOriginalVolume (vtkSmartPointer< vtkImageData >)=0
	set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline More...

virtual void	setPixelRealPosition (double, double, double)=0
	move the pixel selection green indicator (pixelActor) to the given real position More...

virtual void	setSlice (int s)=0
	Set the current slice index. More...

virtual void	setSlice (double x, double y, double z)=0
	Set the slice corresponding to the given image coordinates (in RAI convention) More...

virtual void	updatePickPlane ()=0

virtual	~InterfaceBitMap ()=default
	virtual destructor More...

Public Member Functions inherited from camitk::InterfaceFrame
virtual void	addFrameChild (InterfaceFrame *frame)=0
	Add the input frame as a child of the current frame. More...

virtual vtkSmartPointer< vtkAxesActor >	getFrameAxisActor ()=0
	Gives the 3D representation of the frame (based on xyz arrows) More...

virtual bool	getFrameVisibility (Viewer *viewer) const =0
	Get the Component Frame visibility for a given viewer. More...

virtual void	removeFrameChild (InterfaceFrame *frame)=0
	Remove the input frame as a child of the current frame. More...

virtual void	setFrameVisibility (Viewer *viewer, bool visible)=0
	Set the Component Frame visible for a given viewer. More...

virtual	~InterfaceFrame ()=default
	empty virtual destructor, to avoid memory leak More...

virtual void	setFrameName (QString name)=0
	Set the Frame Unique identifyer. More...

virtual InterfaceFrame *	getParentFrame () const =0
	Get the parent frame. More...

virtual void	setTransform (vtkSmartPointer< vtkTransform > transform)=0
	Set the current input frame position (according to its parent Frame) More...

virtual void	resetTransform ()=0
	Set the current frame transform to identity. More...

virtual void	translate (double x, double y, double z)=0
	Apply a translation relative to the current position. More...

virtual void	rotate (double aroundX, double aroundY, double aroundZ)=0
	Apply rotations relative to the current position in the alphabetical order (X, Y, Z). More...

virtual void	rotateVTK (double aroundX, double aroundY, double aroundZ)=0
	Apply a rotation relative to the current position, using the VTK rotation order (Z, X, Y) More...

virtual void	setTransformTranslation (double x, double y, double z)=0
	Set the translation part of the 3D space transformation of the current frame. More...

virtual void	setTransformTranslationVTK (double x, double y, double z)=0
	Set the translation part of the 3D space transformation of the current frame. More...

virtual void	setTransformRotation (double aroundX, double aroundY, double aroundZ)=0
	Set the rotation part of the 3D space transformation of the current frame. More...

virtual void	setTransformRotationVTK (double aroundX, double aroundY, double aroundZ)=0
	Set the rotation part of the 3D space transformation of the current frame. More...

Private Attributes
MMLDisplay *	display
	display manager More...

QString	exportedMml
	when a .scn is loaded, name of the automatically exported mml file (empty string otherwise) More...

MonitoringGuiManager *	mmlGUI
	the mml GUI class is used directly More...

bool	neverSelected
	the first selection should trigger the pml exporer action (default action) More...

PMLComponent *	pmlComponent
	physical model manager More...

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 >

	setRenderingModes

	getEnhancedModes

const EnhancedModes	setActorColor

const EnhancedModes const	RenderingModes

const EnhancedModes const const	double

const EnhancedModes const const const	double

	setColor

const	double

const const	double

const const 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

	setMeshWorldTransform

	setOriginalVolume

vtkSmartPointer< vtkImageData >	get3DImageActor

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor >	getPixelActor

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane	setSlice

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane	double

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane double	setPixelRealPosition

vtkSmartPointer< vtkImageData > vtkSmartPointer< vtkImageActor > vtkSmartPointer< vtkActor > updatePickPlane double	double

resetTransform	rotate

resetTransform	double

resetTransform double	setTransformTranslation

resetTransform double	double

resetTransform double double	setTransformRotation

resetTransform double double	double

	removeFrameChild

Public Attributes inherited from camitk::InterfaceBitMap
QMap< QString, vtkSmartPointer< vtkProp > >	extraProp
	The additional map for prop (include at least "label" and "glyph". More...

Protected Attributes inherited from camitk::Component
ComponentList	childrenComponent
	The explorer sub items. More...

unsigned int	indexOfPropertyExplorerTab
	The PropertyExplorer tab index to select once refreshed. More...

bool	isSelectedFlag
	tells if this particular Component is selected or not More...

bool	modifiedFlag
	the modificatio flag (could be extended to manage a undo/redo list) More...

QString	myFileName
	the file name from which the Component is loaded More...

InterfaceFrame *	myFrame
	myFrame is the pose (position and orientation) of the Component in the world frame, the Component delegates all InterfaceFrame activity to myFrame (delegation pattern) More...

InterfaceGeometry *	myGeometry
	myGeometry is the 3d representation of this Component, the Component delegates all InterfaceGeometry activity to myGeometry (delegation pattern) More...

InterfaceNode *	myParentNode
	who is the boss? The Component! More...

InterfaceBitMap *	mySlice
	mySlice is the slice representation of this data component, the Component delegates all InterfaceBitMap activity to mySlice (delegation pattern) More...