Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Protected Attributes | List of all members
camitk::Component Class Referenceabstract

A Component represents something that could be included in the explorer view, the interactive 3D viewer, and that could have or not a contextual popup menu (open by a right click in the explorer), a property dialog (to change some properties) Thus, a Component inherits from many abstract classes. More...

#include <Component.h>

+ Inheritance diagram for camitk::Component:

Public Types

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 Types inherited from camitk::InterfaceBitMap
enum  PossibleOrientation { AXIAL_ORIENTATION, CORONAL_ORIENTATION, SAGITTAL_ORIENTATION, ARBITRARY_ORIENTATION }
 Common slices orientation: axial, sagittal, coronal or anything else. More...
 

Public Member Functions

Component top level methods

All the methods specific to a data component (but not described in any abstract representation classes)

 Component (const QString &file, const 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) throw (AbortException)
 Component constructor for a Component that is a child of another Component You should not use this constructor for a top-level component. More...
 
virtual ~Component ()
 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 ComponentgetParentComponent ()
 get the parent component More...
 
virtual ComponentgetTopLevelComponent ()
 get the top-level component More...
 
virtual void setModified (bool modified=true)
 set the modified flag More...
 
virtual bool getModified () const
 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...
 
virtual void setSelected (const bool b, const bool recursive=true)
 Update the selection flag. 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)
 Overriden from QObject, this one is only intercepting signal for dynamic property changed (see constructor). More...
 
QMenu * getActionAndPopupMenu ()
 Get a QMenu that contains all the action that can be applied to this component + the popup menu (if exists). More...
 
InterfaceProperty

All the implemented InterfaceProperty methods

QStringList getHierarchy ()
 
bool isInstanceOf (QString className)
 Assert that a Component instance really inherits from a given className. More...
 
virtual unsigned int getNumberOfPropertyWidget ()
 get the number of alternative property widgets More...
 
virtual QWidget * getPropertyWidgetAt (unsigned int i, QWidget *parent=0)
 Get the ith alternative property widget. More...
 
virtual QObject * getPropertyObject ()
 Get the property object that could be understood by PropertyEditor. More...
 
void updateProperty (QString name, QVariant value)
 update property: if you override 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...
 
virtual Q_INVOKABLE PropertygetProperty (QString name)
 Get a Property given its name. More...
 
virtual bool addProperty (Property *)
 Add a new CamiTK property to the component. More...
 
InterfaceNode

All the implemented InterfaceNode methods

virtual void addChild (InterfaceNode *)
 add a child Component (sub item in the hierarchy), and modify the child's parent to be equal to this instance More...
 
virtual void attachChild (InterfaceNode *)
 add a child Component (but leave its parent unchanged) More...
 
virtual void removeChild (InterfaceNode *)
 remove from the the sub item vector. More...
 
virtual void setParent (InterfaceNode *)
 set the parent Component. This method automatically remove this Component from its previous (if already had one parent Component) More...
 
virtual void deleteChildren ()
 delete all sub Component, but do not delete the pointer (only the top-level component has the right to do that) More...
 
virtual QString getName () const
 get the name to be displayed More...
 
virtual void setName (const QString &)
 set the name to be displayed More...
 
virtual const ComponentListgetChildren ()
 get the list of the InterfaceNode children (sub items in the hierarchy) More...
 
virtual bool doubleClicked ()
 this method is called each time the InterfaceNode is double clicked by the user. More...
 
virtual InterfaceNodegetParent ()
 get the parent Component More...
 
virtual QPixmap getIcon ()
 Get the pixmap that will be displayed for this node. More...
 
virtual bool inItalic () const
 A component name is not displayed in italic by default. More...
 
virtual QMenu * getPopupMenu (QWidget *parent=0)
 get the popup menu to display (always return NULL, overwrite this method if you want to give here you own popup) More...
 
- Public Member Functions inherited from camitk::InterfaceProperty
virtual ~InterfaceProperty ()
 empty virtual destructor, to avoid memory leak More...
 
- Public Member Functions inherited from camitk::InterfaceNode
virtual ~InterfaceNode ()
 empty virtual destructor, to avoid memory leak More...
 
- Public Member Functions inherited from camitk::InterfaceGeometry
virtual ~InterfaceGeometry ()
 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 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. More...
 
virtual vtkSmartPointer
< vtkImageActor > 
get3DImageActor () const =0
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D. More...
 
virtual vtkSmartPointer
< vtkImageData > 
getImageData () const =0
 Return the displayed images as a vtkImageData. More...
 
virtual int getNumberOfColors () const =0
 Return the number of colors in the images. 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
 This method is called when the associated plane has been picked in the InteractiveViewer, the given coordinates is position where the plane was picked. 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 setRotationX (double angle)=0
 Set the current angle to the arbitrary slice. More...
 
virtual void setRotationY (double angle)=0
 
virtual void setRotationZ (double angle)=0
 
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 world coordinates. More...
 
virtual void updatePickPlane ()=0
 
virtual ~InterfaceBitMap ()
 virtual destructor More...
 

Protected Attributes

ComponentList childrenComponent
 The explorer sub items. 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...
 
InterfaceGeometrymyGeometry
 myGeometry is the 3d representation of this Component, the Component delegates all InterfaceGeometry activity to myGeometry (delegation pattern) More...
 
InterfaceNodemyParentNode
 who is the boss? The Component! More...
 
InterfaceBitMapmySlice
 mySlice is the slice representation of this data component, the Component delegates all InterfaceBitMap activity to mySlice (delegation pattern) More...
 

Static Private Attributes

Static members

All the static member (manage the application-wide list of Component + the application-wide current selection + viewers)

static QSet< Viewer * > allViewers
 

InterfaceGeometry

All the implemented InterfaceGeometry methods (delegated or not, see also Component.cpp)

 setPointSet
 
vtkSmartPointer< vtkPointSet > getDataPort
 
vtkSmartPointer< vtkPointSet >
vtkSmartPointer
< vtkAlgorithmOutput > 
getActor
 
vtkSmartPointer< vtkPointSet >
vtkSmartPointer
< vtkAlgorithmOutput > 
vtkSmartPointer< vtkActor >
 
 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)
 
const QString getLabel () const
 
void setLabel (QString newName)
 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
virtual RenderingModes
vtkSmartPointer< vtkProp > 
getProp (const QString &param)
 Return the vtkProp (actors, volumes and annotations) corresponding to the given name. More...
 
virtual unsigned int getNumberOfProp () const
 return the number of additional prop More...
 
virtual vtkSmartPointer< vtkProp > getProp (unsigned int index)
 return an additional prop by its index More...
 
virtual bool addProp (const QString &name, vtkSmartPointer< vtkProp > prop)
 insert an additional prop, defining it by its name (default visibility = false) More...
 
virtual bool removeProp (const QString &name)
 remove a given additional prop. More...
 
virtual void pointPicked (vtkIdType, bool)
 an inherited class can redefine this method something specific. More...
 
virtual void cellPicked (vtkIdType, bool)
 an inherited class can redefine this method something specific. More...
 
virtual void getBounds (double *bounds)
 compute the object's bounding box [xmin,xmax, ymin,ymax, zmin,zmax], see Component.cpp More...
 
virtual double getBoundingRadius ()
 compute the object's bounding sphere radius, More...
 
 delegate4 (myGeometry, setPointPosition, const unsigned int, const double, const double, const double)
 
 delegateAndInvokeChildren1 (myGeometry, setRenderingModes, const RenderingModes)
 
virtual const
InterfaceGeometry::RenderingModes 
getRenderingModes () const
 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 virtual
double void 
getActorColor (const RenderingModes, double[4])
 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 >) virtual void setGlyphType(const GlyphTypes type
 
 delegate1 (myGeometry, setLinesAsTubes, bool)
 

InterfaceBitMap

All the implemented InterfaceBitMap methods

 setOriginalVolume
 
vtkSmartPointer< vtkImageData > get3DImageActor
 
vtkSmartPointer< vtkImageData >
vtkSmartPointer
< vtkImageActor > 
getPixelActor
 
 setRotationY
 
double getNumberOfColors
 
 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, setSlice, double, double, double)
 
 delegate1 (mySlice, setRotationX, double) delegate1(mySlice
 
double delegate1 (mySlice, setRotationZ, double) delegateConstGet0(mySlice
 
double int delegate3 (mySlice, setPixelRealPosition, double, double, double)
 
virtual double getRotationX () const
 see Component.cpp More...
 
virtual double getRotationY () const
 see Component.cpp More...
 
virtual double getRotationZ () const
 see Component.cpp More...
 
virtual int getNumberOfSlices () const
 see Component.cpp More...
 
virtual int getSlice () const
 see Component.cpp More...
 

Instance members

Representation myService
 the service implemented to be represented in the InteractiveViewer More...
 
QString myName
 my name More...
 
QMap< Viewer *, bool > myViewers
 Where is this Component currently viewed. More...
 
QMenu * actionsMenu
 the action menu for this component More...
 
QMap< QString, Property * > propertyMap
 list of CamiTK property decorating the dynamic properties More...
 
void init ()
 method called in constructors for general initialization More...
 
virtual void initRepresentation ()=0
 Instanciate the concrete representation (either InterfaceGeometry or InterfaceBitMap) if needed. More...
 

Additional Inherited Members

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

Detailed Description

A Component represents something that could be included in the explorer view, the interactive 3D viewer, and that could have or not a contextual popup menu (open by a right click in the explorer), a property dialog (to change some properties) Thus, a Component inherits from many abstract classes.

A Component can only have one implemented representation.

For CAMITK core developers: This class uses the Object Adapter Design Pattern (aka delegate pattern) to delegates all InterfaceGeometry and InterfaceBitMap to respectively myGeometry:Geometry and mySlice:InterfaceBitMap It handles the InterfaceNode without delegation. Considering this Design Pattern, Component is the Adaptor and Geometry and InterfaceBitMap are the Adaptee classes.

This class has some static member to manage all the currently instanciated Components as well as the currently selected Components.

Actions generally use setPointSet() (for InterfaceGeometry) and setOriginalVolume (for InterfaceBitMap) to do some data processing and directly modify the low-level Vtk data. It is thus very important to rewrite these methods in your Component subclass to takes the actions' modification into account in your low-level data.

Dynamic properties: if your Component defines some dynamic property, you might want to override updateProperty() in order to update the internal state of your object when a dynamic property has been changed.

See also
ObjComponent for a good example

It is extensively using Qt Meta-Object system (concepts and implementation). see http://doc.qt.nokia.com/latest/metaobjects.html

Constructor & Destructor Documentation

camitk::Component::Component ( const QString &  file,
const QString &  name,
Representation  rep = NO_REPRESENTATION 
)

Component constructor for top-level component (please use the other constructor for sub-level components).

parentComponent is set to NULL (=> isTopLevel() will return true).

Parameters
filethe file to get the data from
namethe Component name
repthe representation concretely implemented by this Component (default=NO_REPRESENTATION)
camitk::Component::Component ( Component parentComponent,
const QString &  name,
Representation  rep = NO_REPRESENTATION 
)
throw (AbortException
)

Component constructor for a Component that is a child of another Component You should not use this constructor for a top-level component.

Parameters
parentComponentthe parent Component
namethe Component name
repthe representation implemented by this Component (default=NO_REPRESENTATION)
Exceptions
AbortExceptionif parentComponent is NULL.
virtual camitk::Component::~Component ( )
virtual

default destructor

Member Function Documentation

virtual void camitk::Component::addChild ( InterfaceNode )
virtual

add a child Component (sub item in the hierarchy), and modify the child's parent to be equal to this instance

This is to be used with care. The preferred method to add a child component is to use the Component's constructor with the parent parameter: Component(Component *, const QString &, Representation rep) .

Note
If the use of this method does not update the new child in the Explorer, then you may need to force the rebuild of the explorer nodes by calling Component::refreshInterfaceNode() as follows:
this->addChild(otherComponent);
this->refreshInterfaceNode(); // check first without this, it should work in most of the cases.

see attachChild() Component::refreshInterfaceNode()

Implements camitk::InterfaceNode.

virtual bool camitk::Component::addProp ( const QString &  ,
vtkSmartPointer< vtkProp >   
)
inlinevirtual

insert an additional prop, defining it by its name (default visibility = false)

Returns
true if the additional prop was added (i.e. another additional prop of the same name does not exist)

Implements camitk::InterfaceBitMap.

virtual bool camitk::Component::addProperty ( Property )
virtual

Add a new CamiTK property to the component.

If the property already exist, it will just change its value.

Note
The component takes ownership of the Property instance.
Returns
false if the Qt Meta Object property was added by this method (otherwise the property was already defined and true is returned if it was successfully updated)

Implements camitk::InterfaceProperty.

virtual void camitk::Component::attachChild ( InterfaceNode )
virtual

add a child Component (but leave its parent unchanged)

There can be some refresh problem, see the note in addChild()

Implements camitk::InterfaceNode.

virtual void camitk::Component::cellPicked ( vtkIdType  ,
bool   
)
inlinevirtual

an inherited class can redefine this method something specific.

Default behaviour: do nothing.

Implements camitk::InterfaceGeometry.

Reimplemented in StructuralComponentDC, camitk::MeshComponent, and VtkMeshComponent.

vtkSmartPointer<vtkPointSet> camitk::Component::delegate1 ( myGeometry  ,
setPointData  ,
vtkSmartPointer< vtkDataArray >   
)
vtkSmartPointer<vtkPointSet> vtkSmartPointer<vtkAlgorithmOutput> camitk::Component::delegate1 ( myGeometry  ,
setDataConnection  ,
vtkSmartPointer< vtkAlgorithmOutput >   
)
const const const const double const RenderingModes double camitk::Component::delegate1 ( myGeometry  ,
setTexture  ,
vtkSmartPointer< vtkTexture >   
) const
camitk::Component::delegate1 ( myGeometry  ,
setLinesAsTubes  ,
bool   
)
vtkSmartPointer<vtkImageData> vtkSmartPointer<vtkImageActor> vtkSmartPointer<vtkActor> updatePickPlane camitk::Component::delegate1 ( mySlice  ,
setSlice  ,
int   
)
camitk::Component::delegate1 ( mySlice  ,
setRotationX  ,
double   
)
double camitk::Component::delegate1 ( mySlice  ,
setRotationZ  ,
double   
)
vtkSmartPointer<vtkImageData> vtkSmartPointer<vtkImageActor> vtkSmartPointer<vtkActor> camitk::Component::delegate3 ( mySlice  ,
pixelPicked  ,
double  ,
double  ,
double   
)
camitk::Component::delegate3 ( mySlice  ,
setSlice  ,
double  ,
double  ,
double   
)
double int camitk::Component::delegate3 ( mySlice  ,
setPixelRealPosition  ,
double  ,
double  ,
double   
)
camitk::Component::delegate4 ( myGeometry  ,
setPointPosition  ,
const unsigned  int,
const double  ,
const double  ,
const double   
)
camitk::Component::delegateAndInvokeChildren1 ( myGeometry  ,
setRenderingModes  ,
const RenderingModes   
)
camitk::Component::delegateAndInvokeChildren1 ( myGeometry  ,
setEnhancedModes  ,
const EnhancedModes   
)
const const const const double const RenderingModes camitk::Component::delegateAndInvokeChildren1 ( myGeometry  ,
setOpacity  ,
const double   
)
const EnhancedModes camitk::Component::delegateAndInvokeChildren1Array ( myGeometry  ,
setActorColor  ,
const RenderingModes  ,
double  ,
 
)
const const const const double camitk::Component::delegateAndInvokeChildren2 ( myGeometry  ,
setActorOpacity  ,
const RenderingModes  ,
const double   
)
camitk::Component::delegateAndInvokeChildren3 ( myGeometry  ,
setColor  ,
const double  ,
const double  ,
const double   
)
camitk::Component::delegateConstGet0 ( mySlice  ,
getImageData  ,
vtkSmartPointer< vtkImageData >   
)
vtkSmartPointer<vtkImageData> camitk::Component::delegateConstGet0 ( mySlice  ,
get2DImageActor  ,
vtkSmartPointer< vtkImageActor >   
)
vtkSmartPointer<vtkImageData> vtkSmartPointer<vtkImageActor> camitk::Component::delegateConstGet0 ( mySlice  ,
getPickPlaneActor  ,
vtkSmartPointer< vtkActor >   
)
camitk::Component::delegateGet0 ( myGeometry  ,
getPointSet  ,
vtkSmartPointer< vtkPointSet >   
)
virtual void camitk::Component::deleteChildren ( )
virtual

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

Implements camitk::InterfaceNode.

Reimplemented in ComponentDC.

bool Component::doubleClicked ( )
inlinevirtual

this method is called each time the InterfaceNode is double clicked by the user.

Returns
a boolean telling if there was modification made in the Component due to this double click

Implements camitk::InterfaceNode.

Reimplemented in AtomDC.

bool camitk::Component::event ( QEvent *  e)

Overriden from QObject, this one is only intercepting signal for dynamic property changed (see constructor).

QMenu* camitk::Component::getActionAndPopupMenu ( )

Get a QMenu that contains all the action that can be applied to this component + the popup menu (if exists).

This method will be soon deprecated and be replaced by getPopupMenu, which will not be maintain in its current version). You are encourage to build Action not getPopupMenu() anymore.

const EnhancedModes const const const const virtual double void camitk::Component::getActorColor ( const RenderingModes  ,
double  [4] 
)
virtual

see Component.cpp

virtual double camitk::Component::getBoundingRadius ( )
virtual

compute the object's bounding sphere radius,

See also
Component.cpp
Returns
the bounding radius of the Geometry or -1 if there is no Geometry

Implements camitk::InterfaceGeometry.

Reimplemented in PMManagerDC.

virtual void camitk::Component::getBounds ( double bounds)
virtual

compute the object's bounding box [xmin,xmax, ymin,ymax, zmin,zmax], see Component.cpp

Implements camitk::InterfaceGeometry.

const ComponentList & Component::getChildren ( )
inlinevirtual

get the list of the InterfaceNode children (sub items in the hierarchy)

Implements camitk::InterfaceNode.

const QString camitk::Component::getFileName ( ) const

get the file name where the data have to be stored/were stored

QStringList camitk::Component::getHierarchy ( )
virtual

Get the inheritance hierachy of this Component instance as a list of QString

Implements camitk::InterfaceProperty.

QPixmap Component::getIcon ( )
inlinevirtual

Get the pixmap that will be displayed for this node.

If you want your component to have a nice pixmap displayed in the explorer, for example, you just need to

  1. declare a new static member and redefines the getIcon() method (in MyComponent.h):
    public:
    virtual QPixmap getIcon();
    private:
    static QPixmap * myPixmap; // declare a ptr here (it is static for optimization)
  2. add these lines in your code (in MyComponent.cpp):
// use this two lines or better use a Qt resource bundle (recommanded!)
#include "myComponent_pixmap.xpm" // include the pixmap resource file or use a Qt resource bundle
QPixmap * MyComponent::myPixmap = NULL; // static initialization
QPixmap MyComponent::getIcon() {
// check if the class instance was already used somewhere
if (!myPixmap) {
// create the pixmap from the data like this (or using the Qt resource bundle, see Qt documentation)
myPixmap = new QPixmap(myComponent_pixmap); // myComponent_pixmap is the name of the char[] found in the .xpm file
}
// return the object (not the pointer
return (*myPixmap);
}

And that all folks! A nice icon will be now used to display your component!

Note
Recommanded pixmap size is 20x20 (not nice, but efficient)...

Implements camitk::InterfaceNode.

Reimplemented in PMManagerDC, StructuralComponentDC, AtomDC, MultiComponentDC, VtkMeshComponent, and CellDC.

const QString Component::getLabel ( ) const
inlinevirtual

get the string used to display the label, do the same as getName

Implements camitk::InterfaceGeometry.

bool Component::getModified ( ) const
inlinevirtual

set the modified flag

Reimplemented in PMManagerDC, and MMLComponent.

QString Component::getName ( ) const
inlinevirtual

get the name to be displayed

Implements camitk::InterfaceNode.

virtual unsigned int camitk::Component::getNumberOfProp ( ) const
inlinevirtual

return the number of additional prop

Implements camitk::InterfaceBitMap.

virtual unsigned int camitk::Component::getNumberOfPropertyWidget ( )
inlinevirtual

get the number of alternative property widgets

See also
PropertyExplorer

Implements camitk::InterfaceProperty.

virtual int camitk::Component::getNumberOfSlices ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceBitMap.

Reimplemented in camitk::ImageComponent.

InterfaceNode * Component::getParent ( )
inlinevirtual

get the parent Component

Implements camitk::InterfaceNode.

virtual Component* camitk::Component::getParentComponent ( )
virtual

get the parent component

virtual QMenu* camitk::Component::getPopupMenu ( QWidget *  parent = 0)
inlinevirtual

get the popup menu to display (always return NULL, overwrite this method if you want to give here you own popup)

Implements camitk::InterfaceNode.

Reimplemented in StructuralComponentDC, PMManagerDC, AtomDC, MMLComponent, VtkMeshComponent, and MultiComponentDC.

vtkSmartPointer<vtkPointSet> vtkSmartPointer<vtkAlgorithmOutput> const virtual RenderingModes vtkSmartPointer<vtkProp> camitk::Component::getProp ( const QString &  )
inlinevirtual

Return the vtkProp (actors, volumes and annotations) corresponding to the given name.

Implements camitk::InterfaceBitMap.

virtual vtkSmartPointer<vtkProp> camitk::Component::getProp ( unsigned int  int)
inlinevirtual

return an additional prop by its index

Implements camitk::InterfaceBitMap.

virtual Q_INVOKABLE Property* camitk::Component::getProperty ( QString  name)
virtual

Get a Property given its name.

Parameters
namethe property name
Returns
NULL if the name does not match any property name
See also
Property

Implements camitk::InterfaceProperty.

virtual QObject* camitk::Component::getPropertyObject ( )
inlinevirtual

Get the property object that could be understood by PropertyEditor.

Returns this as any Component instance can manage its list of dynamic properties (and Component inherits from InterfaceProperty ). You can also have a separate class to manage your Component properties. In this case, just overide this method and return the corresponding instance.

See also
PropertyExplorer
ObjectController

Implements camitk::InterfaceProperty.

Reimplemented in StructuralComponentDC, AtomDC, ComponentDC, and CellDC.

virtual QWidget* camitk::Component::getPropertyWidgetAt ( unsigned int  i,
QWidget *  parent = 0 
)
inlinevirtual

Get the ith alternative property widget.

See also
PropertyExplorer

Implements camitk::InterfaceProperty.

virtual const InterfaceGeometry::RenderingModes camitk::Component::getRenderingModes ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceGeometry.

Reimplemented in ComponentDC.

Representation camitk::Component::getRepresentation ( ) const

return the type of representation concretely implemented by this Component in the InteractiveViewer.

Note
if a Component does not have any representation, then getRepresentation() returns NO_REPRESENTATION (default).
virtual double camitk::Component::getRotationX ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceBitMap.

virtual double camitk::Component::getRotationY ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceBitMap.

virtual double camitk::Component::getRotationZ ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceBitMap.

virtual int camitk::Component::getSlice ( ) const
virtual

see Component.cpp

Implements camitk::InterfaceBitMap.

virtual Component* camitk::Component::getTopLevelComponent ( )
virtual

get the top-level component

virtual bool camitk::Component::getVisibility ( Viewer ) const
virtual

get the visibility of a viewer

void camitk::Component::init ( )
private

method called in constructors for general initialization

bool Component::inItalic ( ) const
inlinevirtual

A component name is not displayed in italic by default.

You must redefine this method in you inherited Component to change this behaviour.

Implements camitk::InterfaceNode.

virtual void camitk::Component::initRepresentation ( )
privatepure virtual

Instanciate the concrete representation (either InterfaceGeometry or InterfaceBitMap) if needed.

This method have to instanciate Slice (mySlice) or Geometry (myGeometry) that does all the work for this Component, i.e. the adaptee handler. Generally this method should be called in the Component constructor.

Implemented in camitk::ImageComponent, PMManagerDC, StructuralComponentDC, AtomDC, camitk::MeshComponent, camitk::SingleImageComponent, CellDC, MultiComponentDC, MMLComponent, and VRMLComponent.

bool camitk::Component::isInstanceOf ( QString  className)
virtual

Assert that a Component instance really inherits from a given className.

Implements camitk::InterfaceProperty.

bool Component::isSelected ( ) const
inlinevirtual

Check if this data component is selected.

bool camitk::Component::isTopLevel ( ) const

return true if this component is a top-level component

virtual void camitk::Component::pointPicked ( vtkIdType  ,
bool   
)
inlinevirtual

an inherited class can redefine this method something specific.

Default behaviour: do nothing.

Implements camitk::InterfaceGeometry.

Reimplemented in StructuralComponentDC, AtomDC, camitk::MeshComponent, and VtkMeshComponent.

virtual void camitk::Component::refresh ( ) const
virtual

refresh all the viewer that are currently displaying this Component

Reimplemented in camitk::ImageComponent.

virtual void camitk::Component::refreshInterfaceNode ( )
virtual

Asks all viewers that are currently displaying this Component to rebuild the representation of the InterfaceNode for this Component.

It calls the method update(Component *) of the class Viewer. This method does nothing except for the Explorer where it does not only refresh, but remove this and re-load the Component.

virtual void camitk::Component::removeChild ( InterfaceNode )
virtual

remove from the the sub item vector.

This method automatically update the parentComponent of (set to NULL).

Implements camitk::InterfaceNode.

virtual bool camitk::Component::removeProp ( const QString &  )
inlinevirtual

remove a given additional prop.

Returns
true if effictively done

Implements camitk::InterfaceBitMap.

void camitk::Component::setFileName ( const QString &  )

set the file name where the data have to be stored

void Component::setLabel ( QString  newName)
inlinevirtual

set the string used to display the label, do the same as setName

Implements camitk::InterfaceGeometry.

void Component::setModified ( bool  modified = true)
inlinevirtual

set the modified flag

void Component::setName ( const QString &  )
inlinevirtual

set the name to be displayed

Implements camitk::InterfaceNode.

Reimplemented in PMManagerDC, AtomDC, CellDC, and ComponentDC.

Referenced by ComponentDC::setName().

virtual void camitk::Component::setParent ( InterfaceNode )
virtual

set the parent Component. This method automatically remove this Component from its previous (if already had one parent Component)

Implements camitk::InterfaceNode.

virtual void camitk::Component::setSelected ( const bool  b,
const bool  recursive = true 
)
virtual

Update the selection flag.

Parameters
bthe value of the flag (true means "is selected")
recursiveif true (default), also updates the children Component selection flags.

Reimplemented in camitk::ImageComponent, StructuralComponentDC, AtomDC, camitk::SingleImageComponent, and CellDC.

virtual void camitk::Component::setVisibility ( Viewer ,
bool   
)
virtual

set the visibility for a viewer

void camitk::Component::updateProperty ( QString  name,
QVariant  value 
)
virtual

update property: if you override 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.

This method is called when a dynamic property has to be udpated

Parameters
namethe name of the dynamic property
valuethe new value to take into account

Implements camitk::InterfaceProperty.

Reimplemented in camitk::MeshComponent, ComponentDC, and VtkMeshComponent.

Member Data Documentation

QMenu* camitk::Component::actionsMenu
private

the action menu for this component

QSet<Viewer*> camitk::Component::allViewers
staticprivate

set of used viewers

ComponentList camitk::Component::childrenComponent
protected

The explorer sub items.

const EnhancedModes const const const camitk::Component::double
const EnhancedModes const const camitk::Component::double
const camitk::Component::double
const const camitk::Component::double
const const const camitk::Component::double
const const const const double camitk::Component::double
const const const const double const RenderingModes camitk::Component::double
vtkSmartPointer<vtkImageData> camitk::Component::get3DImageActor
vtkSmartPointer<vtkPointSet> vtkSmartPointer<vtkAlgorithmOutput> camitk::Component::getActor
const const const const double camitk::Component::getActorOpacity
vtkSmartPointer<vtkPointSet> camitk::Component::getDataPort
camitk::Component::getEnhancedModes
double camitk::Component::getNumberOfColors
vtkSmartPointer<vtkImageData> vtkSmartPointer<vtkImageActor> camitk::Component::getPixelActor
bool camitk::Component::isSelectedFlag
protected

tells if this particular Component is selected or not

bool camitk::Component::modifiedFlag
protected

the modificatio flag (could be extended to manage a undo/redo list)

QString camitk::Component::myFileName
protected

the file name from which the Component is loaded

InterfaceGeometry* camitk::Component::myGeometry
protected

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

QString camitk::Component::myName
private

my name

InterfaceNode* camitk::Component::myParentNode
protected

who is the boss? The Component!

Referenced by camitk::SingleImageComponent::getMyParentComponent().

Representation camitk::Component::myService
private

the service implemented to be represented in the InteractiveViewer

InterfaceBitMap* camitk::Component::mySlice
protected

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

QMap<Viewer *, bool> camitk::Component::myViewers
private

Where is this Component currently viewed.

QMap<QString, Property*> camitk::Component::propertyMap
private

list of CamiTK property decorating the dynamic properties

const EnhancedModes const camitk::Component::RenderingModes
const EnhancedModes camitk::Component::setActorColor
camitk::Component::setColor
const const const const double const RenderingModes camitk::Component::setMapperScalarRange
camitk::Component::setOriginalVolume
camitk::Component::setPointSet
camitk::Component::setRotationY
const const const const double const RenderingModes double const double camitk::Component::size = 0.0)
vtkSmartPointer<vtkPointSet> vtkSmartPointer<vtkAlgorithmOutput> camitk::Component::vtkSmartPointer< vtkActor >

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