1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: FeaturesAPI_Translation.h
4 // Created: 07 June 2016
5 // Author: Dmitry Bobylev
7 #ifndef FeaturesAPI_Translation_H_
8 #define FeaturesAPI_Translation_H_
10 #include "FeaturesAPI.h"
12 #include <FeaturesPlugin_Translation.h>
14 #include <ModelHighAPI_Interface.h>
15 #include <ModelHighAPI_Macro.h>
17 class ModelHighAPI_Double;
18 class ModelHighAPI_Dumper;
19 class ModelHighAPI_Selection;
21 /// \class FeaturesAPI_Translation
22 /// \ingroup CPPHighAPI
23 /// \brief Interface for Translation feature.
24 class FeaturesAPI_Translation: public ModelHighAPI_Interface
27 /// Constructor without values.
29 explicit FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature);
31 /// Constructor with values.
33 FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature,
34 const std::list<ModelHighAPI_Selection>& theMainObjects,
35 const ModelHighAPI_Selection& theAxisObject,
36 const ModelHighAPI_Double& theDistance);
40 virtual ~FeaturesAPI_Translation();
42 INTERFACE_3(FeaturesPlugin_Translation::ID(),
43 mainObjects, FeaturesPlugin_Translation::OBJECTS_LIST_ID(),
44 ModelAPI_AttributeSelectionList, /** Main objects */,
45 axisObject, FeaturesPlugin_Translation::AXIS_OBJECT_ID(),
46 ModelAPI_AttributeSelection, /** Axis object */,
47 distance, FeaturesPlugin_Translation::DISTANCE_ID(),
48 ModelAPI_AttributeDouble, /** Distance */)
52 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
56 void setAxisObject(const ModelHighAPI_Selection& theAxisObject);
60 void setDistance(const ModelHighAPI_Double& theDistance);
62 /// Dump wrapped feature
64 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
67 /// Pointer on Translation object.
68 typedef std::shared_ptr<FeaturesAPI_Translation> TranslationPtr;
70 /// \ingroup CPPHighAPI
71 /// \brief Create Translation feature.
73 TranslationPtr addTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
74 const std::list<ModelHighAPI_Selection>& theMainObjects,
75 const ModelHighAPI_Selection& theAxisObject,
76 const ModelHighAPI_Double& theDistance);
78 #endif // FeaturesAPI_Translation_H_