Commit 2450ee1a authored by Emmanuel Promayon's avatar Emmanuel Promayon
Browse files

Update docs/Getting Started/Examples and Tutorials/

parent a0769ea6
Pipeline #27539 passed with stages
in 31 seconds
......@@ -19,57 +19,20 @@ The tutorial CEP is provided with the CamiTK Community Edition. It contains some
| Action | averagevoxelvalues | (image) Compute the average voxels value in the neiborhoods of the currently selected voxel | `tutorials/actions/averagevoxelvalues` |
| Action | basicpicking | (image and mesh) A basic picking demo extension. It contains two actions demonstrating one way to get information on mesh or images using picking (i.e., clicking on the object in the 2D/3D interactive viewer) | `tutorials/actions/basicpicking` |
| Action | hardcodedpipeline | (misc) Demo how to apply/run two actions from another one using a hard-coded pipelines | `tutorials/actions/hardcodedpipeline` |
| Action | meshanimation | (mesh) Demo how to "animate" a mesh (i.e., dynamically apply displacements to a mesh). Shows three ways of doing this: basic animation, with a timer and using an external library (see the `shakerlib` library) | `tutorials/actions/meshanimation` |
| Action | meshpointdata | (mesh) Demo how to (programmatically) show/hide mesh point data using a color scale | `tutorials/actions/meshpointdata` |
| Action | properties | (misc) Demo how to create various type of action parameters and manipulates component dynamic properties (for instance add some dynamic properties in an action) | `tutorials/actions/properties` |
| Action | selection | (mesh) Demo how to work with the mesh selection | `tutorials/actions/selection` |
| Action | sleepingwhileworking |(viewer and image) Demo how to directly manipulate the viewers to change the camera and selected slice in an 3D image (and pretend you are busily doing it yourself!) | `tutorials/actions/` |
| Action | vtkwidget | Demo how to add a VTK 3D widget in a viewer (a VTK widget is a type of interactor directly available in a 3D VTK renderer window) | `tutorials/actions/vtkwidget` |
<!-- | Action | pythonscripting | | `tutorials/actions/pythonscripting` | -->
| Component | mixed | Demo how to integrate an image (`.mha`) and a mesh (`.vtk`) together in a same top-level component | `tutorials/components/mixed` |
| Component | pickme | (mesh) Demo how to use `pointPicked(..)` and `cellPicked(..)` methods to interact directly with a component | `tutorials/components/pickme` |
| Component | abort | Demo how CamiTK handle `AbortException` in component constructor. | `tutorials/components/abort` |
<!-- TODO : app, and viewer tutorials
meshanimation properties selection vtkwidget
meshpointdata pythonscripting sleepingwhileworking
actions/selection/MeshSelection.h: virtual QString getDescription() {
actions/selection/MeshSelection.h- return "This extension shows how to work with the mesh selection";
actions/meshanimation/shakerextension/ShakerExtension.h: virtual QString getDescription() {
actions/meshanimation/shakerextension/ShakerExtension.h- return "An example of mesh animation. The shaker animation motors. It shakes your mesh in all directions!";
actions/properties/PropAction.cpp: newProp = new Property(propName, propValue, actionParam->getDescription(), "");
actions/properties/PropAction.cpp- }
actions/properties/PropAction.cpp: newProp = new Property(propName, (Enumeration) propValue.toInt(), actionParam->getDescription(), "");
actions/properties/PropAction.cpp- }
actions/properties/PropertiesExtension.h: virtual QString getDescription() {
actions/properties/PropertiesExtension.h- return "Extensions that manipulates component dynamic properties";
actions/sleepingwhileworking/SleepingWhileWorkingExtension.h: virtual QString getDescription() {
actions/sleepingwhileworking/SleepingWhileWorkingExtension.h- return "This extension shows how to directly manipulate the viewers (and pretend you are busily doing it yourself!)";
actions/meshpointdata/MeshPointData.h: virtual QString getDescription() {
actions/meshpointdata/MeshPointData.h- return "This extension shows how to show/hide mesh point data using a color scale";
actions/vtkwidget/VtkWidgetExtension.h: virtual QString getDescription() {
actions/vtkwidget/VtkWidgetExtension.h- return "This is a a simple action extension containing one action to show how to add a vtk 3D widget in a viewer (a VTK Widget is an type of interaction directly available in a VTK renderer window).";
components/abort/AbortExtension.cpp:// --------------- getDescription -------------------
components/abort/AbortExtension.cpp:QString AbortExtension::getDescription() const {
components/abort/AbortExtension.cpp- return "A small extension that can be used for testing how CamiTK handle AbortException in component constructor.";
components/abort/AbortExtension.h: virtual QString getDescription() const;
components/pickme/PickMeComponent.h: virtual QString getDescription() const {
components/pickme/PickMeComponent.h- return "This tutorial show how to the pointPicked(..) and cellPicked(..) method to interact directly with your component";
components/mixed/MixedExtension.h: virtual QString getDescription() const;
components/mixed/MixedExtension.cpp:// --------------- getDescription -------------------
components/mixed/MixedExtension.cpp:QString MixedExtension::getDescription() const {
components/mixed/MixedExtension.cpp- return "A small extension that integrates mha and vtk together, i.e <em>.mixed</em> files in <b>CamiTK</b>.<br/>(very few support!)";
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment