1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef ConstructionPlugin_Point_H_
22 #define ConstructionPlugin_Point_H_
24 #include "ConstructionPlugin.h"
26 #include <GeomAPI_ICustomPrs.h>
27 #include <ModelAPI_Feature.h>
28 #include <ModelAPI_Result.h>
34 /// \class ConstructionPlugin_Point
36 /// \brief Feature for creation of the new part in PartSet.
37 class ConstructionPlugin_Point: public ModelAPI_Feature, public GeomAPI_ICustomPrs
40 /// Returns the kind of a feature.
41 CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind();
44 inline static const std::string& ID()
46 static const std::string CONSTRUCTION_POINT_KIND("Point");
47 return CONSTRUCTION_POINT_KIND;
50 /// Attribute name for creation method.
51 inline static const std::string& CREATION_METHOD()
53 static const std::string MY_CREATION_METHOD_ID("creation_method");
54 return MY_CREATION_METHOD_ID;
57 /// Attribute name for creation method.
58 inline static const std::string& CREATION_METHOD_BY_XYZ()
60 static const std::string MY_CREATION_METHOD_ID("by_xyz");
61 return MY_CREATION_METHOD_ID;
64 /// Attribute name for creation method.
65 inline static const std::string& CREATION_METHOD_BY_DISTANCE_ON_EDGE()
67 static const std::string MY_CREATION_METHOD_ID("by_distance_on_edge");
68 return MY_CREATION_METHOD_ID;
71 /// Attribute name for creation method.
72 inline static const std::string& CREATION_METHOD_BY_PROJECTION()
74 static const std::string MY_CREATION_METHOD_ID("by_projection");
75 return MY_CREATION_METHOD_ID;
78 /// Attribute name for creation method.
79 inline static const std::string& CREATION_METHOD_BY_LINES_INTERSECTION()
81 static const std::string MY_CREATION_METHOD_ID("by_lines_intersection");
82 return MY_CREATION_METHOD_ID;
85 /// Attribute name for creation method.
86 inline static const std::string& CREATION_METHOD_BY_LINE_AND_PLANE_INTERSECTION()
88 static const std::string MY_CREATION_METHOD_ID("by_line_and_plane_intersection");
89 return MY_CREATION_METHOD_ID;
92 /// Attribute name for X coordinate.
93 inline static const std::string& X()
95 static const std::string POINT_ATTR_X("x");
99 /// Attribute name for Y coordinate.
100 inline static const std::string& Y()
102 static const std::string POINT_ATTR_Y("y");
106 /// Attribute name for Z coordinate.
107 inline static const std::string& Z()
109 static const std::string POINT_ATTR_Z("z");
113 /*/// Attribute name for selected edge.
114 inline static const std::string& EDGE()
116 static const std::string ATTR_ID("edge");
120 /// Attribute name for distance.
121 inline static const std::string& DISTANCE_VALUE()
123 static const std::string ATTR_ID("value");
127 /// Attribute name for percent flag.
128 inline static const std::string& DISTANCE_PERCENT()
130 static const std::string ATTR_ID("percent");
134 /// Attribute name for reverse flag.
135 inline static const std::string& REVERSE()
137 static const std::string ATTR_ID("reverse");
141 /// Attribute name for point.
142 inline static const std::string& POINT()
144 static const std::string ATTR_ID("point");
148 /// Attribute name for plane.
149 inline static const std::string& PLANE()
151 static const std::string ATTR_ID("plane");
155 /// Attribute name for selected first line.
156 inline static const std::string& FIRST_LINE()
158 static const std::string ATTR_ID("first_line");
162 /// Attribute name for selected second line.
163 inline static const std::string& SECOND_LINE()
165 static const std::string ATTR_ID("second_line");
170 /// Attribute name for selected intersection line.
171 inline static const std::string& INTERSECTION_LINE()
173 static const std::string ATTR_ID("intersection_line");
177 /// Attribute name for selected intersection plane.
178 inline static const std::string& INTERSECTION_PLANE()
180 static const std::string ATTR_ID("intersection_plane");
184 /// Attribute name for use offset for the intersection plane.
185 inline static const std::string& USE_OFFSET()
187 static const std::string ATTR_ID("use_offset");
191 /// Attribute name for offset for the intersection plane.
192 inline static const std::string& OFFSET()
194 static const std::string ATTR_ID("offset");
198 /// Attribute name for reverse offset for the intersection plane.
199 inline static const std::string& REVERSE_OFFSET()
201 static const std::string ATTR_ID("reverse_offset");
205 /// Creates a new part document if needed.
206 CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
208 /// Request for initialization of data model of the feature: adding all attributes.
209 CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
211 /// Construction result is allways recomuted on the fly.
212 CONSTRUCTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
214 /// Use plugin manager for features creation
215 ConstructionPlugin_Point();
217 /// Customize presentation of the feature
218 virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
219 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
222 std::shared_ptr<GeomAPI_Vertex> createByXYZ();
223 /*std::shared_ptr<GeomAPI_Vertex> createByDistanceOnEdge();
224 std::shared_ptr<GeomAPI_Vertex> createByProjection();
225 std::shared_ptr<GeomAPI_Vertex> createByLinesIntersection();*/
226 std::list<std::shared_ptr<GeomAPI_Vertex> > createByLineAndPlaneIntersection();