Computer Assited Medical Intervention Tool Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
CellDC Class Reference

The manager of the Cell data. More...

#include <CellDC.h>

+ Inheritance diagram for CellDC:

Public Member Functions

 CellDC (camitk::Component *, PMManagerDC *pmManagerDC, Cell *)
 Default constructor.
virtual void createPointData ()
 create all the point data to display specific information (only works for SCs that have a surface representation).
virtual void destroyPointData ()
 destroy all the point data
virtual Cell * getCell ()
 get the atom this dc is representing
virtual ~CellDC ()
 destructor
camitk::Component rewritten

This methods are overloaded from camitk::Component to give the CellDC another behaviour

virtual QPixmap getIcon ()
 Get the pixmap that will be displayed for this node.
virtual void setName (const QString &)
 set the name to be displayed
virtual void setSelected (const bool, const bool recursive=false)
 if selected, creates the 3D representation (that was delayed in the constructor). Blocks all recursivity.
virtual QObject * getPropertyObject ()
 reimplement this method to give the property object to the property editor
- Public Member Functions inherited from StructuralComponentDC
GeometrycellsToGeometry ()
 create an Geometry (composed by vtk unstructured grid of n cells) from the managed SC which is a list of cells
StructuralComponent::ComposedBy composedBy ()
 return if the structural component is a list of cells or of atoms
StructuralComponent * getSC ()
 convenient methods
 StructuralComponentDC (camitk::Component *parent, PMManagerDC *pmManagerDC, StructuralComponent *sc, bool delayRepresentationInit=false)
 Default constructor, set the 3rd parameter to false to delay the construction of the Geometry (represention of the DC in 3D).
void updateAtoms ()
 the method to update both atomDCs vector and atomVtkPointsIndexMap
void updatePosition (AtomDC *, int atomOrderNr=-1)
 This atom position has been changed, the 3D representation has to be updated.
virtual ~StructuralComponentDC ()
 destructor
virtual void setPointSet (vtkSmartPointer< vtkPointSet >)
 if the vtkPointSet is modified externally (e.g. by an operator), change the PM structure
virtual void cellPicked (vtkIdType, bool)
 select a specific sub DC using the cell id (do nothing if the SC is not composed by cells)
virtual void pointPicked (vtkIdType, bool)
 select a specific sub DC using the point id (do nothing if the SC is not composed by atoms)
virtual void setEnhancedModes (const EnhancedModes)
 do not set enhanced modes if children are atomDC
virtual void setRenderingModes (const RenderingModes)
 set the rendering mode of the StructuralComponent as well as the DC
virtual void setActorColor (const RenderingModes, const double, const double, const double)
 Set the color of given representation modes.
virtual void setActorColor (const RenderingModes, double[4])
 Set the color of given representation modes.
virtual void setColor (const double, const double, const double)
 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)
 Set an (r,g,b,a) color to all representation modes.
virtual void addChild (InterfaceNode *)
 add a sub DC: overloaded method to allow change in the physical model data representation
virtual void removeChild (InterfaceNode *)
 remove a sub DC: overloaded method to allow change in the physical model data representation
virtual QMenu * getPopupMenu (QWidget *parent)
 Overriden method so that we actually can build a popup menu with different actions.
- Public Member Functions inherited from ComponentDC
 ComponentDC (camitk::Component *parent, PMManagerDC *pmManagerDC,::Component *c=NULL)
 constructors
::ComponentgetComponent ()
 return the component that this dc is managing
virtual PMManagerDCgetPMManagerDC ()
 get the PMManagerDC (given during instanciation), allows to get PML/Component maps
virtual void updateProperty (QString name, QVariant value)
 update a specific property
virtual ~ComponentDC ()
virtual void setOpacity (const double)
 

virtual const EnhancedModes getEnhancedModes () const
 get the current enhanced mode
virtual const RenderingModes getRenderingModes () const
 see Component.cpp
virtual void deleteChildren ()
 remove a sub DC: overloaded method to avoir deletion of children that are used in more than one SCDC (that have more than one parent)
- Public Member Functions inherited from camitk::MeshComponent
vtkIdType getPickedCellId ()
 get the last pick point id,
vtkIdType getPickedPointId ()
 get the last pick point id,
 MeshComponent (const QString &file) throw (AbortException)
 Creates a top-level MeshComponent from a file.
 MeshComponent (vtkSmartPointer< vtkPointSet > aPointSet, const QString &name)
 Creates a top-level MeshComponent from a vtkPointSet (and instanciate its 3D representation).
 MeshComponent (Component *parentComponent, vtkSmartPointer< vtkPointSet > aPointSet, const QString &name)
 Creates a MeshComponent as a sub component of another Component using a vtkPointSet (and instanciate its 3D representation).
virtual ~MeshComponent ()
 Destructor.
- Public Member Functions inherited from 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).
 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.
virtual ~Component ()
 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
virtual ComponentgetParentComponent ()
 get the parent component
virtual ComponentgetTopLevelComponent ()
 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 (Viewer *, bool)
 set the visibility for a viewer
virtual bool getVisibility (Viewer *) const
 get the visibility of a viewer
virtual void refresh () const
 refresh all the viewer that are currently displaying this Component
virtual void refreshInterfaceNode ()
 Asks all viewers that are currently displaying this Component to rebuild the representation of the InterfaceNode for this Component.
virtual bool isSelected () const
 Check if this data component is selected.
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)
 Overriden from QObject, this one is only intercepting signal for dynamic property changed (see constructor).
QMenu * getActionAndPopupMenu ()
 Get a QMenu that contains all the action that can be applied to this component + the popup menu (if exists).
QStringList getHierarchy ()
bool isInstanceOf (QString className)
 Assert that a Component instance really inherits from a given className.
virtual QWidget * getPropertyWidget (QWidget *parent=0)
 get the property widget to display.
virtual void attachChild (InterfaceNode *)
 add a child Component (but leave its parent unchanged)
virtual void setParent (InterfaceNode *)
 set the parent Component. This method automatically remove this Component from its previous (if already had one parent Component)
virtual QString getName () const
 get the name to be displayed
virtual const ComponentListgetChildren ()
 get the list of the InterfaceNode children (sub items in the hierarchy)
virtual bool doubleClicked ()
 this method is called each time the InterfaceNode is double clicked by the user.
virtual InterfaceNodegetParent ()
 get the parent Component
virtual bool inItalic () const
 A component name is not displayed in italic by default.
const QString getLabel () const
void setLabel (QString newName)
 set the string used to display the label, do the same as setName
virtual vtkSmartPointer
< vtkPointSet > 
getPointSet ()
virtual void setPointData (vtkSmartPointer< vtkDataArray > param)
 set the point data (may contains a lookup table).
virtual vtkSmartPointer
< vtkAlgorithmOutput > 
getDataPort () const
 get the custom algorithm pipeline input.
virtual void setDataConnection (vtkSmartPointer< vtkAlgorithmOutput > param)
 Set/reset the connection for the InterfaceGeometry internal algorithm.
virtual vtkSmartPointer< vtkActor > getActor (const RenderingModes param)
 Return the actor for the representation mode, NULL if the actor doesn't exist.
virtual vtkSmartPointer< vtkProp > getProp (const QString &param)
 Return the vtkProp (actors, volumes and annotations) corresponding to the given name.
virtual unsigned int getNumberOfProp () const
 return the number of additional prop
virtual vtkSmartPointer< vtkProp > getProp (unsigned int index)
 return an additional prop by its index
virtual bool addProp (const QString &name, vtkSmartPointer< vtkProp > prop)
 insert an additional prop, defining it by its name (default visibility = false)
virtual bool removeProp (const QString &name)
 remove a given additional prop.
virtual void getBounds (double bounds[6])
 compute the object's bounding box [xmin,xmax, ymin,ymax, zmin,zmax], see Component.cpp
virtual double getBoundingRadius ()
 compute the object's bounding sphere radius,
virtual void setPointPosition (const unsigned int param1, const double param2, const double param3, const double param4)
 set a given point position
virtual void getActorColor (const RenderingModes, double[4])
 see Component.cpp
virtual void setActorOpacity (const RenderingModes param1, const double param2)
 Set the opacity of this representation modes. WARNING color field (surfaceColor, ...) are not modified!
virtual double getActorOpacity (const RenderingModes param) const
 Return the opacity of a given renderng mode.
virtual void setTexture (vtkSmartPointer< vtkTexture > param)
 Set a texture to this object.
virtual void setGlyphType (const GlyphTypes type, const double size=0.0)
 Set the glyph type (a glyph is a geometric representation attached to every point in the input dataset).
virtual void setLinesAsTubes (bool param)
 set the lines as tubes (works only for vtkDataSet representation that contains lines)
virtual vtkSmartPointer
< vtkImageData > 
getImageData () const
 Return the displayed images as a vtkImageData.
virtual void setOriginalVolume (vtkSmartPointer< vtkImageData > param)
 set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline
virtual vtkSmartPointer
< vtkImageActor > 
get2DImageActor () const
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D.
virtual vtkSmartPointer
< vtkImageActor > 
get3DImageActor () const
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D.
virtual vtkSmartPointer< vtkActor > getPickPlaneActor () const
 Return the vtkActor used to pick pixels in the slices.
virtual vtkSmartPointer< vtkActor > getPixelActor ()
 Return the vtkActor used to pick pixels in the slices.
virtual void pixelPicked (double param1, double param2, double param3)
 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 updatePickPlane ()
virtual void setSlice (int param)
 Set the current slice index.
virtual void setSlice (double param1, double param2, double param3)
 Set the slice corresponding to the given world coordinates.
virtual void setRotationX (double param)
 Set the current angle to the arbitrary slice.
virtual void setRotationY (double param)
virtual void setRotationZ (double param)
virtual int getNumberOfColors () const
 Return the number of colors in the images.
virtual void setPixelRealPosition (double param1, double param2, double param3)
 move the pixel selection green indicator (pixelActor) to the given real position
virtual double getRotationX () const
 see Component.cpp
virtual double getRotationY () const
 see Component.cpp
virtual double getRotationZ () const
 see Component.cpp
virtual int getNumberOfSlices () const
 see Component.cpp
virtual int getSlice () const
 see Component.cpp
- Public Member Functions inherited from camitk::InterfaceProperty
virtual ~InterfaceProperty ()
 empty virtual destructor, to avoid memory leak
- Public Member Functions inherited from camitk::InterfaceNode
virtual ~InterfaceNode ()
 empty virtual destructor, to avoid memory leak
- Public Member Functions inherited from camitk::InterfaceGeometry
virtual ~InterfaceGeometry ()
 empty virtual destructor, to avoid memory leak
- Public Member Functions inherited from camitk::InterfaceBitMap
virtual ~InterfaceBitMap ()
 virtual destructor

Private Member Functions

virtual void initRepresentation ()
 the concrete building of the 3D object

Private Attributes

Cell * myCell
 store the cell here, as well as in the SCDC, because otherwise the down cast lose the specific Structure properties
CellDCPropertiesmyProp
 the atom'properties

Static Private Attributes

static QPixmap * myPixmap = NULL
 the CellDC pixmap

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...
- Static Public Member Functions inherited from StructuralComponentDC
static vtkSmartPointer
< vtkUnstructuredGrid > 
structuralComponentToVtk (StructuralComponent *, std::AtomVtkPointsIndexMap *)
 Build an unstructured grid from a Structural Component, and build the correct AtomVtkPointsIndexMap.
static vtkSmartPointer
< vtkUnstructuredGrid > 
structuralComponentToVtk (StructuralComponent *)
 Build an unstructured grid from a Structural Component.
- Public Attributes inherited from camitk::InterfaceBitMap
QMap< QString, vtkSmartPointer
< vtkProp > > 
extraProp
 The additional map for prop (include at least "label" and "glyph".
- Protected Member Functions inherited from camitk::MeshComponent
virtual void initRepresentation (vtkSmartPointer< vtkPointSet >)
 build the instance of Geometry from the given vtkPointSet
- Protected Attributes inherited from StructuralComponentDC
unsigned int nrOfAtoms
 nr of atoms
vtkSmartPointer< vtkDoubleArray > pointData
 the point data array

Detailed Description

The manager of the Cell data.

CellDC are only created in the StructuralComponentDC constructor, which garanties that each cell has ONE AND ONLY ONE DC.

Constructor & Destructor Documentation

CellDC::CellDC ( camitk::Component parent,
PMManagerDC pmManagerDC,
Cell *  theCell 
)
CellDC::~CellDC ( )
virtual

destructor

References myProp.

Member Function Documentation

void CellDC::createPointData ( )
virtual

create all the point data to display specific information (only works for SCs that have a surface representation).

This will automatically fills up the AtomDC point data pointers.

Reimplemented from StructuralComponentDC.

References camitk::Component::childrenComponent, StructuralComponentDC::pointData, and camitk::Component::setPointData().

void CellDC::destroyPointData ( )
virtual
Cell * CellDC::getCell ( )
inlinevirtual
QPixmap CellDC::getIcon ( )
virtual

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):
@code 

public: virtual QPixmap getIcon(); private: static QPixmap * myPixmap; // declare a ptr here (it is static for optimization)

  1. 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
    // 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)...

Reimplemented from StructuralComponentDC.

References myPixmap.

QObject * CellDC::getPropertyObject ( )
virtual

reimplement this method to give the property object to the property editor

Reimplemented from StructuralComponentDC.

References myProp.

void CellDC::initRepresentation ( )
privatevirtual
void CellDC::setName ( const QString &  )
virtual

set the name to be displayed

Reimplemented from ComponentDC.

References myCell, and ComponentDC::myComponent.

Referenced by CellDC(), and CellDCProperties::setName().

void CellDC::setSelected ( const bool  selected,
const bool  recursive = false 
)
virtual

if selected, creates the 3D representation (that was delayed in the constructor). Blocks all recursivity.

Reimplemented from StructuralComponentDC.

References ComponentDC::getRenderingModes(), initRepresentation(), camitk::Component::myGeometry, StructuralComponentDC::setRenderingModes(), and camitk::Component::setVisibility().

Member Data Documentation

Cell* CellDC::myCell
private

store the cell here, as well as in the SCDC, because otherwise the down cast lose the specific Structure properties

Referenced by getCell(), initRepresentation(), and setName().

QPixmap * CellDC::myPixmap = NULL
staticprivate

the CellDC pixmap

Referenced by getIcon().

CellDCProperties* CellDC::myProp
private

the atom'properties

Referenced by CellDC(), getPropertyObject(), and ~CellDC().


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