src/ExchangePlugin/ExchangePlugin_ExportFeature.h

   1 // Copyright (C) 2014-2024  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 EXCHANGEPLUGIN_EXPORTFEATURE_H_
  21 #define EXCHANGEPLUGIN_EXPORTFEATURE_H_
  22
  23 #include <ExchangePlugin.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <ModelAPI_Result.h>
  26
  27 #include <map>
  28
  29 /**
  30  * \class ExchangePlugin_ExportFeature
  31  * \ingroup Plugins
  32  * \brief Feature for export shapes to the external files in CAD formats.
  33  *
  34  * The list of supported formats is defined in the configuration file.
  35  */
  36 class ExchangePlugin_ExportFeature : public ModelAPI_Feature
  37 {
  38 public:
  39   /// Feature kind
  40   inline static const std::string& ID()
  41   {
  42     static const std::string MY_EXPORT_ID("Export");
  43     return MY_EXPORT_ID;
  44   }
  45   /// attribute name for file format
  46   inline static const std::string& EXPORT_TYPE_ID()
  47   {
  48     static const std::string MY_EXPORT_TYPE_ID("ExportType");
  49     return MY_EXPORT_TYPE_ID;
  50   }
  51   /// attribute name of file path
  52   inline static const std::string& FILE_PATH_ID()
  53   {
  54     static const std::string MY_FILE_PATH_ID("file_path");
  55     return MY_FILE_PATH_ID;
  56   }
  57   /// attribute name of xao file path
  58   inline static const std::string& XAO_FILE_PATH_ID()
  59   {
  60     static const std::string MY_XAO_FILE_PATH_ID("xao_file_path");
  61     return MY_XAO_FILE_PATH_ID;
  62   }
  63   /// attribute name of stl file path
  64   inline static const std::string& STL_FILE_PATH_ID()
  65   {
  66     static const std::string MY_STL_FILE_PATH_ID("stl_file_path");
  67     return MY_STL_FILE_PATH_ID;
  68   }
  69   /// Attribute name for selected object to export in stl file path.
  70   inline static const std::string& STL_OBJECT_SELECTED()
  71   {
  72     static const std::string ATTR_ID("stl_object_selected");
  73     return ATTR_ID;
  74   }
  75   /// Attribute name for deflection type.
  76   inline static const std::string& STL_DEFLECTION_TYPE()
  77   {
  78     static const std::string ATTR_ID("stl_deflection_type");
  79     return ATTR_ID;
  80   }
  81   /// Attribute name for deflection type relative.
  82   inline static const std::string& STL_DEFLECTION_TYPE_RELATIVE()
  83   {
  84     static const std::string ATTR_ID("stl_deflection_type_relative");
  85     return ATTR_ID;
  86   }
  87   /// Attribute name for deflection type absolute.
  88   inline static const std::string& STL_DEFLECTION_TYPE_ABSOLUTE()
  89   {
  90     static const std::string ATTR_ID("stl_deflection_type_absolute");
  91     return ATTR_ID;
  92   }
  93   /// Attribute name for relative.
  94   inline static const std::string& STL_RELATIVE()
  95   {
  96     static const std::string ATTR_ID("stl_relative");
  97     return ATTR_ID;
  98   }
  99   /// Attribute name for absolute.
 100   inline static const std::string& STL_ABSOLUTE()
 101   {
 102     static const std::string ATTR_ID("stl_absolute");
 103     return ATTR_ID;
 104   }
 105   /// Attribute name for stl file type.
 106   inline static const std::string& STL_FILE_TYPE()
 107   {
 108     static const std::string ATTR_ID("stl_file_type");
 109     return ATTR_ID;
 110   }
 111   /// Attribute name for stl file type ascii.
 112   inline static const std::string& STL_FILE_TYPE_ASCII()
 113   {
 114     static const std::string ATTR_ID("stl_file_type_acii");
 115     return ATTR_ID;
 116   }
 117   /// Attribute name for stl file type binary.
 118   inline static const std::string& STL_FILE_TYPE_BINARY()
 119   {
 120     static const std::string ATTR_ID("stl_file_type_binary");
 121     return ATTR_ID;
 122   }
 123   /// attribute name of file format
 124   inline static const std::string& FILE_FORMAT_ID()
 125   {
 126     static const std::string MY_FILE_FORMAT_ID("file_format");
 127     return MY_FILE_FORMAT_ID;
 128   }
 129   /// attribute name of selection list
 130   inline static const std::string& SELECTION_LIST_ID()
 131   {
 132     static const std::string MY_SELECTION_LIST_ID("selection_list");
 133     return MY_SELECTION_LIST_ID;
 134   }
 135   /// attribute name of xao selection list
 136   inline static const std::string& XAO_SELECTION_LIST_ID()
 137   {
 138     static const std::string MY_SELECTION_LIST_ID("xao_selection_list");
 139     return MY_SELECTION_LIST_ID;
 140   }
 141   /// attribute name of author for XAO format
 142   inline static const std::string& XAO_AUTHOR_ID()
 143   {
 144     static const std::string MY_XAO_AUTHOR_ID("xao_author");
 145     return MY_XAO_AUTHOR_ID;
 146   }
 147   /// attribute name of geometry name for XAO format
 148   inline static const std::string& XAO_GEOMETRY_NAME_ID()
 149   {
 150     static const std::string MY_XAO_GEOMETRY_NAME_ID("xao_geometry_name");
 151     return MY_XAO_GEOMETRY_NAME_ID;
 152   }
 153   /// attribute name of xao shape file path
 154   inline static const std::string& XAO_SHAPE_FILE_PATH_ID()
 155   {
 156     static const std::string MY_XAO_SHAPE_FILE_PATH_ID("xao_shape_file_path");
 157     return MY_XAO_SHAPE_FILE_PATH_ID;
 158   }
 159   /// attribute flag to export shape in a separate file during xao export,
 160   /// name of shape file will be xao_file_path + .brep
 161   inline static const std::string& XAO_SHAPE_FILE_SEPARATE_ID()
 162   {
 163     static const std::string MY_XAO_SHAPE_FILE_SEPARATE_ID("xao_shape_file_separate");
 164     return MY_XAO_SHAPE_FILE_SEPARATE_ID;
 165   }
 166   /// attribute string memory buffer
 167   inline static const std::string& MEMORY_BUFFER_ID()
 168   {
 169     static const std::string MY_MEMORY_BUFFER_ID("memory_buffer");
 170     return MY_MEMORY_BUFFER_ID;
 171   }
 172
 173   /// Default constructor
 174   EXCHANGEPLUGIN_EXPORT ExchangePlugin_ExportFeature();
 175   /// Default destructor
 176   EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ExportFeature();
 177
 178   /// Returns the unique kind of a feature
 179   EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind()
 180   {
 181     return ExchangePlugin_ExportFeature::ID();
 182   }
 183
 184   /// Request for initialization of data model of the feature: adding all attributes
 185   EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
 186
 187   /// Reimplemented from ModelAPI_Feature::attributeChanged()
 188   EXCHANGEPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 189
 190   /// Computes or recomputes the results
 191   EXCHANGEPLUGIN_EXPORT virtual void execute();
 192
 193   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns false.
 194   // It is macro for not-XAO export. For XAO the feature is kept invisible in the tree
 195   // for the export to GEOM functionality correct working.
 196   EXCHANGEPLUGIN_EXPORT virtual bool isMacro() const;
 197
 198   /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
 199   EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
 200
 201   /// Do not put in history.
 202   /// Since it is not a macro, it is not deleted, but we don't want to see it.
 203   bool isInHistory()  { return false; }
 204
 205 protected:
 206   /// Performs export of the file
 207   EXCHANGEPLUGIN_EXPORT void exportFile(const std::string& theFileName,
 208                                         const std::string& theFormat,
 209                                         const bool         isMemoryExport);
 210
 211   /// Performs export to XAO file
 212   EXCHANGEPLUGIN_EXPORT void exportXAO(const std::string& theFileName,
 213                                        const bool         isMemoryExport);
 214
 215   /// Performs export to STL file
 216   EXCHANGEPLUGIN_EXPORT void exportSTL(const std::string& theFileName);
 217 };
 218
 219 #endif /* EXPORT_EXPORTFEATURE_H_ */