Component

The CamiTK Core Component structure. More...

Collaboration diagram for Component:

Modules
	Image
	The CamiTK Core Image Component structure.
	Mesh
	The CamiTK Core Mesh Component structure.

Classes
class	camitk::Component
	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...
class	camitk::ComponentExtension
	This class describes what is a generic Component extension. More...
class	camitk::ComponentPopupMenu
	Generic class for Component popup menu. To create your own Component popup, create a class that inherits from this one. Your class could have as many slot that you want. Create popup menu item and connect your slot using the addAction method. More...
class	camitk::GeometricObject
	A geometric object allows one to create geometric object (sphere, arrow, ...) that can be added directly in the scene using getActor(). More...
class	camitk::Geometry
	A 3D representation of a vtkPointSet to be displayed in a InteractiveViewer, this class implements the InterfaceGeometry. More...
class	camitk::InterfaceFrame
	This class describes what are the methods to implement in order to manage a Component position in space. More...
class	camitk::InterfaceGeometry
	This class describes what are the methods to implement for a Geometry (rendering parameters, input/output, filters, picking parameters...) More...
class	camitk::InterfaceNode
	This class describe what are the methods to implement for a hierarchical tree node. More...
class	camitk::InterfaceProperty
	This class describe what are the methods to implement in order to manage dynamic properties. More...
class	camitk::Slice
	Display a slice (i.e. More...

Enumerations
enum	camitk::GeometricObject::Direction { camitk::GeometricObject::X, camitk::GeometricObject::Y, camitk::GeometricObject::Z, camitk::GeometricObject::USER_DEFINED }
	possible direction of an object More...
enum	camitk::InterfaceGeometry::EnhancedMode { camitk::InterfaceGeometry::Normal = 0x0, camitk::InterfaceGeometry::Hidden = 0x1, camitk::InterfaceGeometry::Shaded = 0x2, camitk::InterfaceGeometry::Highlighted = 0x4 }
	(and QFlags EnhancedModes) handle the way the rendering actors will be enhanced or not (from completely hidden to highlighted) More...
enum	camitk::GeometricObject::Geometry { camitk::GeometricObject::ARROW, camitk::GeometricObject::SPHERE }
	the geometric type More...
enum	camitk::InterfaceGeometry::GlyphType { camitk::InterfaceGeometry::NoGlyph = 0x0, camitk::InterfaceGeometry::Sphere = 0x1 }
	(and QFlags GlyphTypes) is the type of glyph attached to the geometry representation More...
enum	camitk::InterfaceGeometry::RenderingMode { camitk::InterfaceGeometry::None = 0x0, camitk::InterfaceGeometry::Surface = 0x1, camitk::InterfaceGeometry::Wireframe = 0x2, camitk::InterfaceGeometry::Points = 0x4 }
	(and QFlags RenderingModes) handle actor rendering options (render this InterfaceGeometry as a surface, a wireframe and set of points). More...
enum	camitk::Component::Representation { camitk::Component::GEOMETRY, camitk::Component::SLICE, camitk::Component::NO_REPRESENTATION }
	The different representation that can be implemented to represent this Component in the InteractiveViewer. More...

Constructors / Destructors
enum	camitk::Slice::SliceOrientation { camitk::Slice::AXIAL, camitk::Slice::CORONAL, camitk::Slice::SAGITTAL, camitk::Slice::AXIAL_NEURO }
	Common slices orientation: axial, sagittal, coronal axial_neuro. More...
QMap< QString, vtkSmartPointer < vtkProp > >	camitk::Slice::extraProp
	The additional map for prop (include at least "label" and "glyph") More...
virtual vtkSmartPointer< vtkProp >	camitk::Slice::getProp (const QString &)
	Return the vtkProp (actors, volumes and annotations) corresponding to the given name. More...
virtual unsigned int	camitk::Slice::getNumberOfProp () const
	return the number of additional prop More...
virtual vtkSmartPointer< vtkProp >	camitk::Slice::getProp (unsigned int)
	return an additional prop by its index More...
virtual bool	camitk::Slice::addProp (const QString &, vtkSmartPointer< vtkProp >)
	insert an additional prop, defining it by its name (default visibility = false) More...
virtual bool	camitk::Slice::removeProp (const QString &)
	remove a given additional prop. More...

Detailed Description

The CamiTK Core Component structure.

Components are used to handle date whithin CamiTK. They may be use to handle some 2D, 3D images or devices such as robots, kinects ...

Architecture

CamiTK components describe data structure and therefore are used to represent the data logic.

The four interfaces implemented by the Component class

The Component class implements four interfaces, which gather the different possibilities of a component in order to provide the service layer. See the Component class to have more details.

Enumeration Type Documentation

enum camitk::GeometricObject::Direction

possible direction of an object

Enumerator
X	the object in the X direction, size = 0.1
Y	the object in the Y direction, size = 0.1
Z	the object in the Z direction, size = 0.1
USER_DEFINED	< the object direction is defined by the user

enum camitk::InterfaceGeometry::EnhancedMode

(and QFlags EnhancedModes) handle the way the rendering actors will be enhanced or not (from completely hidden to highlighted)

Enumerator
Normal	the object is normally displayed
Hidden	the object is hidden
Shaded	the object is shaded
Highlighted	the object is highlighted

enum camitk::GeometricObject::Geometry

the geometric type

Enumerator
ARROW	an arrow
SPHERE	a sphere (this is also the default)

enum camitk::InterfaceGeometry::GlyphType

(and QFlags GlyphTypes) is the type of glyph attached to the geometry representation

Enumerator
NoGlyph	there are no glyph type attached to the geometry
Sphere	the glyph is a nice sphere

enum camitk::InterfaceGeometry::RenderingMode

(and QFlags RenderingModes) handle actor rendering options (render this InterfaceGeometry as a surface, a wireframe and set of points).

Enumerator
None	no rendering mode, the InterfaceGeometry is not visible
Surface	the surface is visible
Wireframe	the wireframe is visible
Points	the points are visible

enum camitk::Component::Representation

The different representation that can be implemented to represent this Component in the InteractiveViewer.

use getRepresentation() to get the information about a specific Component.

Note

the representation cannot be NULL; if a Component does not have any representation, then getRepresentation() should return NO_REPRESENTATION (default).

Enumerator
GEOMETRY	this Component can be displayed as a GEOMETRY
SLICE	this Component can be displayed as a SLICE
NO_REPRESENTATION	this Component has no representation implemented

enum camitk::Slice::SliceOrientation

Common slices orientation: axial, sagittal, coronal axial_neuro.

Axial, Sagittal and Coronal orientation are given in Radiologist point of view. The neurologist point of view is displayed in axial_neuro.

The ImageComponent is supposed to be given in RAI orientation ! (see Image Reorientation Action Documentation). AXIAL: from feet to head of the patient CORONAL: from the front to back of the patient SAGITTAL: from the right to left of the patient AXIAL_NEURO: from head to feet (other side of AXIAL

Enumerator
AXIAL
CORONAL
SAGITTAL
AXIAL_NEURO

Function Documentation

bool camitk::Slice::addProp ( const QString &  name, vtkSmartPointer< vtkProp >  prop  )

virtual

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)

unsigned int camitk::Slice::getNumberOfProp ( ) const

virtual

return the number of additional prop

vtkSmartPointer< vtkProp > camitk::Slice::getProp ( const QString &  name )

virtual

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

vtkSmartPointer< vtkProp > camitk::Slice::getProp ( unsigned int  index )

virtual

return an additional prop by its index

bool camitk::Slice::removeProp ( const QString &  name )

virtual

remove a given additional prop.

Returns

true if effictively done

Variable Documentation

QMap<QString, vtkSmartPointer<vtkProp> > camitk::Slice::extraProp

The additional map for prop (include at least "label" and "glyph")