ModelHighAPI_Selection.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 SRC_MODELHIGHAPI_MODELHIGHAPI_SELECTION_H_
#define SRC_MODELHIGHAPI_MODELHIGHAPI_SELECTION_H_
 
//--------------------------------------------------------------------------------------
#include "ModelHighAPI.h"
 
#include <list>
#include <memory>
#include <string>
#include <utility>
//--------------------------------------------------------------------------------------
class GeomAPI_Pnt;
class GeomAPI_Shape;
class ModelAPI_AttributeSelection;
class ModelAPI_AttributeSelectionList;
class ModelAPI_FiltersFeature;
class ModelAPI_Result;
//--------------------------------------------------------------------------------------
typedef std::pair<std::shared_ptr<ModelAPI_Result>, std::shared_ptr<GeomAPI_Shape> >
  ResultSubShapePair;
typedef std::pair<std::string, std::wstring> TypeSubShapeNamePair;
typedef std::pair<std::string, std::shared_ptr<GeomAPI_Pnt> > TypeInnerPointPair;
typedef std::pair<std::string, std::pair<std::wstring, int> > TypeWeakNamingPair;
//--------------------------------------------------------------------------------------
class ModelHighAPI_Selection
{
public:
  enum VariantType {
    VT_Empty,
    VT_ResultSubShapePair,
    VT_TypeSubShapeNamePair,
    VT_TypeInnerPointPair,
    VT_WeakNamingPair,
    VT_Filtering
  };
 
public:
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection();
 
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection(const std::shared_ptr<ModelAPI_Result>& theContext,
                         const std::shared_ptr<GeomAPI_Shape>& theSubShape =
                         std::shared_ptr<GeomAPI_Shape>());
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection(const std::string& theType,
                         const std::wstring& theSubShapeName);
 
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection(const std::string& theType,
                         const std::shared_ptr<GeomAPI_Pnt>& theSubShapeInnerPoint);
 
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection(const std::string& theType,
                         const std::list<double>& theSubShapeInnerPoint);
 
 
  MODELHIGHAPI_EXPORT
    ModelHighAPI_Selection(const std::string& theType,
      const std::wstring& theContextName, const int theIndex);
 
  MODELHIGHAPI_EXPORT
  virtual ~ModelHighAPI_Selection();
 
  MODELHIGHAPI_EXPORT virtual
    void fillAttribute(const std::shared_ptr<ModelAPI_AttributeSelection> & theAttribute) const;
 
  MODELHIGHAPI_EXPORT virtual
    void appendToList(const std::shared_ptr<ModelAPI_AttributeSelectionList> & theAttribute, const bool theIsIgnoreGroups = false) const;
 
  MODELHIGHAPI_EXPORT
  virtual VariantType variantType() const;
 
  MODELHIGHAPI_EXPORT
  virtual ResultSubShapePair resultSubShapePair() const;
 
  MODELHIGHAPI_EXPORT
  virtual TypeSubShapeNamePair typeSubShapeNamePair() const;
 
  MODELHIGHAPI_EXPORT
  virtual TypeInnerPointPair typeInnerPointPair() const;
 
  MODELHIGHAPI_EXPORT
    virtual TypeWeakNamingPair typeWeakNamingPair() const;
 
  MODELHIGHAPI_EXPORT
  virtual std::string shapeType() const;
 
  MODELHIGHAPI_EXPORT
  void setName(const std::wstring& theName);
 
  MODELHIGHAPI_EXPORT
  std::wstring name() const;
 
  MODELHIGHAPI_EXPORT
  void setColor(int theRed = 0, int theGreen = 0, int theBlue = 0, bool random = false);
 
  MODELHIGHAPI_EXPORT
  void setSubShapeColor(const ModelHighAPI_Selection& theShape,
                        int theRed, int theGreen, int theBlue);
 
  MODELHIGHAPI_EXPORT
  std::list<int> getSubShapeColor(const ModelHighAPI_Selection& theShape);
 
  MODELHIGHAPI_EXPORT
  void setDeflection(double theValue);
 
  MODELHIGHAPI_EXPORT
  void setTransparency(double theValue);
 
  MODELHIGHAPI_EXPORT
  int numberOfSubs() const;
 
  MODELHIGHAPI_EXPORT
  ModelHighAPI_Selection subResult(int theIndex) const;
 
private:
  MODELHIGHAPI_EXPORT
    std::wstring changePartName(const ModelHighAPI_Selection& theShape, const std::wstring& theName);
 
protected:
  VariantType myVariantType;
  ResultSubShapePair myResultSubShapePair;
  TypeSubShapeNamePair myTypeSubShapeNamePair;
  TypeInnerPointPair myTypeInnerPointPair;
  TypeWeakNamingPair myWeakNamingPair;
  std::shared_ptr<ModelAPI_FiltersFeature> myFilterFeature;
};
 
//--------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------
#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_SELECTION_H_ */