1 // Copyright (C) 2014-2016 CEA/DEN, EDF R&D
3 // File: ConstructionPlugin_Axis.h
4 // Created: 12 Dec 2014
5 // Author: Vitaly Smetannikov
7 // Modified by CEA (delegation to Alyotech) : 29 Mar 2016
9 #ifndef ConstructionPlugin_Axis_H
10 #define ConstructionPlugin_Axis_H
12 #include "ConstructionPlugin.h"
13 #include <ModelAPI_Feature.h>
14 #include <ModelAPI_Result.h>
15 #include <GeomAPI_ICustomPrs.h>
17 /**\class ConstructionPlugin_Axis
19 * \brief Feature for creation of the new axis in PartSet.
21 class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomPrs
24 /// Returns the kind of a feature
25 CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind()
27 static std::string MY_KIND = ConstructionPlugin_Axis::ID();
32 inline static const std::string& ID()
34 static const std::string CONSTRUCTION_AXIS_KIND("Axis");
35 return CONSTRUCTION_AXIS_KIND;
38 /// attribute name for first point
39 inline static const std::string& METHOD()
41 static const std::string METHOD_ATTR("CreationMethod");
45 /// Attribute name for creation method.
46 inline static const std::string& CREATION_METHOD_BY_LINE()
48 static const std::string METHOD_ATTR("by_line");
52 /// Attribute name for creation method.
53 inline static const std::string& CREATION_METHOD_BY_PLANE_AND_POINT()
55 static const std::string METHOD_ATTR("by_plane_and_point");
59 /// attribute name for first point
60 inline static const std::string& POINT_FIRST()
62 static const std::string POINT_ATTR_FIRST("FirstPoint");
63 return POINT_ATTR_FIRST;
65 /// attribute name for second point
66 inline static const std::string& POINT_SECOND()
68 static const std::string POINT_ATTR_SECOND("SecondPoint");
69 return POINT_ATTR_SECOND;
71 /// attribute name for second point
72 inline static const std::string& CYLINDRICAL_FACE()
74 static const std::string CYLINDRICAL_FACE_ATTR("CylindricalFace");
75 return CYLINDRICAL_FACE_ATTR;
77 /// attribute name for the X dimension
78 inline static const std::string& DX()
80 static const std::string DX_ATTR("DX");
83 /// attribute name for the Y dimension
84 inline static const std::string& DY()
86 static const std::string DY_ATTR("DY");
89 /// attribute name for the Z dimension
90 inline static const std::string& DZ()
92 static const std::string DZ_ATTR("DZ");
96 /// attribute name for X direction
97 inline static const std::string& X_DIRECTION()
99 static const std::string ATTR_X_DIRECTION("X_Direction");
100 return ATTR_X_DIRECTION;
103 /// attribute name for Y direction
104 inline static const std::string& Y_DIRECTION()
106 static const std::string ATTR_Y_DIRECTION("Y_Direction");
107 return ATTR_Y_DIRECTION;
110 /// attribute name for Y direction
111 inline static const std::string& Z_DIRECTION()
113 static const std::string ATTR_Z_DIRECTION("Z_Direction");
114 return ATTR_Z_DIRECTION;
117 /// Attribute name for line.
118 inline static const std::string& LINE()
120 static const std::string ATTR_ID("line");
124 /// Attribute name for plane.
125 inline static const std::string& PLANE()
127 static const std::string ATTR_ID("plane");
131 /// Attribute name for point.
132 inline static const std::string& POINT()
134 static const std::string ATTR_ID("point");
138 /// Returns a minimal length for axis
139 inline static const double MINIMAL_LENGTH() { return 1.e-5; }
141 /// Creates a new part document if needed
142 CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
144 /// Request for initialization of data model of the feature: adding all attributes
145 CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
147 /// Construction result is allways recomuted on the fly
148 CONSTRUCTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
150 /// Use plugin manager for features creation
151 ConstructionPlugin_Axis();
153 /// Customize presentation of the feature
154 virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
155 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
158 /// Creates a new axis by two defined points
159 void createAxisByTwoPoints();
160 /// Creates a new axis using three dimensions
161 void createAxisByDimensions();
162 /// Creates a new axis as copy of cylindrical face axis
163 void createAxisByCylindricalFace();
164 /// Creates a new axis by point and direction
165 void createAxisByPointAndDirection();
166 void createAxisByLine();
167 void createAxisByPlaneAndPoint();