Computer Assisted Medical Intervention Tool Kit  version 5.2
 
Loading...
Searching...
No Matches
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-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
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"
34class Object3D;
36
37// other includes
38#include <algorithm> // for the remove
39#include <string>
40
41//pmlschema forward declarations
42namespace physicalModel {
44}
53public:
57
59 StructuralComponent(PhysicalModel* p, physicalModel::StructuralComponent xmlSC);
60
64
66 ~StructuralComponent() override;
67
69 unsigned int getNumberOfStructures() const;
70
77 void addStructure(Structure* s, bool check = true);
78
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 override;
127
129 bool isInstanceOf(const char*) const override;
130
132 unsigned int getNumberOfCells() const override;
133
135 Cell* getCell(unsigned int) const override;
136
143
146
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
162
164 void setMode(const RenderingMode::Mode);
168 bool isVisible(const RenderingMode::Mode mode) const override;
170 void setVisible(const RenderingMode::Mode mode, const bool b) override;
171
178
183 virtual ComposedBy composedBy();
184
188 bool isCompatible(Structure*);
189
194 void plannedNumberOfStructures(const unsigned int);
195
197 void setPhysicalModel(PhysicalModel*) override;
198
199protected:
203 std::vector <Structure*> structures;
204
208
209};
210
211// ------- INLINE -----------
212inline 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}
220inline Structure* StructuralComponent::getStructure(const unsigned int i) const {
221 if (i < structures.size()) {
222 return structures[i];
223 }
224 else {
225 return nullptr;
226 }
227}
229 auto it = structures.begin();
230 while (it != structures.end() && (*it)->getIndex() != i) {
231 it++;
232 }
233 if (it == structures.end()) {
234 return nullptr;
235 }
236 else {
237 return (*it);
238 }
239}
241 auto it = structures.begin();
242 while (it != structures.end() && (*it)->getName() != n) {
243 it++;
244 }
245 if (it == structures.end()) {
246 return nullptr;
247 }
248 else {
249 return (*it);
250 }
251}
253 return (unsigned int) structures.size();
254}
256 if (s) {
257 // remove it from the list
258 auto it = std::find(structures.begin(), structures.end(), s);
259 if (it != structures.end()) {
260 structures.erase(it);
261 // tell s that it is no more used by this structural component
263 }
264 }
265}
266inline bool StructuralComponent::isInstanceOf(const char* className) const {
267 return (std::string(className) == std::string("StructuralComponent"));
268}
269
270inline void StructuralComponent::plannedNumberOfStructures(const unsigned int size) {
271 structures.reserve(size);
272}
273
277
278#endif //STRUCTURALCOMPONENT_H
#define a
A cell has an unique index in the physical model object, is composed by atoms, and different basic pr...
Definition Cell.h:46
A component is something that composed something and could also be a part of something.
Definition modeling/libraries/pml/Component.h:48
Properties * properties
Definition modeling/libraries/pml/Component.h:118
This is the main class of this project.
Definition PhysicalModel.h:86
Mode
This is a duplicate of RenderingMode Mode....
Definition RenderingMode.h:40
A class that manages the structural component properties.
Definition StructuralComponentProperties.h:44
Color
Default color settings.
Definition StructuralComponentProperties.h:49
A structural component is composed either by cell or by atoms.
Definition StructuralComponent.h:52
void setVisible(const RenderingMode::Mode mode, const bool b) override
set the visibility of a specific rendering mode
Definition StructuralComponent.cpp:149
StructuralComponentProperties * getProperties()
get the structural component properties of this SC
Definition StructuralComponent.h:274
Structure * getStructure(const unsigned int) const
get a structure by its index (fisrt structure is at index 0)
Definition StructuralComponent.h:220
void setColor(const StructuralComponentProperties::Color c)
Set the new color (using a StructuralComponentProperties::Color enum)
Definition StructuralComponent.cpp:105
void setMode(const RenderingMode::Mode)
set the rendering mode
Definition StructuralComponent.cpp:134
bool isStructureIn(Structure *s)
Check if a given structure is present in the list.
Definition StructuralComponent.cpp:239
StructuralComponent * atomList
List of all the atoms of this structural component, build the first time.
Definition StructuralComponent.h:207
unsigned int getNumberOfStructures() const
get the number of structures
Definition StructuralComponent.h:252
bool isCompatible(Structure *)
return true if the given structure is compatible with what composes this structural component.
Definition StructuralComponent.cpp:310
bool addStructureIfNotIn(Structure *s)
Add a Structure in the list, only if it is not already in (and in this case tells the structure to ad...
Definition StructuralComponent.cpp:248
void plannedNumberOfStructures(const unsigned int)
optimize the I/O of the std:vector structures.
Definition StructuralComponent.h:270
RenderingMode::Mode getMode() const
get the rendering mode
Definition StructuralComponent.cpp:139
StructuralComponentProperties::Color getStructuralComponentPropertiesColor() const
Return the color as a code (see StructuralComponentProperties::Color enum)
Definition StructuralComponent.cpp:128
double * getColor() const
Get the color.
Definition StructuralComponent.cpp:116
virtual void deleteAllStructures()
this method free all the sub-components (i.e.
Definition StructuralComponent.cpp:89
ComposedBy
What this structural component is made of.
Definition StructuralComponent.h:173
@ NOTHING
there are no structure yet, so everything is possible
Definition StructuralComponent.h:174
@ CELLS
the structural component is made of cells
Definition StructuralComponent.h:175
@ ATOMS
the structural component is made of atoms
Definition StructuralComponent.h:176
Cell * getCell(unsigned int) const override
get cell by order number (not cell index)
Definition StructuralComponent.cpp:197
Structure * getStructureByIndex(const unsigned int)
get a structure by its unique index
Definition StructuralComponent.h:228
~StructuralComponent() override
delete all the structures (call the deleteAllStructures method)
Definition StructuralComponent.cpp:73
virtual ComposedBy composedBy()
return the type of structure composing the structural component: a structural component is either a l...
Definition StructuralComponent.cpp:296
bool isInstanceOf(const char *) const override
return true only if the parameter is equal to "StructuralComponent"
Definition StructuralComponent.h:266
StructuralComponent * getAtoms()
Return a StructuralComponent with all the atoms of this structural component.
Definition StructuralComponent.cpp:261
void xmlPrint(std::ostream &) const override
print to an output stream in "pseudo" XML format (do nothing if there are no sub structures).
Definition StructuralComponent.cpp:154
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:255
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
unsigned int getNumberOfCells() const override
get the total nr of cell of the component
Definition StructuralComponent.cpp:183
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
bool isVisible(const RenderingMode::Mode mode) const override
tell if a specific rendering mode is visible or not
Definition StructuralComponent.cpp:144
void setPhysicalModel(PhysicalModel *) override
set the physical model (recursively to all cells or to all atoms)
Definition StructuralComponent.cpp:321
Structure * getStructureByName(const std::string)
get a structure by its name
Definition StructuralComponent.h:240
Pure virtual class that represent an element of the structure.
Definition Structure.h:43
void removeStructuralComponent(StructuralComponent *)
remove a particular StructuralComponent from the list
Definition Structure.h:132
virtual void addStructuralComponent(StructuralComponent *)
add a particular StructuralComponent in the list
Definition Structure.h:128
Definition Atom.h:36