EIC code displayed by LXR master/​include/​opencascade/​TopExp.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-10-02 09:14:18

 // Created on: 1990-12-20
 // Created by: Remi Lequette
 // Copyright (c) 1990-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _TopExp_HeaderFile
 #define _TopExp_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <TopTools_ShapeMapHasher.hxx>
 #include <NCollection_IndexedMap.hxx>
 #include <TopoDS_Shape.hxx>
 #include <NCollection_List.hxx>
 #include <NCollection_IndexedDataMap.hxx>
 #include <NCollection_Map.hxx>
 #include <TopoDS_Vertex.hxx>
 #include <Standard_Boolean.hxx>
 
 class TopoDS_Shape;
 class TopoDS_Edge;
 class TopoDS_Wire;
 
 //! This package provides basic tools to explore the
 //! topological data structures.
 //!
 //! * Explorer: A tool to find all sub-shapes of a given
 //! type. e.g. all faces of a solid.
 //!
 //! * Package methods to map sub-shapes of a shape.
 //!
 //! Level : Public
 //! All methods of all classes will be public.
 class TopExp
 {
 public:
   DEFINE_STANDARD_ALLOC
 
   //! Tool to explore a topological data structure.
   //! Stores in the map <M> all the sub-shapes of <S>
   //! of type <T>.
   //!
   //! Warning: The map is not cleared at first.
   Standard_EXPORT static void MapShapes(
     const TopoDS_Shape&                                            S,
     const TopAbs_ShapeEnum                                         T,
     NCollection_IndexedMap<TopoDS_Shape, TopTools_ShapeMapHasher>& M);
 
   //! Stores in the map <M> all the sub-shapes of <S>.
   //! - If cumOri is true, the function composes all
   //! sub-shapes with the orientation of S.
   //! - If cumLoc is true, the function multiplies all
   //! sub-shapes by the location of S, i.e. it applies to
   //! each sub-shape the transformation that is associated with S.
   Standard_EXPORT static void MapShapes(
     const TopoDS_Shape&                                            S,
     NCollection_IndexedMap<TopoDS_Shape, TopTools_ShapeMapHasher>& M,
     const bool                                                     cumOri = true,
     const bool                                                     cumLoc = true);
 
   //! Stores in the map <M> all the sub-shapes of <S>.
   //! - If cumOri is true, the function composes all
   //! sub-shapes with the orientation of S.
   //! - If cumLoc is true, the function multiplies all
   //! sub-shapes by the location of S, i.e. it applies to
   //! each sub-shape the transformation that is associated with S.
   Standard_EXPORT static void MapShapes(const TopoDS_Shape&                                     S,
                                         NCollection_Map<TopoDS_Shape, TopTools_ShapeMapHasher>& M,
                                         const bool cumOri = true,
                                         const bool cumLoc = true);
 
   //! Stores in the map <M> all the subshape of <S> of
   //! type <TS> for each one append to the list all
   //! the ancestors of type <TA>. For example map all
   //! the edges and bind the list of faces.
   //! Warning: The map is not cleared at first.
   Standard_EXPORT static void MapShapesAndAncestors(
     const TopoDS_Shape&                                  S,
     const TopAbs_ShapeEnum                               TS,
     const TopAbs_ShapeEnum                               TA,
     NCollection_IndexedDataMap<TopoDS_Shape,
                                NCollection_List<TopoDS_Shape>,
                                TopTools_ShapeMapHasher>& M);
 
   //! Stores in the map <M> all the subshape of <S> of
   //! type <TS> for each one append to the list all
   //! unique ancestors of type <TA>. For example map all
   //! the edges and bind the list of faces.
   //! useOrientation = True : taking account the ancestor orientation
   //! Warning: The map is not cleared at first.
   Standard_EXPORT static void MapShapesAndUniqueAncestors(
     const TopoDS_Shape&                                  S,
     const TopAbs_ShapeEnum                               TS,
     const TopAbs_ShapeEnum                               TA,
     NCollection_IndexedDataMap<TopoDS_Shape,
                                NCollection_List<TopoDS_Shape>,
                                TopTools_ShapeMapHasher>& M,
     const bool                                           useOrientation = false);
 
   //! Returns the Vertex of orientation FORWARD in E. If
   //! there is none returns a Null Shape.
   //! CumOri = True : taking account the edge orientation
   Standard_EXPORT static TopoDS_Vertex FirstVertex(const TopoDS_Edge& E, const bool CumOri = false);
 
   //! Returns the Vertex of orientation REVERSED in E. If
   //! there is none returns a Null Shape.
   //! CumOri = True : taking account the edge orientation
   Standard_EXPORT static TopoDS_Vertex LastVertex(const TopoDS_Edge& E, const bool CumOri = false);
 
   //! Returns in Vfirst, Vlast the FORWARD and REVERSED
   //! vertices of the edge <E>. May be null shapes.
   //! CumOri = True : taking account the edge orientation
   Standard_EXPORT static void Vertices(const TopoDS_Edge& E,
                                        TopoDS_Vertex&     Vfirst,
                                        TopoDS_Vertex&     Vlast,
                                        const bool         CumOri = false);
 
   //! Returns in Vfirst, Vlast the first and last
   //! vertices of the open wire <W>. May be null shapes.
   //! if <W> is closed Vfirst and Vlast are a same
   //! vertex on <W>.
   //! if <W> is no manifold. VFirst and VLast are null
   //! shapes.
   Standard_EXPORT static void Vertices(const TopoDS_Wire& W,
                                        TopoDS_Vertex&     Vfirst,
                                        TopoDS_Vertex&     Vlast);
 
   //! Finds the vertex <V> common to the two edges
   //! <E1,E2>, returns True if this vertex exists.
   //!
   //! Warning: <V> has sense only if the value <True> is returned
   Standard_EXPORT static bool CommonVertex(const TopoDS_Edge& E1,
                                            const TopoDS_Edge& E2,
                                            TopoDS_Vertex&     V);
 };
 
 #endif // _TopExp_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team