Selector_Algo.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 Selector_Algo_H_
#define Selector_Algo_H_
 
#include "Selector.h"
 
#include <Standard_GUID.hxx>
#include <TDF_Label.hxx>
#include <TDF_LabelList.hxx>
#include <TopoDS_Shape.hxx>
 
class Selector_NameGenerator;
 
class Selector_Algo
{
  TopAbs_ShapeEnum myShapeType; 
 
  TDF_Label myLab; 
  TDF_Label myBaseDocumentLab; 
  bool myGeometricalNaming; 
  bool myAlwaysGeometricalNaming; 
  bool myUseNeighbors; 
  bool myUseIntersections; 
 
public:
  enum Selector_Type {
    SELTYPE_CONTAINER, 
    SELTYPE_INTERSECT, 
    SELTYPE_PRIMITIVE, 
    SELTYPE_MODIFICATION, 
    SELTYPE_FILTER_BY_NEIGHBOR,  
    SELTYPE_WEAK_NAMING, 
  };
 
  SELECTOR_EXPORT Selector_Algo();
 
  virtual ~Selector_Algo() {}
 
  SELECTOR_EXPORT static Selector_Algo* select(
    const TopoDS_Shape theContext, const TopoDS_Shape theValue,
    const TDF_Label theAccess, const TDF_Label theBaseDocument,
    const bool theGeometricalNaming = false,
    const bool theUseNeighbors = true, const bool theUseIntersections = true,
    const bool theAlwaysGeometricalNaming = false);
 
  SELECTOR_EXPORT virtual void store() = 0;
 
  SELECTOR_EXPORT virtual bool restore() = 0;
 
  SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
    const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) = 0;
 
  SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) = 0;
 
  SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) = 0;
  SELECTOR_EXPORT TopoDS_Shape value();
  SELECTOR_EXPORT static Selector_Algo* restoreByLab(TDF_Label theLab, TDF_Label theBaseDocLab);
  SELECTOR_EXPORT static Selector_Algo* restoreByName(
    TDF_Label theLab, TDF_Label theBaseDocLab, std::wstring theName,
    const TopAbs_ShapeEnum theShapeType, const bool theGeomNaming,
    Selector_NameGenerator* theNameGenerator, TDF_Label& theContextLab);
 
  static bool sameGeometry(const TopoDS_Shape theShape1, const TopoDS_Shape theShape2);
 
  SELECTOR_EXPORT static Selector_Algo* relesectWithAllGeometry(
    Selector_Algo* theOldAlgo, const TopoDS_Shape theContext);
  void setGeometricalNaming()
  {myGeometricalNaming = true;}
 
protected:
  const TDF_Label& label() const
  {return myLab;}
  void storeBaseArray(const TDF_LabelList& theRef, const TDF_Label& theLast);
  bool restoreBaseArray(TDF_LabelList& theRef, TDF_Label& theLast);
  void store(const TopoDS_Shape theShape);
  const TDF_Label& baseDocument() const
  {return myBaseDocumentLab;}
  bool geometricalNaming() const
  {return myGeometricalNaming;}
  bool alwaysGeometricalNaming() const
  {return myAlwaysGeometricalNaming;}
  bool useNeighbors() const
  {return myUseNeighbors;}
  bool useIntersections() const
  {return myUseIntersections;}
  static const Standard_GUID& weakID()
  {
    static const Standard_GUID kWEAK_INDEX("e9373a61-cabc-4ee8-aabf-aea47c62ed87");
    return kWEAK_INDEX;
  }
  static const Standard_GUID& shapeTypeID()
  {
    static const Standard_GUID kSHAPE_TYPE("864b3267-cb9d-4107-bf58-c3ce1775b171");
    return kSHAPE_TYPE;
  }
  static const std::wstring& oldWeakNameID()
  {
    static const std::wstring kWEAK_NAME_IDENTIFIER = L"weak_name_";
    return kWEAK_NAME_IDENTIFIER;
  }
  static const std::wstring& oldPureWeakNameID()
  {
    static const std::wstring kPURE_WEAK_NAME_IDENTIFIER = L"_weak_name_";
    return kPURE_WEAK_NAME_IDENTIFIER;
  }
  static const std::wstring& weakNameID()
  {
    static const std::wstring kWEAK_NAME_IDENTIFIER = std::wstring(L"new_") + oldWeakNameID();
    return kWEAK_NAME_IDENTIFIER;
  }
  static const std::wstring& pureWeakNameID()
  {
    static const std::wstring kPURE_WEAK_NAME_IDENTIFIER =
        std::wstring(L"_new") + oldPureWeakNameID();
    return kPURE_WEAK_NAME_IDENTIFIER;
  }
  void storeType(const Selector_Type theType);
 
  bool findNewVersion(const TopoDS_Shape& theContext, TopoDS_Shape& theResult) const;
};
 
#endif