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 | List of all members
ObjComponent Class Reference

The manager of the objdata (alias wavefront format). More...

#include <ObjComponent.h>

+ Inheritance diagram for ObjComponent:

Public Member Functions

 ObjComponent (const QString &file) throw (AbortException)
 default constructor More...
 
- Public Member Functions inherited from camitk::MeshComponent
void cellPicked (vtkIdType cellId, bool)
 reimplemented to save the last pick point id More...
 
vtkIdType getPickedCellId ()
 get the last pick point id, More...
 
vtkIdType getPickedPointId ()
 get the last pick point id, More...
 
 MeshComponent (const QString &file) throw (AbortException)
 Creates a top-level MeshComponent from a file. More...
 
 MeshComponent (vtkSmartPointer< vtkPointSet > aPointSet, const QString &name)
 Creates a top-level MeshComponent from a vtkPointSet (and instanciate its 3D representation). More...
 
 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). More...
 
void pointPicked (vtkIdType pointId, bool)
 reimplemented to save the last pick point id More...
 
virtual ~MeshComponent ()
 Destructor. More...
 
- 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). 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, 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...
 
QStringList getHierarchy ()
 
bool isInstanceOf (QString className)
 Assert that a Component instance really inherits from a given className. More...
 
virtual QWidget * getPropertyWidget (QWidget *parent=0)
 get the property widget to display. 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 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...
 
const QString getLabel () const
 
void setLabel (QString newName)
 set the string used to display the label, do the same as setName More...
 
virtual vtkSmartPointer
< vtkPointSet > 
getPointSet ()
 
virtual void setPointSet (vtkSmartPointer< vtkPointSet > param)
 set the low-level data set. More...
 
virtual void setPointData (vtkSmartPointer< vtkDataArray > param)
 set the point data (may contains a lookup table). More...
 
virtual vtkSmartPointer
< vtkAlgorithmOutput > 
getDataPort () const
 get the custom algorithm pipeline input. More...
 
virtual void setDataConnection (vtkSmartPointer< vtkAlgorithmOutput > param)
 Set/reset the connection for the InterfaceGeometry internal algorithm. More...
 
virtual vtkSmartPointer< vtkActor > getActor (const RenderingModes param)
 Return the actor for the representation mode, NULL if the actor doesn't exist. More...
 
virtual 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 getBounds (double bounds[6])
 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...
 
virtual void setPointPosition (const unsigned int param1, const double param2, const double param3, const double param4)
 set a given point position More...
 
virtual void setRenderingModes (const RenderingModes param)
 
virtual const RenderingModes getRenderingModes () const
 see Component.cpp More...
 
virtual void setEnhancedModes (const EnhancedModes param)
 set the enhanced mode More...
 
virtual const EnhancedModes getEnhancedModes () const
 get the current enhanced mode More...
 
virtual void setActorColor (const RenderingModes param1, double param2[4])
 Set the color of given representation modes. More...
 
virtual void setActorColor (const RenderingModes param1, const double param2, const double param3, const double param4)
 Set the color of given representation modes. More...
 
virtual void getActorColor (const RenderingModes, double[4])
 see Component.cpp More...
 
virtual void setColor (const double param1, const double param2, const double param3)
 Set an (r,g,b) color to all representation modes, without changing the opacity. More...
 
virtual void setColor (const double param1, const double param2, const double param3, const double param4)
 Set an (r,g,b,a) color to all representation modes. More...
 
virtual void setActorOpacity (const RenderingModes param1, const double param2)
 Set the opacity of this representation modes. WARNING color field (surfaceColor, ...) are not modified! More...
 
virtual double getActorOpacity (const RenderingModes param) const
 Return the opacity of a given renderng mode. More...
 
virtual void setOpacity (const double param)
 Set the opacity of this object. WARNING color field (surfaceColor, ...) are not modified! More...
 
virtual void setTexture (vtkSmartPointer< vtkTexture > param)
 Set a texture to this object. More...
 
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). More...
 
virtual void setLinesAsTubes (bool param)
 set the lines as tubes (works only for vtkDataSet representation that contains lines) More...
 
virtual vtkSmartPointer
< vtkImageData > 
getImageData () const
 Return the displayed images as a vtkImageData. More...
 
virtual void setOriginalVolume (vtkSmartPointer< vtkImageData > param)
 set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline More...
 
virtual vtkSmartPointer
< vtkImageActor > 
get2DImageActor () const
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D. More...
 
virtual vtkSmartPointer
< vtkImageActor > 
get3DImageActor () const
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D. More...
 
virtual vtkSmartPointer< vtkActor > getPickPlaneActor () const
 Return the vtkActor used to pick pixels in the slices. More...
 
virtual vtkSmartPointer< vtkActor > getPixelActor ()
 Return the vtkActor used to pick pixels in the slices. More...
 
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. More...
 
virtual void updatePickPlane ()
 
virtual void setSlice (int param)
 Set the current slice index. More...
 
virtual void setSlice (double param1, double param2, double param3)
 Set the slice corresponding to the given world coordinates. More...
 
virtual void setRotationX (double param)
 Set the current angle to the arbitrary slice. More...
 
virtual void setRotationY (double param)
 
virtual void setRotationZ (double param)
 
virtual int getNumberOfColors () const
 Return the number of colors in the images. More...
 
virtual void setPixelRealPosition (double param1, double param2, double param3)
 move the pixel selection green indicator (pixelActor) to the given real position More...
 
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...
 
- 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...
 
- Public Member Functions inherited from camitk::InterfaceBitMap
virtual ~InterfaceBitMap ()
 virtual destructor More...
 

Private Member Functions

void initDynamicProperties ()
 create and initialize dynamic properties More...
 

Component Properties

int nbPoints
 These are read-only static properties. More...
 
int nbCells
 
int memoryUsage
 
int getNbPoints ()
 methods needed to manage the read-only static properties More...
 
int getNbCells ()
 
int getMemoryUsage ()
 
void updateProperty (QString name, QVariant value)
 updateProperty is overriden to manage the specific dynamic properties of this component. 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 Attributes inherited from camitk::InterfaceBitMap
QMap< QString, vtkSmartPointer
< vtkProp > > 
extraProp
 The additional map for prop (include at least "label" and "glyph". More...
 
- Protected Member Functions inherited from camitk::MeshComponent
virtual void initRepresentation (vtkSmartPointer< vtkPointSet >)
 build the instance of Geometry from the given vtkPointSet More...
 
- Protected Attributes inherited from camitk::Component
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...
 

Detailed Description

The manager of the objdata (alias wavefront format).

This component is using VtkObjReader to import the file and shows how to add static and dynamic properties to a component.

Author
Emmanuel Promayon

Constructor & Destructor Documentation

ObjComponent::ObjComponent ( const QString &  file) throw (AbortException)

default constructor

Member Function Documentation

int ObjComponent::getMemoryUsage ( )
int ObjComponent::getNbCells ( )
int ObjComponent::getNbPoints ( )

methods needed to manage the read-only static properties

void ObjComponent::initDynamicProperties ( )
private

create and initialize dynamic properties

References CAMITK_INFO.

void ObjComponent::updateProperty ( QString  name,
QVariant  value 
)
virtual

updateProperty is overriden to manage the specific dynamic properties of this component.

Do not forget to call the superclass method to manage inherited (dynamic) properties.

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

Implements camitk::InterfaceProperty.

References camitk::Component::updateProperty().

Property Documentation

int ObjComponent::memoryUsage
read
int ObjComponent::nbCells
read
int ObjComponent::nbPoints
read

These are read-only static properties.

You need to have a Q_OBJECT line at the top of the class for static properties to be correctly handled. This component also has dynamic property,

See Also
initDynamicProperties

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