ExchangePlugin_ImportFeature.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef EXCHANGEPLUGIN_IMPORTFEATURE_H_
#define EXCHANGEPLUGIN_IMPORTFEATURE_H_
 
#include "ExchangePlugin.h"
 
#include <ModelAPI_CompositeFeature.h>
#include <ModelAPI_Result.h>
#include <GeomAPI_Shape.h>
 
#include <map>
 
class ExchangePlugin_ImportFeatureBase : public ModelAPI_CompositeFeature
{
public:
  inline static const std::string& FILE_PATH_ID()
  {
    static const std::string MY_FILE_PATH_ID("file_path");
    return MY_FILE_PATH_ID;
  }
  inline static const std::string& FEATURES_ID()
  {
    static const std::string MY_FEATURES_ID("Features");
    return MY_FEATURES_ID;
  }
  inline static const std::string& TARGET_PART_ID()
  {
    static const std::string MY_TARGET_PART_ID("target_part");
    return MY_TARGET_PART_ID;
  }
  EXCHANGEPLUGIN_EXPORT ExchangePlugin_ImportFeatureBase() = default;
  EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ImportFeatureBase() = default;
 
  EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind() = 0;
 
  EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
 
  EXCHANGEPLUGIN_EXPORT virtual void execute() = 0;
 
  EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
 
  virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
 
  virtual int numberOfSubs(bool forTree = false) const;
 
  virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
 
  virtual int subFeatureId(const int theIndex) const;
 
  virtual bool isSub(ObjectPtr theObject) const;
 
  virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
 
 protected:
  EXCHANGEPLUGIN_EXPORT virtual void importFile(const std::string& theFileName) = 0;
 
  std::shared_ptr<ModelAPI_ResultBody> createResultBody(
      std::shared_ptr<GeomAPI_Shape> aGeomShape);
 
  void loadNamingDS(std::shared_ptr<GeomAPI_Shape> theGeomShape,
                    std::shared_ptr<ModelAPI_ResultBody> theResultBody);
};
 
class ExchangePlugin_ImportFeature : public ExchangePlugin_ImportFeatureBase
{
public:
  inline static const std::string& ID()
  {
    static const std::string MY_IMPORT_ID("Import");
    return MY_IMPORT_ID;
  }
  inline static const std::string& IMPORT_TYPE_ID()
  {
    static const std::string MY_IMPORT_TYPE_ID("ImportType");
    return MY_IMPORT_TYPE_ID;
  }
  inline static const std::string& STEP_FILE_PATH_ID()
  {
    static const std::string MY_STEP_FILE_PATH_ID("step_file_path");
    return MY_STEP_FILE_PATH_ID;
  }
 
  EXCHANGEPLUGIN_EXPORT ExchangePlugin_ImportFeature() = default;
  EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ImportFeature() = default;
 
  inline static const std::string& STEP_SCALE_INTER_UNITS_ID()
  {
    static const std::string MY_STEP_SCALE_INTER_UNITS_ID("step_scale_inter_units");
    return MY_STEP_SCALE_INTER_UNITS_ID;
  }
  inline static const std::string& STEP_MATERIALS_ID()
  {
    static const std::string MY_STEP_MATERIALS_ID("step_materials");
    return MY_STEP_MATERIALS_ID;
  }
  inline static const std::string& STEP_COLORS_ID()
  {
    static const std::string MY_STEP_COLORS_ID("step_colors");
    return MY_STEP_COLORS_ID;
  }
  inline static const std::string& MEMORY_BUFFER_ID()
  {
    static const std::string MY_MEMORY_BUFFER_ID("memory_buffer");
    return MY_MEMORY_BUFFER_ID;
  }
  EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind() override
  {
    return ExchangePlugin_ImportFeature::ID();
  }
 
  EXCHANGEPLUGIN_EXPORT virtual void execute() override;
 
  EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
 
  EXCHANGEPLUGIN_EXPORT virtual bool isEditable();
 
protected:
  EXCHANGEPLUGIN_EXPORT void importFile(const std::string& theFileName) override;
 
  EXCHANGEPLUGIN_EXPORT void importXAO(const std::string& theFileName,
                                       const std::string& theMemoryBuff = std::string(),
                                       const bool         isMemoryImport = false);
 
private:
  void setColorGroups(std::shared_ptr<ModelAPI_ResultBody> theResultBody);
 
  void setColorGroup(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
                     std::vector<int>& theColor,
                     const std::wstring& theName );
 
  void setMaterielGroup(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
                        std::map< std::wstring, std::list<std::wstring>>& theMaterialShape);
 
};
 
class ExchangePlugin_Import_ImageFeature : public ExchangePlugin_ImportFeatureBase
{
 public:
  inline static const std::string& ID()
  {
    static const std::string MY_IMPORT_ID("ImportImage");
    return MY_IMPORT_ID;
  }
 
  EXCHANGEPLUGIN_EXPORT ExchangePlugin_Import_ImageFeature() = default;
  EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_Import_ImageFeature() = default;
 
  EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind() override
  {
    return ExchangePlugin_Import_ImageFeature::ID();
  }
 
  EXCHANGEPLUGIN_EXPORT virtual void execute() override;
 
protected:
  EXCHANGEPLUGIN_EXPORT void importFile(const std::string& theFileName) override;
 
};
#endif /* IMPORT_IMPORTFEATURE_H_ */