Model_AttributeSelection.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 Model_AttributeSelection_H_
#define Model_AttributeSelection_H_
 
#include "Model.h"
#include "Model_AttributeReference.h"
#include <ModelAPI_AttributeSelection.h>
#include <Selector_NameGenerator.h>
#include <TDF_LabelMap.hxx>
#include <TopoDS_Shape.hxx>
#include <TopTools_ListOfShape.hxx>
 
class Model_AttributeSelectionList;
class Model_Document;
 
class Model_AttributeSelection : public ModelAPI_AttributeSelection,
                                 public Selector_NameGenerator
{
  Model_AttributeReference myRef;  
  ObjectPtr myTmpContext;
  std::shared_ptr<GeomAPI_Shape> myTmpSubShape;
  CenterType myTmpCenterType;
  Model_AttributeSelectionList* myParent;
 
  std::shared_ptr<Model_Document> myRestoreDocument;
  bool myIsGeometricalSelection;
 
public:
  MODEL_EXPORT virtual bool setValue(
    const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
    const bool theTemporarily = false);
 
  MODEL_EXPORT virtual void setValueCenter(
    const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Edge>& theEdge,
    const CenterType theCenterType,
    const bool theTemporarily = false);
 
  MODEL_EXPORT virtual void selectValue(
    const std::shared_ptr<ModelAPI_AttributeSelection>& theSource);
 
  virtual void removeTemporaryValues();
 
  MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
 
  MODEL_EXPORT virtual ResultPtr context();
 
  MODEL_EXPORT virtual FeaturePtr contextFeature();
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> contextObject();
 
  MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
 
  MODEL_EXPORT virtual bool update();
 
  MODEL_EXPORT virtual std::wstring namingName(const std::wstring& theDefaultValue = L"");
 
  MODEL_EXPORT virtual void setId(int theID);
 
  MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
                                           const std::wstring& theSubShapeName);
 
  MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
                                           const std::shared_ptr<GeomAPI_Pnt>& thePoint,
                                           const bool theIsIgnoreGroups = false);
  MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
    const std::wstring& theContextName, const int theIndex);
 
  MODEL_EXPORT virtual bool isInitialized();
 
  MODEL_EXPORT virtual bool isInvalid();
 
  MODEL_EXPORT virtual void updateInHistory(bool& theRemove) override;
 
  // Implementation of the name generator method from the Selector package
  // This method returns the context name by the label of the sub-selected shape
  MODEL_EXPORT virtual std::wstring contextName(const TDF_Label theSelectionLab) override;
 
  MODEL_EXPORT virtual bool restoreContext(std::wstring theName,
    TDF_Label& theContext, TDF_Label& theValue) override;
 
  MODEL_EXPORT virtual bool isLater(const TDF_Label theResult1, const TDF_Label theResult2)
    const override;
 
  MODEL_EXPORT virtual std::wstring contextName(const ResultPtr& theContext) const;
 
  MODEL_EXPORT virtual void combineGeometrical();
 
  MODEL_EXPORT virtual void reset();
 
protected:
  MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
 
  std::shared_ptr<GeomAPI_Shape> internalValue(CenterType& theType);
 
  virtual void selectBody(
    const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
 
  virtual bool selectPart(
    const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
    const bool theUpdate = false);
 
  TDF_Label selectionLabel();
 
  MODEL_EXPORT virtual void setID(const std::string theID);
 
  void setParent(Model_AttributeSelectionList* theParent);
 
  void split(ResultPtr theContext, TopoDS_Shape theNewShape, TopAbs_ShapeEnum theType);
 
  bool searchNewContext(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape theContShape,
                        ResultPtr theContext, TopoDS_Shape theValShape, TDF_Label theAccessLabel,
                        std::list<ResultPtr>& theResults, TopTools_ListOfShape& theValShapes);
 
  ResultPtr newestContext(
    const ResultPtr theCurrent, const std::shared_ptr<GeomAPI_Shape> theValue);
 
  void computeValues(ResultPtr theOldContext, ResultPtr theNewContext, TopoDS_Shape theValShape,
    TopTools_ListOfShape& theShapes);
 
  virtual bool isGeometricalSelection() const {
    return myIsGeometricalSelection;
  };
 
  TDF_Label baseDocumentLab();
 
  void concealedFeature(
    const FeaturePtr theFeature, const FeaturePtr theStop, const bool theCheckCopy,
    std::list<FeaturePtr>& theConcealers, const ResultPtr theResultOfFeature,
    const bool theCheckWholeFeature = false);
 
  friend class Model_Data;
  friend class Model_AttributeSelectionList;
};
 
#endif