Computer Assited Medical Intervention Tool Kit  version 4.0
AtomDecoration.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2016 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 ATOMDECORATION_H
27 #define ATOMDECORATION_H
28 #include "PMComponentAPI.h"
29 
30 
31 class Atom;
32 class AtomDC;
33 class Vector;
34 
35 #include "Decoration.h"
36 
37 #include <GeometricObject.h>
38 
47 public:
48 
51  ~AtomDecoration();
52 
59  void update(const double, const double, const double);
60 
67  void update(const double[3]);
68 
70  void update();
71 
73  void show(const bool);
74 
76  void setColor(const double, const double, const double);
77 
79  void setSize(const double);
80 
82  void setPosition(const double, const double, const double);
83 
85  void setDirection(const double, const double, const double);
86 
88  void setDirection(const double[3]);
89 
90  // get the geometric type
91  camitk::GeometricObject::Geometry getType() const;
92 
93 private:
96 
97 };
98 
100  return myObject->getType();
101 }
102 
103 #endif
This class allows you to display a geometric object (arrow, sphere, ...) positionned on an atom...
Definition: AtomDecoration.h:46
#define PHYSICALMODEL_COMPONENT_API
Definition: PMComponentAPI.h:54
A geometric object allows one to create geometric object (sphere, arrow, ...) that can be added direc...
Definition: GeometricObject.h:54
virtual void setColor(const double, const double, const double)=0
change the color of the geometric object
virtual void update()=0
update the position of the geometric object (using the atom&#39;s position)
The manager of the Atom data.
Definition: AtomDC.h:74
camitk::GeometricObject * myObject
Definition: AtomDecoration.h:94
An atom has an unique index in the physical model object, a 3D position, and different basic properti...
Definition: Atom.h:49
abstract class representing a decoration added to a DC
Definition: Decoration.h:33
Atom * myAtom
Definition: AtomDecoration.h:95
virtual void show(const bool)=0
show the geometric object in 3D or not depending on the paramater
Geometry
the geometric type
Definition: GeometricObject.h:58
camitk::GeometricObject::Geometry getType() const
Definition: AtomDecoration.h:99