SHAPER  9.15.0
BuildAPI_Polyline.h
1 // Copyright (C) 2014-2025 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 BuildAPI_Polyline_H_
21 #define BuildAPI_Polyline_H_
22 
23 #include "BuildAPI.h"
24 
25 #include <BuildPlugin_Polyline.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 
31 
36 {
37 public:
39  BUILDAPI_EXPORT
40  explicit BuildAPI_Polyline(const std::shared_ptr<ModelAPI_Feature>& theFeature);
41 
43  BUILDAPI_EXPORT
44  explicit BuildAPI_Polyline(const std::shared_ptr<ModelAPI_Feature>& theFeature,
45  const std::list<ModelHighAPI_Selection>& theBaseObjects,
46  const bool theIsClosed);
47 
49  BUILDAPI_EXPORT
50  virtual ~BuildAPI_Polyline();
51 
52  INTERFACE_2(BuildPlugin_Polyline::ID(),
57 
58 
59  BUILDAPI_EXPORT
60  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
61 
63  BUILDAPI_EXPORT void setClosed(const bool theIsClosed);
64 
66  BUILDAPI_EXPORT
67  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
68 };
69 
71 typedef std::shared_ptr<BuildAPI_Polyline> PolylinePtr;
72 
75 BUILDAPI_EXPORT
76 PolylinePtr addPolyline3D(const std::shared_ptr<ModelAPI_Document>& thePart,
77  const std::list<ModelHighAPI_Selection>& theBaseObjects,
78  const bool theIsClosed = false);
79 
80 #endif // BuildAPI_Polyline_H_
Interface for Polyline feature.
Definition: BuildAPI_Polyline.h:36
void setBase(const std::list< ModelHighAPI_Selection > &theBaseObjects)
Modify base attribute of the feature.
Definition: BuildAPI_Polyline.cpp:51
virtual ~BuildAPI_Polyline()
Destructor.
Definition: BuildAPI_Polyline.cpp:45
void setClosed(const bool theIsClosed)
Set closed flag.
Definition: BuildAPI_Polyline.cpp:59
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > baseObjects() const
Base objects.
Definition: BuildAPI_Polyline.h:56
virtual std::shared_ptr< ModelAPI_AttributeBoolean > closed() const
Closed flag.
Definition: BuildAPI_Polyline.h:56
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: BuildAPI_Polyline.cpp:65
BuildAPI_Polyline(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: BuildAPI_Polyline.cpp:26
static const std::string & CLOSED_ID()
Attribute name of closed flag.
Definition: BuildPlugin_Polyline.h:51
static const std::string & ID()
Feature kind.
Definition: BuildPlugin_Polyline.h:37
static const std::string & BASE_OBJECTS_ID()
Attribute name of base objects.
Definition: BuildPlugin_Polyline.h:44
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:53
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:46
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
PolylinePtr addPolyline3D(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const bool theIsClosed=false)
Create Polyline feature.
Definition: BuildAPI_Polyline.cpp:76