Computer Assited Medical Intervention Tool Kit  version 4.1
InterfaceGeometry.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef INTERFACEGEOMETRY_H
27 #define INTERFACEGEOMETRY_H
28 
29 // -- vtk stuff
30 #include <vtkType.h>
31 #include <vtkSmartPointer.h>
32 
33 // -- vtk stuff classes
34 class vtkPointSet;
35 class vtkTexture;
36 class vtkActor;
37 class vtkProp;
38 class vtkDataArray;
39 class vtkAlgorithm;
40 class vtkAlgorithmOutput;
41 class vtkTransform;
42 
43 
44 namespace camitk {
62 
63 public:
66  None = 0x0,
67  Surface = 0x1,
68  Wireframe = 0x2,
69  Points = 0x4
70  };
71  Q_DECLARE_FLAGS(RenderingModes, RenderingMode)
72 
73 
74  enum EnhancedMode {
75  Normal = 0x0,
76  Hidden = 0x1,
77  Shaded = 0x2,
78  Highlighted = 0x4
79  };
80  Q_DECLARE_FLAGS(EnhancedModes, EnhancedMode)
81 
82 
83  enum GlyphType {
84  NoGlyph = 0x0,
85  Sphere = 0x1
86  };
87  Q_DECLARE_FLAGS(GlyphTypes, GlyphType)
88 
89 
90  virtual ~InterfaceGeometry() = default;
91 
93  virtual const QString getLabel() const = 0;
94 
96  virtual void setLabel(QString newName) = 0;
97 
101  virtual vtkSmartPointer<vtkPointSet> getPointSet() = 0;
102 
109  virtual void setPointSet(vtkSmartPointer<vtkPointSet>) = 0;
110 
112  virtual void setPointData(vtkSmartPointer<vtkDataArray>) = 0;
113 
115  virtual void setMeshWorldTransform(vtkSmartPointer<vtkTransform>) = 0;
116 
117 
134  virtual vtkSmartPointer<vtkAlgorithmOutput> getDataPort() const = 0;
135 
154  virtual void setDataConnection(vtkSmartPointer<vtkAlgorithmOutput>) = 0;
155 
157  virtual vtkSmartPointer<vtkActor> getActor(const RenderingModes) = 0;
158 
160  virtual vtkSmartPointer<vtkProp> getProp(const QString&) = 0;
161 
163  virtual unsigned int getNumberOfProp() const = 0;
164 
166  virtual vtkSmartPointer<vtkProp> getProp(unsigned int) = 0;
167 
171  virtual bool removeProp(const QString&) = 0;
172 
176  virtual bool addProp(const QString&, vtkSmartPointer<vtkProp>) = 0;
177 
179  virtual void setTexture(vtkSmartPointer<vtkTexture>) = 0;
180 
193  virtual void pointPicked(vtkIdType pointId, bool pickingIsSelecting) = 0;
194 
206  virtual void cellPicked(vtkIdType cellId, bool pickingIsSelecting) = 0;
208 
211 
215  virtual void getBounds(double* bounds) = 0;
216 
218  virtual double getBoundingRadius() = 0;
219 
221  virtual void setPointPosition(const unsigned int orderNumber, const double x, const double y, const double z) = 0;
222 
224 
228  virtual void setRenderingModes(const RenderingModes) = 0;
229 
231  virtual const RenderingModes getRenderingModes() const = 0;
232 
234  virtual void setEnhancedModes(const EnhancedModes) = 0;
235 
237  virtual const EnhancedModes getEnhancedModes() const = 0;
238 
242  virtual void setActorColor(const RenderingModes, double* color) = 0;
243 
245  virtual void setActorColor(const RenderingModes, const double, const double, const double) = 0;
246 
250  virtual void getActorColor(const RenderingModes, double* color) = 0;
251 
253  virtual void setColor(const double, const double, const double) = 0;
254 
256  virtual void setColor(const double, const double, const double, const double) = 0;
257 
259  virtual void setActorOpacity(const RenderingModes, const double) = 0;
260 
262  virtual double getActorOpacity(const RenderingModes) const = 0;
263 
265  virtual void setOpacity(const double) = 0;
266 
268  virtual void setMapperScalarRange(double min, double max) = 0;
269 
280  virtual void setGlyphType(const GlyphTypes type, const double size = 0.0) = 0;
281 
283  virtual void setLinesAsTubes(bool) = 0;
284 
286 };
287 
288 
289 }
290 
291 // declare the | aka OR operators
292 Q_DECLARE_OPERATORS_FOR_FLAGS(camitk::InterfaceGeometry::RenderingModes)
293 Q_DECLARE_OPERATORS_FOR_FLAGS(camitk::InterfaceGeometry::GlyphTypes)
294 Q_DECLARE_OPERATORS_FOR_FLAGS(camitk::InterfaceGeometry::EnhancedModes)
295 
296 
297 #endif
virtual void setTexture(vtkSmartPointer< vtkTexture >)=0
Set a texture to this object.
virtual void setRenderingModes(const RenderingModes)=0
virtual void setPointSet(vtkSmartPointer< vtkPointSet >)=0
set the low-level data set.
there are no glyph type attached to the geometry
Definition: InterfaceGeometry.h:84
no rendering mode, the InterfaceGeometry is not visible
Definition: InterfaceGeometry.h:66
virtual void setActorOpacity(const RenderingModes, const double)=0
Set the opacity of this representation modes. WARNING color field (surfaceColor, ...) are not modified!
Definition: Action.cpp:36
virtual void setOpacity(const double)=0
Set the opacity of this object. WARNING color field (surfaceColor, ...) are not modified! ...
virtual void pointPicked(vtkIdType pointId, bool pickingIsSelecting)=0
This method is called when a vtkPoint included in the vtk representation was picked.
virtual void setPointData(vtkSmartPointer< vtkDataArray >)=0
set the point data (may contains a lookup table).
virtual void cellPicked(vtkIdType cellId, bool pickingIsSelecting)=0
This method is called when a vtkCell included in the vtk representation was picked.
virtual void setColor(const double, const double, const double)=0
Set an (r,g,b) color to all representation modes, without changing the opacity.
virtual ~InterfaceGeometry()=default
empty virtual destructor, to avoid memory leak
virtual void setActorColor(const RenderingModes, double *color)=0
Set the color of given representation modes.
virtual const EnhancedModes getEnhancedModes() const =0
get the current enhanced mode
virtual void setMeshWorldTransform(vtkSmartPointer< vtkTransform >)=0
set the transformation for 3D representation
virtual const QString getLabel() const =0
get the string used to display the label
virtual vtkSmartPointer< vtkAlgorithmOutput > getDataPort() const =0
get the custom algorithm pipeline input.
virtual void setLinesAsTubes(bool)=0
set the lines as tubes (works only for vtkDataSet representation that contains lines) ...
the object is hidden
Definition: InterfaceGeometry.h:76
virtual void setLabel(QString newName)=0
set the string used to display the label
virtual bool removeProp(const QString &)=0
remove a given additional prop.
the surface is visible
Definition: InterfaceGeometry.h:67
virtual void getBounds(double *bounds)=0
compute the object&#39;s bounding box [xmin,xmax, ymin,ymax, zmin,zmax]
virtual vtkSmartPointer< vtkProp > getProp(const QString &)=0
Return the vtkProp (actors, volumes and annotations) corresponding to the given name.
virtual const RenderingModes getRenderingModes() const =0
Return if the actor associated to a rendering mode is currently visible or not.
virtual double getBoundingRadius()=0
compute the object&#39;s bounding sphere radius
virtual unsigned int getNumberOfProp() const =0
return the number of additional prop
virtual void setEnhancedModes(const EnhancedModes)=0
set the enhanced mode
GlyphType
(and QFlags GlyphTypes) is the type of glyph attached to the geometry representation ...
Definition: InterfaceGeometry.h:83
the object is shaded
Definition: InterfaceGeometry.h:77
virtual vtkSmartPointer< vtkPointSet > getPointSet()=0
EnhancedMode
(and QFlags EnhancedModes) handle the way the rendering actors will be enhanced or not (from complete...
Definition: InterfaceGeometry.h:74
virtual vtkSmartPointer< vtkActor > getActor(const RenderingModes)=0
Return the actor for the representation mode, NULL if the actor doesn&#39;t exist.
virtual void setDataConnection(vtkSmartPointer< vtkAlgorithmOutput >)=0
Set/reset the connection for the InterfaceGeometry internal algorithm.
Handle rendering options (surface and wireframe) of an Object3D.
Definition: RenderingMode.h:37
This class describes what are the methods to implement for a Geometry (rendering parameters, input/output, filters, picking parameters...)
Definition: InterfaceGeometry.h:61
virtual void setPointPosition(const unsigned int orderNumber, const double x, const double y, const double z)=0
set a given point position
virtual double getActorOpacity(const RenderingModes) const =0
Return the opacity of a given renderng mode.
virtual void getActorColor(const RenderingModes, double *color)=0
Get the color of given representation modes in the second parameter.
the object is highlighted
Definition: InterfaceGeometry.h:78
the glyph is a nice sphere
Definition: InterfaceGeometry.h:85
virtual void setGlyphType(const GlyphTypes type, const double size=0.0)=0
Set the glyph type (a glyph is a geometric representation attached to every point in the input datase...
the object is normally displayed
Definition: InterfaceGeometry.h:75
the wireframe is visible
Definition: InterfaceGeometry.h:68
the points are visible
Definition: InterfaceGeometry.h:69
virtual bool addProp(const QString &, vtkSmartPointer< vtkProp >)=0
insert an additional prop, defining it by its name (default visibility = false).
virtual void setMapperScalarRange(double min, double max)=0
Set the mapper scalar range.