1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef FeaturesAPI_Placement_H_
22 #define FeaturesAPI_Placement_H_
24 #include "FeaturesAPI.h"
26 #include <FeaturesPlugin_Placement.h>
28 #include <ModelHighAPI_Interface.h>
29 #include <ModelHighAPI_Macro.h>
31 class ModelHighAPI_Dumper;
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_Placement
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for Placement feature.
37 class FeaturesAPI_Placement: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
46 FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47 const std::list<ModelHighAPI_Selection>& theObjects,
48 const ModelHighAPI_Selection& theStartShape,
49 const ModelHighAPI_Selection& theEndShape,
50 const bool theReverseDirection = false,
51 const bool theCentering = false);
55 virtual ~FeaturesAPI_Placement();
57 INTERFACE_5(FeaturesPlugin_Placement::ID(),
58 objects, FeaturesPlugin_Placement::OBJECTS_LIST_ID(),
59 ModelAPI_AttributeSelectionList, /** Main objects */,
60 startShape, FeaturesPlugin_Placement::START_SHAPE_ID(),
61 ModelAPI_AttributeSelection, /** Start shape */,
62 endShape, FeaturesPlugin_Placement::END_SHAPE_ID(),
63 ModelAPI_AttributeSelection, /** End shape */,
64 reverseDirection, FeaturesPlugin_Placement::REVERSE_ID(),
65 ModelAPI_AttributeBoolean, /** Reverse direction flag */,
66 centering, FeaturesPlugin_Placement::CENTERING_ID(),
67 ModelAPI_AttributeBoolean, /** Centering flag */)
71 void setObjects(const std::list<ModelHighAPI_Selection>& theObjects);
75 void setStartShape(const ModelHighAPI_Selection& theStartShape);
79 void setEndShape(const ModelHighAPI_Selection& theEndShape);
81 /// Set reverse direction flag.
83 void setReverseDirection(const bool theReverseDirection);
85 /// Set centering flag.
87 void setCentering(const bool theCentering);
89 /// Dump wrapped feature
91 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
94 /// Pointer on Placement object.
95 typedef std::shared_ptr<FeaturesAPI_Placement> PlacementPtr;
97 /// \ingroup CPPHighAPI
98 /// \brief Create Placement feature.
100 PlacementPtr addPlacement(const std::shared_ptr<ModelAPI_Document>& thePart,
101 const std::list<ModelHighAPI_Selection>& theObjects,
102 const ModelHighAPI_Selection& theStartShape,
103 const ModelHighAPI_Selection& theEndShape,
104 const bool theReverseDirection = false,
105 const bool theCentering = false);
107 #endif // FeaturesAPI_Placement_H_