Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Modules | Classes | Enumerations
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 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::InterfaceBitMap
 This class describes what are the methods to implement for a BitMap. 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::InterfaceBitMap::PossibleOrientation { camitk::InterfaceBitMap::AXIAL_ORIENTATION, camitk::InterfaceBitMap::CORONAL_ORIENTATION, camitk::InterfaceBitMap::SAGITTAL_ORIENTATION, camitk::InterfaceBitMap::ARBITRARY_ORIENTATION }
 Common slices orientation: axial, sagittal, coronal or anything else. 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...
 

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.

camitk_service_layer_2.png
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

possible direction of an object

Enumerator

the object in the X direction, size = 0.1

the object in the Y direction, size = 0.1

the object in the Z direction, size = 0.1

USER_DEFINED 

< the object direction is defined by the user

(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

the geometric type

Enumerator
ARROW 

an arrow

SPHERE 

a sphere (this is also the default)

(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

Common slices orientation: axial, sagittal, coronal or anything else.

The slices organisation will depend on how the original volume image has been read (generally: RAI): RAI: Right Anterior Inferior, LAI: Left Anterior Inferior, LAS: Left Anterior Superior, RAS: Right Anterior Superior, LPS: Left Posterior Superior, RPS: Right Posterior Superior, LPI: Left Posterior Inferior, RPI: Right Posterior Inferior

AXIAL_ORIENTATION: from feet to head of the patient in case of RAI, LAI, LPI and RPI from head to feet of the patient in case of LAS, RAS, LPS and RPS

CORONAL_ORIENTATION: from front to back of the patient in case of RAI, LAI, LAS and RAS from back to front of the patient in case of LPI, RPI, LPS and RPS

SAGITTAL_ORIENTATION: from right to left facing the patient in case of RAI, RPI, RAS and RPS from left to right facing the patient in case of LAI, LAS, LPI and LPS

ARBITRARY_ORIENTATION: well give the orientation you want!

Enumerator
AXIAL_ORIENTATION 
CORONAL_ORIENTATION 
SAGITTAL_ORIENTATION 
ARBITRARY_ORIENTATION 

(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

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