ECOGEN 6.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
GeometricObject.h
Go to the documentation of this file.
1//
2// ,---. ,--, .---. ,--, ,---. .-. .-.
3// | .-' .' .') / .-. ) .' .' | .-' | \| |
4// | `-. | |(_) | | |(_) | | __ | `-. | | |
5// | .-' \ \ | | | | \ \ ( _) | .-' | |\ |
6// | `--. \ `-. \ `-' / \ `-) ) | `--. | | |)|
7// /( __.' \____\ )---' )\____/ /( __.' /( (_)
8// (__) (_) (__) (__) (__)
9// Official webSite: https://code-mphi.github.io/ECOGEN/
10//
11// This file is part of ECOGEN.
12//
13// ECOGEN is the legal property of its developers, whose names
14// are listed in the copyright file included with this source
15// distribution.
16//
17// ECOGEN is free software: you can redistribute it and/or modify
18// it under the terms of the GNU General Public License as published
19// by the Free Software Foundation, either version 3 of the License,
20// or (at your option) any later version.
21//
22// ECOGEN is distributed in the hope that it will be useful,
23// but WITHOUT ANY WARRANTY; without even the implied warranty of
24// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25// GNU General Public License for more details.
26//
27// You should have received a copy of the GNU General Public License
28// along with ECOGEN (file LICENSE).
29// If not, see <http://www.gnu.org/licenses/>.
30
31#ifndef GEOMETRICOBJECT_H
32#define GEOMETRICOBJECT_H
33
34#include "Coord.h"
35#include "../Errors.h"
36#include "../Tools.h"
37
41{
42 public:
44 GeometricObject(TypeGO type, const Coord& vertex);
45 virtual ~GeometricObject();
46
49 virtual double distancePoint(const Coord& /*vertex*/) const
50 {
51 Errors::errorMessage("distancePoint unknown for considered geometric object");
52 return 0;
53 };
54
56 virtual Coord projectionPoint(const Coord& /*vertex*/) const
57 {
58 Errors::errorMessage("projectionPoint unknown for considered geometric object");
59 return 0;
60 };
61
63 TypeGO getType() { return m_type; };
64
65 // Accessors
66 //----------
67 const Coord& getPoint() const { return m_point; };
68 virtual void setPositionPoint(double posX, double posY, double posZ) { m_point.setXYZ(posX, posY, posZ); };
69
70 protected:
73};
74
75#endif //GEOMETRICOBJECT_H
TypeGO
Enumeration for the type of geometric object (VERTEX, LINE, PLAN).
Definition Tools.h:82
Class for a coordinate system object such as coordinates of the vertex or a vector.
Definition Coord.h:43
static void errorMessage(const std::string &message_)
Definition Errors.cpp:56
GeometricObject()
Definition GeometricObject.cpp:35
virtual double distancePoint(const Coord &) const
Compute the distance between a vertex and the corresponding geometric object.
Definition GeometricObject.h:49
Coord m_point
Type of the geometric object.
Definition GeometricObject.h:72
virtual void setPositionPoint(double posX, double posY, double posZ)
Definition GeometricObject.h:68
TypeGO m_type
Definition GeometricObject.h:71
virtual ~GeometricObject()
Definition GeometricObject.cpp:43
const Coord & getPoint() const
Definition GeometricObject.h:67
TypeGO getType()
Return the type of the geometric object.
Definition GeometricObject.h:63
virtual Coord projectionPoint(const Coord &) const
Compute the projection between a vertex and the corresponding geometric object.
Definition GeometricObject.h:56