SHAPER 9.16.0
FeaturesPlugin_Offset.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 FeaturesPlugin_Offset_H_
21#define FeaturesPlugin_Offset_H_
22
23#include "FeaturesPlugin.h"
24
25#include <ModelAPI_Feature.h>
26
31{
32public:
35
37 inline static const std::string& ID()
38 {
39 static const std::string MY_ID("Offset3d");
40 return MY_ID;
41 }
42
44 inline static const std::string& CREATION_METHOD_ID()
45 {
46 static const std::string MY_CREATION_METHOD_ID("creation_method");
47 return MY_CREATION_METHOD_ID;
48 }
49
51 inline static const std::string& CREATION_METHOD_EQUAL()
52 {
53 static const std::string MY_CREATION_METHOD_EQUAL("offset_equal");
54 return MY_CREATION_METHOD_EQUAL;
55 }
56
58 inline static const std::string& CREATION_METHOD_PARTIAL()
59 {
60 static const std::string MY_CREATION_METHOD_PARTIAL("offset_partial");
61 return MY_CREATION_METHOD_PARTIAL;
62 }
63
65 inline static const std::string& BASE_SHAPE_ID()
66 {
67 static const std::string MY_BASE_SHAPE_ID("base_shape");
68 return MY_BASE_SHAPE_ID;
69 }
70
72 inline static const std::string& OFFSET_VALUE_ID()
73 {
74 static const std::string MY_OFFSET_VALUE_ID("offset_value");
75 return MY_OFFSET_VALUE_ID;
76 }
77
79 inline static const std::string& PIPE_JOINT_ID()
80 {
81 static const std::string MY_PIPE_JOINT_ID("pipe_joint");
82 return MY_PIPE_JOINT_ID;
83 }
84
86 inline static const std::string& FACES_ID()
87 {
88 static const std::string MY_FACES_ID("faces_to_offset");
89 return MY_FACES_ID;
90 }
91
92
94 FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
95 {
96 static std::string MY_KIND = FeaturesPlugin_Offset::ID();
97 return MY_KIND;
98 }
99
101 FEATURESPLUGIN_EXPORT virtual void initAttributes();
102
104 FEATURESPLUGIN_EXPORT virtual void execute();
105};
106
107#endif
Feature for offset.
Definition: FeaturesPlugin_Offset.h:31
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_Offset.h:37
static const std::string & CREATION_METHOD_ID()
Attribute name for creation method.
Definition: FeaturesPlugin_Offset.h:44
virtual void execute()
Performs the algorithm and stores results it in the data structure.
Definition: FeaturesPlugin_Offset.cpp:54
static const std::string & CREATION_METHOD_PARTIAL()
Attribute name for creation method.
Definition: FeaturesPlugin_Offset.h:58
static const std::string & BASE_SHAPE_ID()
Attribute name of base shape.
Definition: FeaturesPlugin_Offset.h:65
FeaturesPlugin_Offset()
Use plugin manager for features creation.
Definition: FeaturesPlugin_Offset.cpp:36
virtual const std::string & getKind()
Definition: FeaturesPlugin_Offset.h:94
static const std::string & OFFSET_VALUE_ID()
Attribute name of offset value.
Definition: FeaturesPlugin_Offset.h:72
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: FeaturesPlugin_Offset.cpp:41
static const std::string & PIPE_JOINT_ID()
Attribute name of pipe/intersection joint bool flag.
Definition: FeaturesPlugin_Offset.h:79
static const std::string & CREATION_METHOD_EQUAL()
Attribute name for creation method.
Definition: FeaturesPlugin_Offset.h:51
static const std::string & FACES_ID()
Attribute name of sub-faces to offset (for partial offset).
Definition: FeaturesPlugin_Offset.h:86
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:41