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
    IntTools_EdgeFace Class Reference

    The class provides Edge/Face intersection algorithm to determine common parts between edge and face in 3-d space. Common parts between Edge and Face can be: More...

    #include <IntTools_EdgeFace.hxx>

    Public Member Functions

    Constructors

    Empty Constructor

     IntTools_EdgeFace ()
    Setters/Getters

    Sets the edge for intersection

    void SetEdge (const TopoDS_Edge &theEdge)
     Returns the edge.
    const TopoDS_EdgeEdge () const
     Returns the edge.
    void SetFace (const TopoDS_Face &theFace)
     Sets the face for intersection.
    const TopoDS_FaceFace () const
     Returns the face.
    void SetRange (const IntTools_Range &theRange)
     Sets the boundaries for the edge. The algorithm processes edge inside these boundaries.
    void SetRange (const double theFirst, const double theLast)
     Sets the boundaries for the edge. The algorithm processes edge inside these boundaries.
    const IntTools_RangeRange () const
     Returns intersection range of the edge.
    void SetContext (const occ::handle< IntTools_Context > &theContext)
     Sets the intersection context.
    const occ::handle< IntTools_Context > & Context () const
     Returns the intersection context.
    void SetFuzzyValue (const double theFuzz)
     Sets the Fuzzy value.
    double FuzzyValue () const
     Returns the Fuzzy value.
    void UseQuickCoincidenceCheck (const bool theFlag)
     Sets the flag for quick coincidence check. It is safe to use the quick check for coincidence only if both of the following conditions are met:
    bool IsCoincidenceCheckedQuickly ()
     Returns the flag myQuickCoincidenceCheck.
    Performing the operation

    Launches the process

    void Perform ()
    Checking validity of the intersection

    Returns TRUE if computation was successful. Otherwise returns FALSE.

    bool IsDone () const
     Returns the code of completion: 0 - means successful completion; 1 - the process was not started; 2,3 - invalid source data for the algorithm; 4 - projection failed.
    int ErrorStatus () const
     Returns the code of completion: 0 - means successful completion; 1 - the process was not started; 2,3 - invalid source data for the algorithm; 4 - projection failed.
    Obtaining results

    Returns resulting common parts

    const NCollection_Sequence< IntTools_CommonPrt > & CommonParts () const
     Returns the minimal distance found between edge and face.
    double MinimalDistance () const
     Returns the minimal distance found between edge and face.

    Protected methods performing the intersection

    TopoDS_Edge myEdge
     Minimal distance found.
    TopoDS_Face myFace
     Minimal distance found.
    double myFuzzyValue
     Minimal distance found.
    BRepAdaptor_Curve myC
     Minimal distance found.
    BRepAdaptor_Surface myS
     Minimal distance found.
    double myCriteria
     Minimal distance found.
    bool myIsDone
     Minimal distance found.
    int myErrorStatus
     Minimal distance found.
    occ::handle< IntTools_ContextmyContext
     Minimal distance found.
    NCollection_Sequence< IntTools_CommonPrtmySeqOfCommonPrts
     Minimal distance found.
    IntTools_Range myRange
     Minimal distance found.
    bool myQuickCoincidenceCheck
     Minimal distance found.
    double myMinDistance
     Minimal distance found.
    static bool IsEqDistance (const gp_Pnt &aP, const BRepAdaptor_Surface &aS, const double aT, double &aD)
     Minimal distance found.
    void CheckData ()
     Minimal distance found.
    bool IsProjectable (const double tt) const
     Minimal distance found.
    double DistanceFunction (const double tt)
     Minimal distance found.
    int MakeType (IntTools_CommonPrt &aCP)
     Minimal distance found.
    bool CheckTouch (const IntTools_CommonPrt &aCP, double &aTX)
     Minimal distance found.
    bool CheckTouchVertex (const IntTools_CommonPrt &aCP, double &aTX)
     Minimal distance found.
    bool IsCoincident ()
     Checks if the edge is in the face really.

    Detailed Description

    The class provides Edge/Face intersection algorithm to determine common parts between edge and face in 3-d space. Common parts between Edge and Face can be:

    • Vertices - in case of intersection or touching;
    • Edge - in case of full coincidence of the edge with the face.

    Constructor & Destructor Documentation

    ◆ IntTools_EdgeFace()

    IntTools_EdgeFace::IntTools_EdgeFace ( )

    Member Function Documentation

    ◆ CheckData()

    void IntTools_EdgeFace::CheckData ( )
    protected

    Minimal distance found.

    ◆ CheckTouch()

    bool IntTools_EdgeFace::CheckTouch ( const IntTools_CommonPrt & aCP,
    double & aTX )
    protected

    Minimal distance found.

    ◆ CheckTouchVertex()

    bool IntTools_EdgeFace::CheckTouchVertex ( const IntTools_CommonPrt & aCP,
    double & aTX )
    protected

    Minimal distance found.

    ◆ CommonParts()

    const NCollection_Sequence< IntTools_CommonPrt > & IntTools_EdgeFace::CommonParts ( ) const
    inline

    Returns the minimal distance found between edge and face.

    ◆ Context()

    const occ::handle< IntTools_Context > & IntTools_EdgeFace::Context ( ) const
    inline

    Returns the intersection context.

    ◆ DistanceFunction()

    double IntTools_EdgeFace::DistanceFunction ( const double t)
    protected

    Minimal distance found.

    ◆ Edge()

    const TopoDS_Edge & IntTools_EdgeFace::Edge ( ) const
    inline

    Returns the edge.

    ◆ ErrorStatus()

    int IntTools_EdgeFace::ErrorStatus ( ) const
    inline

    Returns the code of completion: 0 - means successful completion; 1 - the process was not started; 2,3 - invalid source data for the algorithm; 4 - projection failed.

    ◆ Face()

    const TopoDS_Face & IntTools_EdgeFace::Face ( ) const
    inline

    Returns the face.

    ◆ FuzzyValue()

    double IntTools_EdgeFace::FuzzyValue ( ) const
    inline

    Returns the Fuzzy value.

    ◆ IsCoincidenceCheckedQuickly()

    bool IntTools_EdgeFace::IsCoincidenceCheckedQuickly ( )
    inline

    Returns the flag myQuickCoincidenceCheck.

    ◆ IsCoincident()

    bool IntTools_EdgeFace::IsCoincident ( )
    protected

    Checks if the edge is in the face really.

    ◆ IsDone()

    bool IntTools_EdgeFace::IsDone ( ) const
    inline

    Returns the code of completion: 0 - means successful completion; 1 - the process was not started; 2,3 - invalid source data for the algorithm; 4 - projection failed.

    ◆ IsEqDistance()

    bool IntTools_EdgeFace::IsEqDistance ( const gp_Pnt & aP,
    const BRepAdaptor_Surface & aS,
    const double aT,
    double & aD )
    staticprotected

    Minimal distance found.

    ◆ IsProjectable()

    bool IntTools_EdgeFace::IsProjectable ( const double t) const
    protected

    Minimal distance found.

    ◆ MakeType()

    int IntTools_EdgeFace::MakeType ( IntTools_CommonPrt & aCP)
    protected

    Minimal distance found.

    ◆ MinimalDistance()

    double IntTools_EdgeFace::MinimalDistance ( ) const
    inline

    Returns the minimal distance found between edge and face.

    ◆ Perform()

    void IntTools_EdgeFace::Perform ( )

    ◆ Range()

    const IntTools_Range & IntTools_EdgeFace::Range ( ) const
    inline

    Returns intersection range of the edge.

    ◆ SetContext()

    void IntTools_EdgeFace::SetContext ( const occ::handle< IntTools_Context > & theContext)
    inline

    Sets the intersection context.

    ◆ SetEdge()

    void IntTools_EdgeFace::SetEdge ( const TopoDS_Edge & theEdge)
    inline

    Returns the edge.

    ◆ SetFace()

    void IntTools_EdgeFace::SetFace ( const TopoDS_Face & theFace)
    inline

    Sets the face for intersection.

    ◆ SetFuzzyValue()

    void IntTools_EdgeFace::SetFuzzyValue ( const double theFuzz)
    inline

    Sets the Fuzzy value.

    ◆ SetRange() [1/2]

    void IntTools_EdgeFace::SetRange ( const double theFirst,
    const double theLast )
    inline

    Sets the boundaries for the edge. The algorithm processes edge inside these boundaries.

    ◆ SetRange() [2/2]

    void IntTools_EdgeFace::SetRange ( const IntTools_Range & theRange)
    inline

    Sets the boundaries for the edge. The algorithm processes edge inside these boundaries.

    ◆ UseQuickCoincidenceCheck()

    void IntTools_EdgeFace::UseQuickCoincidenceCheck ( const bool theFlag)
    inline

    Sets the flag for quick coincidence check. It is safe to use the quick check for coincidence only if both of the following conditions are met:

    • The vertices of edge are lying on the face;
    • The edge does not intersect the boundaries of the face on the given range.

    Field Documentation

    ◆ myC

    BRepAdaptor_Curve IntTools_EdgeFace::myC
    protected

    Minimal distance found.

    ◆ myContext

    occ::handle<IntTools_Context> IntTools_EdgeFace::myContext
    protected

    Minimal distance found.

    ◆ myCriteria

    double IntTools_EdgeFace::myCriteria
    protected

    Minimal distance found.

    ◆ myEdge

    TopoDS_Edge IntTools_EdgeFace::myEdge
    protected

    Minimal distance found.

    ◆ myErrorStatus

    int IntTools_EdgeFace::myErrorStatus
    protected

    Minimal distance found.

    ◆ myFace

    TopoDS_Face IntTools_EdgeFace::myFace
    protected

    Minimal distance found.

    ◆ myFuzzyValue

    double IntTools_EdgeFace::myFuzzyValue
    protected

    Minimal distance found.

    ◆ myIsDone

    bool IntTools_EdgeFace::myIsDone
    protected

    Minimal distance found.

    ◆ myMinDistance

    double IntTools_EdgeFace::myMinDistance
    protected

    Minimal distance found.

    ◆ myQuickCoincidenceCheck

    bool IntTools_EdgeFace::myQuickCoincidenceCheck
    protected

    Minimal distance found.

    ◆ myRange

    IntTools_Range IntTools_EdgeFace::myRange
    protected

    Minimal distance found.

    ◆ myS

    BRepAdaptor_Surface IntTools_EdgeFace::myS
    protected

    Minimal distance found.

    ◆ mySeqOfCommonPrts

    NCollection_Sequence<IntTools_CommonPrt> IntTools_EdgeFace::mySeqOfCommonPrts
    protected

    Minimal distance found.


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