SHAPER 9.16.0
PrimitivesPlugin_Box.h
1// Copyright (C) 2014-2026 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 PrimitivesPlugin_Box_H_
21#define PrimitivesPlugin_Box_H_
22
23#include <PrimitivesPlugin.h>
24#include <ModelAPI_Feature.h>
25#include <GeomAlgoAPI_Box.h>
26
27class GeomAPI_Shape;
29
40{
41 public:
43 inline static const std::string& ID()
44 {
45 static const std::string MY_BOX_ID("Box");
46 return MY_BOX_ID;
47 }
48
50 inline static const std::string& CREATION_METHOD()
51 {
52 static const std::string MY_CREATION_METHOD_ID("CreationMethod");
53 return MY_CREATION_METHOD_ID;
54 }
55
57 inline static const std::string& CREATION_METHOD_BY_DIMENSIONS()
58 {
59 static const std::string MY_CREATION_METHOD_ID("BoxByDimensions");
60 return MY_CREATION_METHOD_ID;
61 }
62
64 inline static const std::string& CREATION_METHOD_BY_TWO_POINTS()
65 {
66 static const std::string MY_CREATION_METHOD_ID("BoxByTwoPoints");
67 return MY_CREATION_METHOD_ID;
68 }
69
71 inline static const std::string& CREATION_METHOD_BY_ONE_POINT_AND_DIMS()
72 {
73 static const std::string MY_CREATION_METHOD_ID("BoxByOnePointAndDims");
74 return MY_CREATION_METHOD_ID;
75 }
76
78 inline static const std::string& POINT_FIRST_ID()
79 {
80 static const std::string MY_POINT_FIRST_ID("FirstPoint");
81 return MY_POINT_FIRST_ID;
82 }
83
85 inline static const std::string& POINT_SECOND_ID()
86 {
87 static const std::string MY_POINT_SECOND_ID("SecondPoint");
88 return MY_POINT_SECOND_ID;
89 }
90
92 inline static const std::string& DX_ID()
93 {
94 static const std::string MY_DX_ID("dx");
95 return MY_DX_ID;
96 }
97
99 inline static const std::string& DY_ID()
100 {
101 static const std::string MY_DY_ID("dy");
102 return MY_DY_ID;
103 }
104
106 inline static const std::string& DZ_ID()
107 {
108 static const std::string MY_DZ_ID("dz");
109 return MY_DZ_ID;
110 }
111
113 inline static const std::string& OX_ID()
114 {
115 static const std::string MY_OX_ID("ox");
116 return MY_OX_ID;
117 }
118
120 inline static const std::string& OY_ID()
121 {
122 static const std::string MY_OY_ID("oy");
123 return MY_OY_ID;
124 }
125
127 inline static const std::string& OZ_ID()
128 {
129 static const std::string MY_OZ_ID("oz");
130 return MY_OZ_ID;
131 }
132
134 inline static const std::string& HALF_DX_ID()
135 {
136 static const std::string MY_HALF_DX_ID("half_dx");
137 return MY_HALF_DX_ID;
138 }
139
141 inline static const std::string& HALF_DY_ID()
142 {
143 static const std::string MY_HALF_DY_ID("half_dy");
144 return MY_HALF_DY_ID;
145 }
146
148 inline static const std::string& HALF_DZ_ID()
149 {
150 static const std::string MY_HALF_DZ_ID("half_dz");
151 return MY_HALF_DZ_ID;
152 }
153
155 PRIMITIVESPLUGIN_EXPORT virtual const std::string& getKind()
156 {
157 static std::string MY_KIND = PrimitivesPlugin_Box::ID();
158 return MY_KIND;
159 }
160
162 PRIMITIVESPLUGIN_EXPORT virtual void execute();
163
165 PRIMITIVESPLUGIN_EXPORT virtual void initAttributes();
166
169
170 private:
172 void loadNamingDS(std::shared_ptr<GeomAlgoAPI_Box> theBoxAlgo,
173 std::shared_ptr<ModelAPI_ResultBody> theResultBox);
174
176 void createBoxByTwoPoints();
177
179 void createBoxByDimensions();
180
182 void createBoxByOnePointAndDims();
183
184};
185
186
187#endif
Interface to the topological shape object.
Definition: GeomAPI_Shape.h:43
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:41
The body (shape) result of a feature.
Definition: ModelAPI_ResultBody.h:43
Feature for creation of a box primitive using various methods.
Definition: PrimitivesPlugin_Box.h:40
PrimitivesPlugin_Box()
Use plugin manager for features creation.
Definition: PrimitivesPlugin_Box.cpp:34
static const std::string & HALF_DY_ID()
Attribute name of the half-length on Y axis.
Definition: PrimitivesPlugin_Box.h:141
virtual PRIMITIVESPLUGIN_EXPORT const std::string & getKind()
Returns the kind of a feature.
Definition: PrimitivesPlugin_Box.h:155
static const std::string & CREATION_METHOD_BY_DIMENSIONS()
Attribute name for creation method.
Definition: PrimitivesPlugin_Box.h:57
static const std::string & DZ_ID()
Attribute third coordinate.
Definition: PrimitivesPlugin_Box.h:106
static const std::string & CREATION_METHOD_BY_TWO_POINTS()
Attribute name for creation method.
Definition: PrimitivesPlugin_Box.h:64
static const std::string & ID()
Box kind.
Definition: PrimitivesPlugin_Box.h:43
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: PrimitivesPlugin_Box.h:50
static const std::string & DY_ID()
Attribute second coordinate.
Definition: PrimitivesPlugin_Box.h:99
static const std::string & OX_ID()
Attribute name of the first coordinate of the center.
Definition: PrimitivesPlugin_Box.h:113
static const std::string & DX_ID()
Attribute first coordinate.
Definition: PrimitivesPlugin_Box.h:92
static const std::string & HALF_DX_ID()
Attribute name of the half-length on X axis.
Definition: PrimitivesPlugin_Box.h:134
virtual PRIMITIVESPLUGIN_EXPORT void execute()
Creates a new part document if needed.
Definition: PrimitivesPlugin_Box.cpp:64
static const std::string & POINT_FIRST_ID()
Attribute name of first point.
Definition: PrimitivesPlugin_Box.h:78
static const std::string & HALF_DZ_ID()
Attribute name of the half-length on Z axis.
Definition: PrimitivesPlugin_Box.h:148
virtual PRIMITIVESPLUGIN_EXPORT void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: PrimitivesPlugin_Box.cpp:39
static const std::string & POINT_SECOND_ID()
Attribute name of second point.
Definition: PrimitivesPlugin_Box.h:85
static const std::string & CREATION_METHOD_BY_ONE_POINT_AND_DIMS()
Attribute name for creation method.
Definition: PrimitivesPlugin_Box.h:71
static const std::string & OZ_ID()
Attribute name of the third coordinate of the center.
Definition: PrimitivesPlugin_Box.h:127
static const std::string & OY_ID()
Attribute name of the second coordinate of the center.
Definition: PrimitivesPlugin_Box.h:120