OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    TopExp Class Reference

    This package provides basic tools to explore the topological data structures. More...

    #include <TopExp.hxx>

    Static Public Member Functions

    static void MapShapes (const TopoDS_Shape &S, const TopAbs_ShapeEnum T, NCollection_IndexedMap< TopoDS_Shape, TopTools_ShapeMapHasher > &M)
     Tool to explore a topological data structure. Stores in the map <M> all the sub-shapes of of type <T>.
    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 .
    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 sub-shapes of .
    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 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.
    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)
     Stores in the map <M> all the subshape of 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.
    static TopoDS_Vertex FirstVertex (const TopoDS_Edge &E, const bool CumOri=false)
     Returns the Vertex of orientation FORWARD in E. If there is none returns a Null Shape. CumOri = True : taking account the edge orientation.
    static TopoDS_Vertex LastVertex (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.
    static void Vertices (const TopoDS_Edge &E, TopoDS_Vertex &Vfirst, TopoDS_Vertex &Vlast, 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.
    static void Vertices (const TopoDS_Wire &W, TopoDS_Vertex &Vfirst, TopoDS_Vertex &Vlast)
     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.
    static bool CommonVertex (const TopoDS_Edge &E1, const TopoDS_Edge &E2, TopoDS_Vertex &V)
     Finds the vertex <V> common to the two edges <E1,E2>, returns True if this vertex exists.

    Detailed Description

    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.

    Member Function Documentation

    ◆ CommonVertex()

    bool TopExp::CommonVertex ( const TopoDS_Edge & E1,
    const TopoDS_Edge & E2,
    TopoDS_Vertex & V )
    static

    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

    ◆ FirstVertex()

    TopoDS_Vertex TopExp::FirstVertex ( const TopoDS_Edge & E,
    const bool CumOri = false )
    static

    Returns the Vertex of orientation FORWARD in E. If there is none returns a Null Shape. CumOri = True : taking account the edge orientation.

    ◆ LastVertex()

    TopoDS_Vertex TopExp::LastVertex ( const TopoDS_Edge & E,
    const bool CumOri = false )
    static

    Returns the Vertex of orientation REVERSED in E. If there is none returns a Null Shape. CumOri = True : taking account the edge orientation.

    ◆ MapShapes() [1/3]

    void TopExp::MapShapes ( const TopoDS_Shape & S,
    const TopAbs_ShapeEnum T,
    NCollection_IndexedMap< TopoDS_Shape, TopTools_ShapeMapHasher > & M )
    static

    Tool to explore a topological data structure. Stores in the map <M> all the sub-shapes of of type <T>.

    Warning: The map is not cleared at first.

    ◆ MapShapes() [2/3]

    void TopExp::MapShapes ( const TopoDS_Shape & S,
    NCollection_IndexedMap< TopoDS_Shape, TopTools_ShapeMapHasher > & M,
    const bool cumOri = true,
    const bool cumLoc = true )
    static

    Stores in the map <M> all the sub-shapes of .

    • 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.

    ◆ MapShapes() [3/3]

    void TopExp::MapShapes ( const TopoDS_Shape & S,
    NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher > & M,
    const bool cumOri = true,
    const bool cumLoc = true )
    static

    Stores in the map <M> all the sub-shapes of .

    • 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.

    ◆ MapShapesAndAncestors()

    void TopExp::MapShapesAndAncestors ( const TopoDS_Shape & S,
    const TopAbs_ShapeEnum TS,
    const TopAbs_ShapeEnum TA,
    NCollection_IndexedDataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher > & M )
    static

    Stores in the map <M> all the subshape of 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.

    ◆ MapShapesAndUniqueAncestors()

    void TopExp::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 )
    static

    Stores in the map <M> all the subshape of 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.

    ◆ Vertices() [1/2]

    void TopExp::Vertices ( const TopoDS_Edge & E,
    TopoDS_Vertex & Vfirst,
    TopoDS_Vertex & Vlast,
    const bool CumOri = false )
    static

    Returns in Vfirst, Vlast the FORWARD and REVERSED vertices of the edge <E>. May be null shapes. CumOri = True : taking account the edge orientation.

    ◆ Vertices() [2/2]

    void TopExp::Vertices ( const TopoDS_Wire & W,
    TopoDS_Vertex & Vfirst,
    TopoDS_Vertex & Vlast )
    static

    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.


    The documentation for this class was generated from the following file: