Computer Assited Medical Intervention Tool Kit  version 4.0
StructuralComponent.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 STRUCTURALCOMPONENT_H
27 #define STRUCTURALCOMPONENT_H
28 
29 #include "PhysicalModelIO.h"
30 
31 // pml includes
32 #include "Component.h"
33 #include "Structure.h"
34 class Object3D;
36 
37 // other includes
38 #include <algorithm> // for the remove
39 #include <string>
40 
41 //pmlschema forward declarations
42 namespace physicalModel {
44 }
53 public:
57 
59  StructuralComponent(PhysicalModel *p, physicalModel::StructuralComponent xmlSC);
60 
63  StructuralComponent(PhysicalModel *, std::string);
64 
66  virtual ~StructuralComponent();
67 
69  unsigned int getNumberOfStructures() const;
70 
77  void addStructure(Structure *s, bool check = true);
78 
86  bool addStructureIfNotIn(Structure *s);
87 
92  bool isStructureIn(Structure *s);
93 
100  virtual void removeStructure(Structure *s);
101 
107  virtual void deleteAllStructures();
108 
112  Structure * getStructure(const unsigned int) const;
113 
117  Structure * getStructureByName(const std::string);
118 
122  Structure * getStructureByIndex(const unsigned int);
123 
126  void xmlPrint(std::ostream &) const;
127 
129  virtual bool isInstanceOf(const char *) const;
130 
132  unsigned int getNumberOfCells() const;
133 
135  Cell * getCell(unsigned int) const;
136 
142  StructuralComponent *getAtoms();
143 
145  StructuralComponentProperties * getProperties();
146 
148  void setColor(const StructuralComponentProperties::Color c);
150  void setColor(const double r, const double b, const double g, const double a);
152  void setColor(const double r, const double b, const double g);
156  double * getColor() const;
158  void getColor(double *r, double *g, double *b, double *a) const;
159 
161  StructuralComponentProperties::Color getStructuralComponentPropertiesColor() const;
162 
164  void setMode(const RenderingMode::Mode);
166  RenderingMode::Mode getMode() const;
168  virtual bool isVisible(const RenderingMode::Mode mode) const;
170  virtual void setVisible(const RenderingMode::Mode mode, const bool b);
171 
173  enum ComposedBy {
176  ATOMS
177  };
178 
183  virtual ComposedBy composedBy();
184 
188  bool isCompatible(Structure *);
189 
194  void plannedNumberOfStructures(const unsigned int);
195 
197  virtual void setPhysicalModel(PhysicalModel *);
198 
199 protected:
203  std::vector <Structure *> structures;
204 
208 
209 };
210 
211 // ------- INLINE -----------
212 inline void StructuralComponent::addStructure(Structure *s, bool check) {
213  // add the structure in the list, only if it is compatible
214  if (!check || isCompatible(s)) {
215  structures.push_back(s);
216  // tell the structure that it is a part of this sc
217  s->addStructuralComponent(this);
218  }
219 }
220 inline Structure * StructuralComponent::getStructure(const unsigned int i) const {
221  if (i<structures.size())
222  return structures[i];
223  else
224  return NULL;
225 }
226 inline Structure * StructuralComponent::getStructureByIndex(const unsigned int i) {
227  std::vector <Structure *>::iterator it=structures.begin();
228  while (it!=structures.end() && (*it)->getIndex()!=i)
229  it++;
230  if (it==structures.end())
231  return NULL;
232  else
233  return (*it);
234 }
235 inline Structure * StructuralComponent::getStructureByName(const std::string n) {
236  std::vector <Structure *>::iterator it=structures.begin();
237  while (it!=structures.end() && (*it)->getName()!=n)
238  it++;
239  if (it==structures.end())
240  return NULL;
241  else
242  return (*it);
243 }
244 inline unsigned int StructuralComponent::getNumberOfStructures() const {
245  return (unsigned int) structures.size();
246 }
248  if (s) {
249  // remove it from the list
250  std::vector <Structure *>::iterator it = std::find(structures.begin(), structures.end(), s);
251  if (it != structures.end()) {
252  structures.erase(it);
253  // tell s that it is no more used by this structural component
254  s->removeStructuralComponent(this);
255  }
256  }
257 }
258 inline bool StructuralComponent::isInstanceOf(const char *className) const {
259  return (std::string(className)==std::string("StructuralComponent"));
260 }
261 
262 inline void StructuralComponent::plannedNumberOfStructures(const unsigned int size) {
263  structures.reserve(size);
264 }
265 
267  return ((StructuralComponentProperties *)properties);
268 }
269 
270 #endif //STRUCTURALCOMPONENT_H
void plannedNumberOfStructures(const unsigned int)
optimize the I/O of the std:vector structures.
Definition: StructuralComponent.h:262
A cell has an unique index in the physical model object, is composed by atoms, and different basic pr...
Definition: Cell.h:46
virtual bool isInstanceOf(const char *) const
return true only if the parameter is equal to "StructuralComponent"
Definition: StructuralComponent.h:258
Pure virtual class that represent an element of the structure.
Definition: Structure.h:43
ComposedBy
What this structural component is made of.
Definition: StructuralComponent.h:173
StructuralComponentProperties * getProperties()
get the structural component properties of this SC
Definition: StructuralComponent.h:266
Definition: Atom.h:36
virtual void removeStructure(Structure *s)
Remove a structure from the list (and tells the structure to remove this structural component from it...
Definition: StructuralComponent.h:247
void removeStructuralComponent(StructuralComponent *)
remove a particular StructuralComponent from the list
Definition: Structure.h:130
unsigned int getNumberOfStructures() const
get the number of structures
Definition: StructuralComponent.h:244
StructuralComponent * atomList
List of all the atoms of this structural component, build the first time.
Definition: StructuralComponent.h:207
there are no structure yet, so everything is possible
Definition: StructuralComponent.h:174
A component is something that composed something and could also be a part of something.
Definition: modeling/libraries/pml/Component.h:48
void addStructure(Structure *s, bool check=true)
Add a Structure in the list (and tells the structure to add this structural component in its list)...
Definition: StructuralComponent.h:212
Mode
This is a duplicate of RenderingMode Mode....
Definition: RenderingMode.h:40
Structure * getStructureByIndex(const unsigned int)
get a structure by its unique index
Definition: StructuralComponent.h:226
A class that manages the structural component properties.
Definition: StructuralComponentProperties.h:44
This is the main class of this project.
Definition: PhysicalModel.h:86
Structure * getStructure(const unsigned int) const
get a structure by its index (fisrt structure is at index 0)
Definition: StructuralComponent.h:220
std::vector< Structure * > structures
List of the structure representing this component, all the structure in this list are either all Atom...
Definition: StructuralComponent.h:203
A structural component is composed either by cell or by atoms.
Definition: StructuralComponent.h:52
Color
Default color settings.
Definition: StructuralComponentProperties.h:49
the structural component is made of cells
Definition: StructuralComponent.h:175
virtual void addStructuralComponent(StructuralComponent *)
add a particular StructuralComponent in the list
Definition: Structure.h:126
Structure * getStructureByName(const std::string)
get a structure by its name
Definition: StructuralComponent.h:235