src/SketchAPI/SketchAPI_Translation.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2 // Name   : SketchAPI_Translation.h
   3 // Purpose:
   4 //
   5 // History:
   6 // 16/06/16 - Sergey POKHODENKO - Creation of the file
   7
   8 #ifndef SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_
   9 #define SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_
  10
  11 //--------------------------------------------------------------------------------------
  12 #include "SketchAPI.h"
  13
  14 #include <list>
  15
  16 #include <SketchPlugin_MultiTranslation.h>
  17
  18 #include <ModelHighAPI_Interface.h>
  19 #include <ModelHighAPI_Macro.h>
  20 //--------------------------------------------------------------------------------------
  21 class ModelAPI_Object;
  22 class ModelHighAPI_Integer;
  23 class ModelHighAPI_RefAttr;
  24 //--------------------------------------------------------------------------------------
  25 /**\class SketchAPI_Translation
  26  * \ingroup CPPHighAPI
  27  * \brief Interface for Translation feature
  28  */
  29 class SketchAPI_Translation : public ModelHighAPI_Interface
  30 {
  31 public:
  32   /// Constructor without values
  33   SKETCHAPI_EXPORT
  34   explicit SketchAPI_Translation(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  35   /// Constructor with values
  36   SKETCHAPI_EXPORT
  37   SketchAPI_Translation(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  38                         const std::list<std::shared_ptr<ModelAPI_Object> > & theObjects,
  39                         const ModelHighAPI_RefAttr & thePoint1,
  40                         const ModelHighAPI_RefAttr & thePoint2,
  41                         const ModelHighAPI_Integer & theNumberOfObjects,
  42                         bool theFullValue = false);
  43   /// Destructor
  44   SKETCHAPI_EXPORT
  45   virtual ~SketchAPI_Translation();
  46
  47   INTERFACE_7(SketchPlugin_MultiTranslation::ID(),
  48               translationList, SketchPlugin_MultiTranslation::TRANSLATION_LIST_ID(),
  49               ModelAPI_AttributeRefList, /** Translation list */,
  50               startPoint, SketchPlugin_MultiTranslation::START_POINT_ID(),
  51               ModelAPI_AttributeRefAttr, /** Start point */,
  52               endPoint, SketchPlugin_MultiTranslation::END_POINT_ID(),
  53               ModelAPI_AttributeRefAttr, /** Start point */,
  54               numberOfObjects, SketchPlugin_MultiTranslation::NUMBER_OF_OBJECTS_ID(),
  55               ModelAPI_AttributeInteger, /** Number of objects */,
  56               valueType, SketchPlugin_MultiTranslation::VALUE_TYPE(),
  57               ModelAPI_AttributeString, /** Value type */,
  58               referenceObjects, SketchPlugin_MultiTranslation::ENTITY_A(),
  59               ModelAPI_AttributeRefList, /** Reference objects */,
  60               translatedObjects, SketchPlugin_MultiTranslation::ENTITY_B(),
  61               ModelAPI_AttributeRefList, /** Translationed objects */
  62   )
  63
  64   /// List of translated objects
  65   SKETCHAPI_EXPORT
  66   std::list<std::shared_ptr<ModelHighAPI_Interface> > translated() const;
  67
  68   /// Dump wrapped feature
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  70 };
  71
  72 //! Pointer on Translation object
  73 typedef std::shared_ptr<SketchAPI_Translation> TranslationPtr;
  74
  75 //--------------------------------------------------------------------------------------
  76 //--------------------------------------------------------------------------------------
  77 #endif /* SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_ */