ModelAPI_AttributeSelection.h

// Copyright (C) 2014-2025  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 ModelAPI_AttributeSelection_H_
#define ModelAPI_AttributeSelection_H_
 
#include "ModelAPI_Attribute.h"
#include <ModelAPI_Result.h>
 
class GeomAPI_Edge;
class GeomAPI_Pnt;
 
class ModelAPI_AttributeSelection : public ModelAPI_Attribute
{
 public:
   enum CenterType {
     NOT_CENTER, 
     CIRCLE_CENTER, 
     ELLIPSE_FIRST_FOCUS, 
     ELLIPSE_SECOND_FOCUS, 
   };
 
  virtual bool setValue(
    const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
    const bool theTemporarily = false) = 0;
 
  virtual void setValueCenter(
    const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Edge>& theEdge,
    const CenterType theCenterType,
    const bool theTemporarily = false) = 0;
 
  virtual void selectValue(
    const std::shared_ptr<ModelAPI_AttributeSelection>& theSource) = 0;
 
  virtual void removeTemporaryValues() = 0;
 
  virtual std::shared_ptr<GeomAPI_Shape> value() = 0;
 
  virtual ResultPtr context() = 0;
 
  virtual std::shared_ptr<ModelAPI_Feature> contextFeature() = 0;
  virtual std::shared_ptr<ModelAPI_Object> contextObject() = 0;
 
  virtual bool update() = 0;
 
  static std::string typeId()
  {
    return "Selection";
  }
 
  MODELAPI_EXPORT virtual std::string attributeType();
 
  virtual std::wstring namingName(const std::wstring& theDefaultValue = L"") = 0;
 
  virtual void setId(int theID) = 0;
 
  virtual void selectSubShape(const std::string& theType, const std::wstring& theSubShapeName) = 0;
 
  virtual void selectSubShape(const std::string& theType,
                              const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
 
  virtual void selectSubShape(const std::string& theType,
    const std::wstring& theContextName, const int theIndex) = 0;
 
  virtual bool isInvalid() = 0;
 
  virtual bool isGeometricalSelection() const = 0;
 
  MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelection();
 
  MODELAPI_EXPORT virtual std::wstring contextName(const ResultPtr& theContext) const = 0;
 
  MODELAPI_EXPORT virtual void combineGeometrical() = 0;
 
  MODELAPI_EXPORT virtual void updateInHistory(bool& theRemove) = 0;
 
 protected:
  MODELAPI_EXPORT ModelAPI_AttributeSelection();
};
 
typedef std::shared_ptr<ModelAPI_AttributeSelection> AttributeSelectionPtr;
 
#endif