SHAPER 9.16.0
SketchPlugin_SketchDrawer.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 SketchPlugin_SketchDrawer_H_
21#define SketchPlugin_SketchDrawer_H_
22
23#include "SketchPlugin.h"
24#include <ModelAPI_Feature.h>
25
32{
33 public:
36
38 inline static const std::string& ID()
39 {
40 static const std::string MY_FEATURE_ID("SketchDrawer");
41 return MY_FEATURE_ID;
42 }
43
45 inline static const std::string& BASE_ID()
46 {
47 static const std::string ID("base_shape");
48 return ID;
49 }
51 inline static const std::string& PLANE_ID()
52 {
53 static const std::string ID("plane");
54 return ID;
55 }
57 inline static const std::string& ADD_DIMENSIONS_ID()
58 {
59 static const std::string ID("add_dimensions");
60 return ID;
61 }
62
64 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
65 {
66 static std::string MY_KIND = SketchPlugin_SketchDrawer::ID();
67 return MY_KIND;
68 }
69
71 SKETCHPLUGIN_EXPORT virtual void execute();
72
74 SKETCHPLUGIN_EXPORT virtual void initAttributes();
75
78 SKETCHPLUGIN_EXPORT virtual bool isMacro() const {return true;}
79
81 SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const {return false;}
82};
83
84#endif
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:41
Feature for creation of a sketch on selected base object and plane.
Definition: SketchPlugin_SketchDrawer.h:32
virtual bool isMacro() const
Reimplemented from ModelAPI_Feature::isMacro().
Definition: SketchPlugin_SketchDrawer.h:78
virtual void execute()
Creates a new sketch.
Definition: SketchPlugin_SketchDrawer.cpp:73
virtual const std::string & getKind()
Definition: SketchPlugin_SketchDrawer.h:64
static const std::string & PLANE_ID()
Attribute name of the plane selected.
Definition: SketchPlugin_SketchDrawer.h:51
virtual bool isPreviewNeeded() const
No preview is generated until it is applied.
Definition: SketchPlugin_SketchDrawer.h:81
SketchPlugin_SketchDrawer()
A constructor.
Definition: SketchPlugin_SketchDrawer.cpp:52
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: SketchPlugin_SketchDrawer.cpp:55
static const std::string & ID()
Feature kind.
Definition: SketchPlugin_SketchDrawer.h:38
static const std::string & BASE_ID()
Attribute name of the base shape selected.
Definition: SketchPlugin_SketchDrawer.h:45
static const std::string & ADD_DIMENSIONS_ID()
Attribute name of the add-dimensions flag.
Definition: SketchPlugin_SketchDrawer.h:57