SHAPER  9.12.0
GeomAPI_PlanarEdges.h
1 // Copyright (C) 2014-2023 CEA, EDF
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef GEOMAPI_WIRE_H_
21 #define GEOMAPI_WIRE_H_
22 
23 #include "GeomAPI.h"
24 #include "GeomAPI_Edge.h"
25 #include "GeomAPI_Pnt.h"
26 #include "GeomAPI_Dir.h"
27 #include "GeomAPI_Ax3.h"
28 
29 #include <memory>
30 
31 #include <list>
32 
40 {
41  public:
43  GEOMAPI_EXPORT GeomAPI_PlanarEdges();
44 
46  GEOMAPI_EXPORT virtual bool isVertex() const;
47 
49  GEOMAPI_EXPORT virtual bool isEdge() const;
51  GEOMAPI_EXPORT void addEdge(std::shared_ptr<GeomAPI_Shape> theEdge);
53  GEOMAPI_EXPORT std::list<std::shared_ptr<GeomAPI_Shape> > getEdges();
54 
56  GEOMAPI_EXPORT bool hasPlane() const;
57 
59  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> origin() const;
60 
62  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirX() const;
63 
65  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirY() const;
66 
68  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> norm() const;
69 
71  GEOMAPI_EXPORT virtual bool isPlanar() const;
72 
77  GEOMAPI_EXPORT void setPlane(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
78  const std::shared_ptr<GeomAPI_Dir>& theDirX,
79  const std::shared_ptr<GeomAPI_Dir>& theNorm);
80 
82  GEOMAPI_EXPORT
83  virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theShape) const;
84 
85 private:
86 
87  std::shared_ptr<GeomAPI_Ax3> myPlane;
88 };
89 
90 #endif
91 
Interface to the set of edges located in one plane.
Definition: GeomAPI_PlanarEdges.h:40
virtual bool isEdge() const
Returns whether the shape is alone edge.
Definition: GeomAPI_PlanarEdges.cpp:74
virtual bool isPlanar() const
Returns whether the shape is planar.
Definition: GeomAPI_PlanarEdges.cpp:106
std::shared_ptr< GeomAPI_Dir > dirY() const
Returns Y direction vector.
Definition: GeomAPI_PlanarEdges.cpp:92
void addEdge(std::shared_ptr< GeomAPI_Shape > theEdge)
Appends the edge to the set.
Definition: GeomAPI_PlanarEdges.cpp:43
std::list< std::shared_ptr< GeomAPI_Shape > > getEdges()
Returns the list of edges in this interface.
Definition: GeomAPI_PlanarEdges.cpp:53
std::shared_ptr< GeomAPI_Dir > dirX() const
Returns X direction vector.
Definition: GeomAPI_PlanarEdges.cpp:85
std::shared_ptr< GeomAPI_Pnt > origin() const
Returns the plane origin point.
Definition: GeomAPI_PlanarEdges.cpp:78
virtual bool isEqual(const std::shared_ptr< GeomAPI_Shape > theShape) const
Returns whether the shapes are equal.
Definition: GeomAPI_PlanarEdges.cpp:118
void setPlane(const std::shared_ptr< GeomAPI_Pnt > &theOrigin, const std::shared_ptr< GeomAPI_Dir > &theDirX, const std::shared_ptr< GeomAPI_Dir > &theNorm)
Set working plane.
Definition: GeomAPI_PlanarEdges.cpp:111
std::shared_ptr< GeomAPI_Dir > norm() const
Returns Z direction vector.
Definition: GeomAPI_PlanarEdges.cpp:99
virtual bool isVertex() const
Returns whether the shape is alone vertex.
Definition: GeomAPI_PlanarEdges.cpp:70
GeomAPI_PlanarEdges()
Creation of empty (null) shape.
Definition: GeomAPI_PlanarEdges.cpp:35
bool hasPlane() const
Returns True if the wire is defined in a plane.
Definition: GeomAPI_PlanarEdges.cpp:66
Interface to the topological shape object.
Definition: GeomAPI_Shape.h:43