GEOMImpl_IShapesOperations.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// 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
//
 
//=============================================================================
// File      : GEOMImpl_IShapesOperations.hxx
// Created   :
// Author    : modified by Lioka RAZAFINDRAZAKA (CEA) 22/06/2007
// Project   : SALOME
//=============================================================================
 
#ifndef _GEOMImpl_IShapesOperations_HXX_
#define _GEOMImpl_IShapesOperations_HXX_
 
#include "GEOM_IOperations.hxx"
 
#include "GEOMAlgo_State.hxx"
#include "GEOMUtils.hxx"
 
#include <TColStd_HSequenceOfTransient.hxx>
#include <TColStd_HSequenceOfInteger.hxx>
#include <TColStd_HArray1OfInteger.hxx>
 
#include <Geom_Surface.hxx>
 
#include <list>
#include <vector>
 
class GEOM_Engine;
class GEOM_Object;
class TopoDS_Shape;
 
class GEOMImpl_IShapesOperations : public GEOM_IOperations
{
 public:
 
  enum SubShapeType {
    None      = 0x00,
    Groups    = 0x01,
    Fields    = 0x02,
    SubShapes = 0x04,
    All       = Groups | Fields | SubShapes,
  };
 
  enum ExtractionStatType
  {
    EST_Removed,  
    EST_Modified, 
    EST_Added     
  };
 
  struct ExtractionStat
  {
    ExtractionStatType          type;    
    std::list<Standard_Integer> indices; 
  };
 
  Standard_EXPORT GEOMImpl_IShapesOperations(GEOM_Engine* theEngine);
  Standard_EXPORT ~GEOMImpl_IShapesOperations();
 
  Standard_EXPORT Handle(GEOM_Object) MakeEdge (Handle(GEOM_Object) thePoint1,
                                                Handle(GEOM_Object) thePoint2);
 
  Standard_EXPORT Handle(GEOM_Object) MakeEdgeOnCurveByLength (Handle(GEOM_Object) theCurve,
                                                               const Standard_Real theLength,
                                                               Handle(GEOM_Object) theStartPoint);
 
  Standard_EXPORT Handle(GEOM_Object) MakeEdgeWire (Handle(GEOM_Object) theWire,
                                                    const Standard_Real theLinearTolerance,
                                                    const Standard_Real theAngularTolerance);
 
  Standard_EXPORT Handle(GEOM_Object) MakeWire (std::list<Handle(GEOM_Object)> theEdgesAndWires,
                                                const Standard_Real            theTolerance);
 
  Standard_EXPORT Handle(GEOM_Object) MakeFace (Handle(GEOM_Object) theWire, const bool isPlanarWanted);
 
  Standard_EXPORT Handle(GEOM_Object) MakeFaceWires (std::list<Handle(GEOM_Object)> theWires,
                                                     const bool isPlanarWanted);
 
  Standard_EXPORT Handle(GEOM_Object) MakeFaceFromSurface
                                              (Handle(GEOM_Object) theFace,
                                               Handle(GEOM_Object) theWire);
                                               
  Standard_EXPORT Handle(GEOM_Object) MakeFaceWithConstraints (std::list<Handle(GEOM_Object)> theConstraints);
 
  Standard_EXPORT Handle(GEOM_Object) MakeShell (std::list<Handle(GEOM_Object)> theShapes);
 
  Standard_EXPORT Handle(GEOM_Object) MakeSolidShells (std::list<Handle(GEOM_Object)> theShells);
 
  Standard_EXPORT Handle(GEOM_Object) MakeCompound (std::list<Handle(GEOM_Object)> theShapes);
 
  Standard_EXPORT Handle(GEOM_Object) MakeSolidFromConnectedFaces (std::list<Handle(GEOM_Object)> theFacesOrShells,
                                                                   const Standard_Boolean isIntersect);
 
  Standard_EXPORT Handle(GEOM_Object) MakeGlueFaces (std::list< Handle(GEOM_Object) >& theShapes,
                                                     const Standard_Real theTolerance,
                                                     const Standard_Boolean doKeepNonSolids);
 
  Standard_EXPORT Handle(GEOM_Object) MakeGlueFacesByList (std::list< Handle(GEOM_Object) >& theShapes,
                                                           const Standard_Real theTolerance,
                                                           std::list<Handle(GEOM_Object)>& theFaces,
                                                           const Standard_Boolean doKeepNonSolids,
                                                           const Standard_Boolean doGlueAllEdges);
 
  Standard_EXPORT Handle(GEOM_Object) MakeGlueEdges (std::list< Handle(GEOM_Object) >& theShapes,
                                                     const Standard_Real theTolerance);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetGlueShapes (std::list< Handle(GEOM_Object) >& theShapes,
                                                                      const Standard_Real theTolerance,
                                                                      const TopAbs_ShapeEnum theType);
 
  Standard_EXPORT Handle(GEOM_Object) MakeGlueEdgesByList (std::list< Handle(GEOM_Object) >& theShapes,
                                                           const Standard_Real theTolerance,
                                                           std::list<Handle(GEOM_Object)> & theEdges);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetExistingSubObjects(Handle(GEOM_Object)    theShape,
                                                                             const Standard_Boolean theGroupsOnly);
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetExistingSubObjects(Handle(GEOM_Object)    theShape,
                                                                             const Standard_Integer theTypes = All);
  
  enum ExplodeType {
    EXPLODE_OLD_INCLUDE_MAIN,
    EXPLODE_NEW_INCLUDE_MAIN,
    EXPLODE_NEW_EXCLUDE_MAIN
  };
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) MakeExplode
    (Handle(GEOM_Object)    theShape,
     const Standard_Integer theShapeType,
     const Standard_Boolean isSorted,
     const ExplodeType      theExplodeType = EXPLODE_NEW_INCLUDE_MAIN);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger) SubShapeAllIDs
    (Handle(GEOM_Object)    theShape,
     const Standard_Integer theShapeType,
     const Standard_Boolean isSorted,
     const ExplodeType      theExplodeType = EXPLODE_NEW_INCLUDE_MAIN);
 
  Standard_EXPORT Handle(GEOM_Object) GetSubShape (Handle(GEOM_Object)    theMainShape,
                                                   const Standard_Integer theID);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) MakeSubShapes
    (Handle(GEOM_Object)              theMainShape,
     Handle(TColStd_HArray1OfInteger) theIndices);
 
  Standard_EXPORT Standard_Integer GetSubShapeIndex (Handle(GEOM_Object) theMainShape,
                                                     Handle(GEOM_Object) theSubShape);
  
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetSubShapesIndices (Handle(GEOM_Object) theMainShape,
                                                                          std::list<Handle(GEOM_Object)> theSubShapes);
 
  Standard_EXPORT Standard_Integer GetTopologyIndex (Handle(GEOM_Object) theMainShape,
                                                     Handle(GEOM_Object) theSubShape);
 
  Standard_EXPORT TCollection_AsciiString GetShapeTypeString (Handle(GEOM_Object) theShape);
 
  Standard_EXPORT Standard_Boolean IsSubShapeBelongsTo(Handle(GEOM_Object) theSubObject,
                                                       const Standard_Integer theSubObjectIndex,
                                                       Handle(GEOM_Object) theObject,
                                                       const Standard_Integer theObjectIndex);
 
  Standard_EXPORT Standard_Integer NumberOfSubShapes (Handle(GEOM_Object)    theShape,
                                                      const Standard_Integer theShapeType);
 
  Standard_EXPORT Handle(GEOM_Object) ReverseShape(Handle(GEOM_Object) theShapes);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetFreeFacesIDs (Handle(GEOM_Object) theShape);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetSharedShapes (Handle(GEOM_Object)    theShape1,
                     Handle(GEOM_Object)    theShape2,
                     const Standard_Integer theShapeType);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetSharedShapes (std::list<Handle(GEOM_Object)>& theShapes,
                     const Standard_Integer          theShapeType,
                     const bool                      theMultiShare = true);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnPlane (const Handle(GEOM_Object)& theShape,
                      const Standard_Integer     theShapeType,
                      const Handle(GEOM_Object)& theAx1,
                      const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnPlaneWithLocation (const Handle(GEOM_Object)& theShape,
                                  const Standard_Integer     theShapeType,
                                  const Handle(GEOM_Object)& theAx1,
                                  const Handle(GEOM_Object)& thePnt,
                                  const GEOMAlgo_State       theState);
 
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnCylinder (const Handle(GEOM_Object)& theShape,
                         const Standard_Integer     theShapeType,
                         const Handle(GEOM_Object)& theAxis,
                         const Standard_Real        theRadius,
                         const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnCylinderWithLocation (const Handle(GEOM_Object)& theShape,
                                     const Standard_Integer     theShapeType,
                                     const Handle(GEOM_Object)& theAxis,
                                     const Handle(GEOM_Object)& thePnt,
                                     const Standard_Real        theRadius,
                                     const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnSphere (const Handle(GEOM_Object)& theShape,
                       const Standard_Integer     theShapeType,
                       const Handle(GEOM_Object)& theCenter,
                       const Standard_Real        theRadius,
                       const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnPlaneIDs (const Handle(GEOM_Object)& theShape,
                         const Standard_Integer     theShapeType,
                         const Handle(GEOM_Object)& theAx1,
                         const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnPlaneWithLocationIDs (const Handle(GEOM_Object)& theShape,
                                     const Standard_Integer     theShapeType,
                                     const Handle(GEOM_Object)& theAx1,
                                     const Handle(GEOM_Object)& thePnt,
                                     const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnCylinderIDs (const Handle(GEOM_Object)& theShape,
                            const Standard_Integer     theShapeType,
                            const Handle(GEOM_Object)& theAxis,
                            const Standard_Real        theRadius,
                            const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnCylinderWithLocationIDs (const Handle(GEOM_Object)& theShape,
                                        const Standard_Integer     theShapeType,
                                        const Handle(GEOM_Object)& theAxis,
                                        const Handle(GEOM_Object)& thePnt,
                                        const Standard_Real        theRadius,
                                        const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnSphereIDs (const Handle(GEOM_Object)& theShape,
                          const Standard_Integer     theShapeType,
                          const Handle(GEOM_Object)& theCenter,
                          const Standard_Real        theRadius,
                          const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetShapesOnQuadrangle (const Handle(GEOM_Object)& theShape,
                           const Standard_Integer     theShapeType,
                           const Handle(GEOM_Object)& theTopLeftPoint,
                           const Handle(GEOM_Object)& theTopRightPoint,
                           const Handle(GEOM_Object)& theBottomLeftPoint,
                           const Handle(GEOM_Object)& theBottomRightPoint,
                           const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
    GetShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
                              const Standard_Integer     theShapeType,
                              const Handle(GEOM_Object)& theTopLeftPoint,
                              const Handle(GEOM_Object)& theTopRightPoint,
                              const Handle(GEOM_Object)& theBottomLeftPoint,
                              const Handle(GEOM_Object)& theBottomRightPoint,
                              const GEOMAlgo_State       theState);
 
  Standard_EXPORT Handle(GEOM_Object) GetShapesOnCylinderOld (Handle(GEOM_Object)    theShape,
                                                              const Standard_Integer theShapeType,
                                                              Handle(GEOM_Object)    theAxis,
                                                              const Standard_Real    theRadius);
 
  Standard_EXPORT Handle(GEOM_Object) GetShapesOnSphereOld (Handle(GEOM_Object)    theShape,
                                                            const Standard_Integer theShapeType,
                                                            Handle(GEOM_Object)    theCenter,
                                                            const Standard_Real    theRadius);
 
  Standard_EXPORT Handle(GEOM_Object) GetInPlace (Handle(GEOM_Object) theShapeWhere,
                                                  Handle(GEOM_Object) theShapeWhat);
 
  Standard_EXPORT Handle(GEOM_Object) GetInPlaceOld (Handle(GEOM_Object) theShapeWhere,
                                                     Handle(GEOM_Object) theShapeWhat);
 
  Standard_EXPORT Handle(GEOM_Object) GetInPlaceByHistory (Handle(GEOM_Object) theShapeWhere,
                                                           Handle(GEOM_Object) theShapeWhat);
 
  Standard_EXPORT void GetInPlaceMap (Handle(GEOM_Object)                 theShapeWhere,
                                      Handle(GEOM_Object)                 theShapeWhat,
                                      std::vector< std::vector< int > > & theResVec);
 
  Standard_EXPORT Handle(GEOM_Object) GetSame(const Handle(GEOM_Object)& theShapeWhere,
                                              const Handle(GEOM_Object)& theShapeWhat);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger) GetSameIDs(const Handle(GEOM_Object)& theShapeWhere,
                                                                 const Handle(GEOM_Object)& theShapeWhat);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
                              GetShapesOnBoxIDs(const Handle(GEOM_Object)& theBox,
                                                const Handle(GEOM_Object)& theShape,
                                                const Standard_Integer theShapeType,
                                                GEOMAlgo_State theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
                             GetShapesOnBox(const Handle(GEOM_Object)& theBox,
                                            const Handle(GEOM_Object)& theShape,
                                            const Standard_Integer theShapeType,
                                            GEOMAlgo_State theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfInteger)
                   GetShapesOnShapeIDs(const Handle(GEOM_Object)& theCheckShape,
                                       const Handle(GEOM_Object)& theShape,
                                       const Standard_Integer theShapeType,
                                       GEOMAlgo_State theState);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
                      GetShapesOnShape(const Handle(GEOM_Object)& theCheckShape,
                                       const Handle(GEOM_Object)& theShape,
                                       const Standard_Integer theShapeType,
                                       GEOMAlgo_State theState);
  Standard_EXPORT Handle(GEOM_Object)
            GetShapesOnShapeAsCompound(const Handle(GEOM_Object)& theCheckShape,
                                       const Handle(GEOM_Object)& theShape,
                                       const Standard_Integer theShapeType,
                                       GEOMAlgo_State theState);
 
  Standard_EXPORT Handle(GEOM_Object)
                            ExtendEdge(const Handle(GEOM_Object)& theEdge,
                                       const Standard_Real        theMin,
                                       const Standard_Real        theMax);
 
  Standard_EXPORT Handle(GEOM_Object)
                            ExtendFace(const Handle(GEOM_Object)& theFace,
                                       const Standard_Real        theUMin,
                                       const Standard_Real        theUMax,
                                       const Standard_Real        theVMin,
                                       const Standard_Real        theVMax);
  
  Standard_EXPORT Handle(GEOM_Object)
                   MakeSurfaceFromFace(const Handle(GEOM_Object) &theFace);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
    GetSubShapeEdgeSorted (const Handle(GEOM_Object) &theShape,
                           const Handle(GEOM_Object) &theStartPoint);
 
  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetSubShapesWithTolerance
                     (const Handle(GEOM_Object)            &theShape,
                      const Standard_Integer                theShapeType,
                      const GEOMUtils::ComparisonCondition  theCondition,
                      const Standard_Real                   theTolerance);
 
  Standard_EXPORT Handle(GEOM_Object) MakeExtraction
                     (const Handle(GEOM_Object)              &theShape,
                      const Handle(TColStd_HArray1OfInteger) &theSubShapeIDs,
                      std::list<ExtractionStat>              &theStats);
 
 private:
  Handle(GEOM_Object) MakeShape (std::list<Handle(GEOM_Object)>      theShapes,
                                 const Standard_Integer         theObjectType,
                                 const Standard_Integer         theFunctionType,
                                 const TCollection_AsciiString& theMethodName);
 
// ----------------------------------------------------
// methods common for all GetShapesOnXXX() functions
// ----------------------------------------------------
 
  bool checkTypeShapesOn(const Standard_Integer theShapeType);
 
  Handle(Geom_Surface) makePlane(const TopoDS_Shape& theAx1);
 
  Handle(Geom_Surface) makeCylinder(const TopoDS_Shape& theAx1,
                                    const Standard_Real theRadius);
 
  Handle(TColStd_HSequenceOfInteger)
    getShapesOnSurfaceIDs(const Handle(Geom_Surface)& theSurface,
                          const TopoDS_Shape&         theShape,
                          TopAbs_ShapeEnum            theShapeType,
                          GEOMAlgo_State              theState);
 
  Handle(TColStd_HSequenceOfTransient)
    getShapesOnSurface(const Handle(Geom_Surface)& theSurface,
                       const Handle(GEOM_Object)&  theShape,
                       TopAbs_ShapeEnum            theShapeType,
                       GEOMAlgo_State              theState,
                       TCollection_AsciiString &   theShapeEntries);
 
  Handle(TColStd_HSequenceOfInteger)
    getShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
                              const Standard_Integer     theShapeType,
                              const Handle(GEOM_Object)& theTopLeftPoint,
                              const Handle(GEOM_Object)& theTopRightPoint,
                              const Handle(GEOM_Object)& theBottomLeftPoint,
                              const Handle(GEOM_Object)& theBottomRightPoint,
                              const GEOMAlgo_State       theState);
 
  Handle(TColStd_HSequenceOfInteger) getShapesOnBoxIDs(const Handle(GEOM_Object)& theBox,
                                                       const Handle(GEOM_Object)& theShape,
                                                       const Standard_Integer theShapeType,
                                                       GEOMAlgo_State theState);
 
  Handle(TColStd_HSequenceOfInteger) getShapesOnShapeIDs
                                      (const Handle(GEOM_Object)& theCheckShape,
                                       const Handle(GEOM_Object)& theShape,
                                       const Standard_Integer theShapeType,
                                       GEOMAlgo_State theState);
 
  Handle(TColStd_HSequenceOfTransient)
    getObjectsShapesOn(const Handle(GEOM_Object)&                theShape,
                       const Handle(TColStd_HSequenceOfInteger)& theShapeIDs,
                       TCollection_AsciiString &                 theShapeEntries);
 
  Handle(TColStd_HSequenceOfInteger) getSubShapeEdgeSortedIDs
                                (const Handle(GEOM_Object) &theShape,
                                 const Handle(GEOM_Object) &theStartPoint);
 
  static Handle(GEOM_Object) getCreatedLast(const Handle(GEOM_Object)& theObj1,
                                            const Handle(GEOM_Object)& theObj2);
};
 
#endif