src/SketchAPI/SketchAPI_Translation.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_
  22 #define SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include "SketchAPI.h"
  26 #include "SketchAPI_SketchEntity.h"
  27
  28 #include <list>
  29
  30 #include <SketchPlugin_MultiTranslation.h>
  31
  32 #include <ModelHighAPI_Interface.h>
  33 #include <ModelHighAPI_Macro.h>
  34 //--------------------------------------------------------------------------------------
  35 class ModelAPI_Object;
  36 class ModelHighAPI_Integer;
  37 class ModelHighAPI_RefAttr;
  38 //--------------------------------------------------------------------------------------
  39 /**\class SketchAPI_Translation
  40  * \ingroup CPPHighAPI
  41  * \brief Interface for Translation feature
  42  */
  43 class SketchAPI_Translation : public ModelHighAPI_Interface
  44 {
  45 public:
  46   /// Constructor without values
  47   SKETCHAPI_EXPORT
  48   explicit SketchAPI_Translation(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  49   /// Constructor with values
  50   SKETCHAPI_EXPORT
  51   SketchAPI_Translation(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  52                         const std::list<std::shared_ptr<ModelAPI_Object> > & theObjects,
  53                         const ModelHighAPI_RefAttr & thePoint1,
  54                         const ModelHighAPI_RefAttr & thePoint2,
  55                         const ModelHighAPI_Integer & theNumberOfObjects,
  56                         bool theFullValue = false);
  57   /// Destructor
  58   SKETCHAPI_EXPORT
  59   virtual ~SketchAPI_Translation();
  60
  61   INTERFACE_7(SketchPlugin_MultiTranslation::ID(),
  62               translationList, SketchPlugin_MultiTranslation::TRANSLATION_LIST_ID(),
  63               ModelAPI_AttributeRefList, /** Translation list */,
  64               startPoint, SketchPlugin_MultiTranslation::START_POINT_ID(),
  65               ModelAPI_AttributeRefAttr, /** Start point */,
  66               endPoint, SketchPlugin_MultiTranslation::END_POINT_ID(),
  67               ModelAPI_AttributeRefAttr, /** Start point */,
  68               numberOfObjects, SketchPlugin_MultiTranslation::NUMBER_OF_OBJECTS_ID(),
  69               ModelAPI_AttributeInteger, /** Number of objects */,
  70               valueType, SketchPlugin_MultiTranslation::VALUE_TYPE(),
  71               ModelAPI_AttributeString, /** Value type */,
  72               referenceObjects, SketchPlugin_MultiTranslation::ENTITY_A(),
  73               ModelAPI_AttributeRefList, /** Reference objects */,
  74               translatedObjects, SketchPlugin_MultiTranslation::ENTITY_B(),
  75               ModelAPI_AttributeRefList, /** Translationed objects */
  76   )
  77
  78   /// List of translated objects
  79   SKETCHAPI_EXPORT
  80   std::list<std::shared_ptr<SketchAPI_SketchEntity> > translated() const;
  81
  82   /// Dump wrapped feature
  83   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  84 };
  85
  86 //! Pointer on Translation object
  87 typedef std::shared_ptr<SketchAPI_Translation> TranslationPtr;
  88
  89 //--------------------------------------------------------------------------------------
  90 //--------------------------------------------------------------------------------------
  91 #endif /* SRC_SKETCHAPI_SKETCHAPI_TRANSLATION_H_ */