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

    Definition of set of points as a result of the intersection between 2 parametrised patches. More...

    #include <IntPatch_WLine.hxx>

    Inheritance diagram for IntPatch_WLine:

    Public Types

    enum  IntPatch_WLType { IntPatch_WLUnknown , IntPatch_WLImpImp , IntPatch_WLImpPrm , IntPatch_WLPrmPrm }
     Enumeration of ways of WLine creation. More...
    typedef void base_type
     Returns a type descriptor about this object.

    Public Member Functions

     IntPatch_WLine (const occ::handle< IntSurf_LineOn2S > &Line, const bool Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2)
     Creates a WLine as an intersection when the transitions are In or Out.
     IntPatch_WLine (const occ::handle< IntSurf_LineOn2S > &Line, const bool Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2)
     Creates a WLine as an intersection when the transitions are Touch.
     IntPatch_WLine (const occ::handle< IntSurf_LineOn2S > &Line, const bool Tang)
     Creates a WLine as an intersection when the transitions are Undecided.
    void AddVertex (const IntPatch_Point &Pnt, const bool theIsPrepend=false) override
     Adds a vertex in the list. If theIsPrepend == TRUE the new vertex will be added before the first element of vertices sequence. Otherwise, to the end of the sequence.
    void SetPoint (const int Index, const IntPatch_Point &Pnt)
     Set the Point of index <Index> in the LineOn2S.
    void Replace (const int Index, const IntPatch_Point &Pnt)
     Replaces the element of range Index in the list of points. The exception OutOfRange is raised when Index <= 0 or Index > NbVertex.
    void SetFirstPoint (const int IndFirst)
    void SetLastPoint (const int IndLast)
    int NbPnts () const override
     Returns the number of intersection points.
    const IntSurf_PntOn2SPoint (const int Index) const override
     Returns the intersection point of range Index.
    bool HasFirstPoint () const
     Returns True if the line has a known First point. This point is given by the method FirstPoint().
    bool HasLastPoint () const
     Returns True if the line has a known Last point. This point is given by the method LastPoint().
    const IntPatch_PointFirstPoint () const
     Returns the Point corresponding to the FirstPoint.
    const IntPatch_PointLastPoint () const
     Returns the Point corresponding to the LastPoint.
    const IntPatch_PointFirstPoint (int &Indfirst) const
     Returns the Point corresponding to the FirstPoint. Indfirst is the index of the first in the list of vertices.
    const IntPatch_PointLastPoint (int &Indlast) const
     Returns the Point corresponding to the LastPoint. Indlast is the index of the last in the list of vertices.
    int NbVertex () const override
     Returns number of vertices (IntPatch_Point) of the line.
    const IntPatch_PointVertex (const int Index) const override
     Returns the vertex of range Index on the line.
    IntPatch_PointChangeVertex (const int Index) override
     Returns the vertex of range Index on the line.
    void ComputeVertexParameters (const double Tol)
     Set the parameters of all the vertex on the line. if a vertex is already in the line, its parameter is modified else a new point in the line is inserted.
    occ::handle< IntSurf_LineOn2SCurve () const override
     Returns set of intersection points.
    bool IsOutSurf1Box (const gp_Pnt2d &theP) const override
     Returns TRUE if theP is out of the box built from the points on 1st surface.
    bool IsOutSurf2Box (const gp_Pnt2d &theP) const override
     Returns TRUE if theP is out of the box built from the points on 2nd surface.
    bool IsOutBox (const gp_Pnt &theP) const override
     Returns TRUE if theP is out of the box built from 3D-points.
    void SetPeriod (const double pu1, const double pv1, const double pu2, const double pv2)
    double U1Period () const
    double V1Period () const
    double U2Period () const
    double V2Period () const
    void SetArcOnS1 (const occ::handle< Adaptor2d_Curve2d > &A)
    bool HasArcOnS1 () const
    const occ::handle< Adaptor2d_Curve2d > & GetArcOnS1 () const
    void SetArcOnS2 (const occ::handle< Adaptor2d_Curve2d > &A)
    bool HasArcOnS2 () const
    const occ::handle< Adaptor2d_Curve2d > & GetArcOnS2 () const
    void ClearVertexes () override
     Removes vertices from the line (i.e. cleans svtx member).
    void RemoveVertex (const int theIndex) override
     Removes single vertex from the line.
    void InsertVertexBefore (const int theIndex, const IntPatch_Point &thePnt)
    void Dump (const int theMode) const
     if (theMode == 0) then prints the information about WLine if (theMode == 1) then prints the list of 3d-points if (theMode == 2) then prints the list of 2d-points on the 1st surface Otherwise, prints list of 2d-points on the 2nd surface
    void EnablePurging (const bool theIsEnabled)
     Allows or forbids purging of existing WLine.
    bool IsPurgingAllowed ()
     Returns TRUE if purging is allowed or forbidden for existing WLine.
    IntPatch_WLType GetCreatingWay () const
     Returns the way of <*this> creation.
    void SetCreatingWayInfo (IntPatch_WLType theAlgo)
     Sets the info about the way of <*this> creation.
    Public Member Functions inherited from IntPatch_Line
    void SetValue (const bool Uiso1, const bool Viso1, const bool Uiso2, const bool Viso2)
     To set the values returned by IsUIsoS1,.... The default values are False.
    IntPatch_IType ArcType () const
     Returns the type of geometry 3d (Line, Circle, Parabola, Hyperbola, Ellipse, Analytic, Walking, Restriction).
    bool IsTangent () const
     Returns TRUE if the intersection is a line of tangency between the 2 patches.
    IntSurf_TypeTrans TransitionOnS1 () const
     Returns the type of the transition of the line for the first surface. The transition is "constant" along the line. The transition is IN if the line is oriented in such a way that the system of vector (N1,N2,T) is right-handed, where N1 is the normal to the first surface at a point P, N2 is the normal to the second surface at a point P, T is the tangent to the intersection line at P. If the system of vector is left-handed, the transition is OUT. When N1 and N2 are colinear all along the intersection line, the transition will be.
    IntSurf_TypeTrans TransitionOnS2 () const
     Returns the type of the transition of the line for the second surface. The transition is "constant" along the line.
    IntSurf_Situation SituationS1 () const
     Returns the situation (INSIDE/OUTSIDE/UNKNOWN) of the first patch compared to the second one, when TransitionOnS1 or TransitionOnS2 returns TOUCH. Otherwise, an exception is raised.
    IntSurf_Situation SituationS2 () const
     Returns the situation (INSIDE/OUTSIDE/UNKNOWN) of the second patch compared to the first one, when TransitionOnS1 or TransitionOnS2 returns TOUCH. Otherwise, an exception is raised.
    bool IsUIsoOnS1 () const
     Returns TRUE if the intersection is a U isoparametric curve on the first patch.
    bool IsVIsoOnS1 () const
     Returns TRUE if the intersection is a V isoparametric curve on the first patch.
    bool IsUIsoOnS2 () const
     Returns TRUE if the intersection is a U isoparametric curve on the second patch.
    bool IsVIsoOnS2 () const
     Returns TRUE if the intersection is a V isoparametric curve on the second patch.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_TransientThis () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    Static Public Member Functions inherited from IntPatch_PointLine
    static double CurvatureRadiusOfIntersLine (const occ::handle< Adaptor3d_Surface > &theS1, const occ::handle< Adaptor3d_Surface > &theS2, const IntSurf_PntOn2S &theUVPoint)
     Returns the radius of curvature of the intersection line in given point. Returns negative value if computation is not possible.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.
    Protected Member Functions inherited from IntPatch_PointLine
     IntPatch_PointLine (const bool Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2)
     To initialize the fields, when the transitions are In or Out.
     IntPatch_PointLine (const bool Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2)
     To initialize the fields, when the transitions are Touch.
     IntPatch_PointLine (const bool Tang)
     To initialize the fields, when the transitions are Undecided.
    Protected Member Functions inherited from IntPatch_Line
     IntPatch_Line (const bool Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2)
     To initialize the fields, when the transitions are In or Out.
     IntPatch_Line (const bool Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2)
     To initialize the fields, when the transitions are Touch.
     IntPatch_Line (const bool Tang)
     To initialize the fields, when the transitions are Undecided.
    Protected Attributes inherited from IntPatch_Line
    IntPatch_IType typ

    Detailed Description

    Definition of set of points as a result of the intersection between 2 parametrised patches.

    Member Enumeration Documentation

    ◆ IntPatch_WLType

    Enumeration of ways of WLine creation.

    Enumerator
    IntPatch_WLUnknown 
    IntPatch_WLImpImp 
    IntPatch_WLImpPrm 
    IntPatch_WLPrmPrm 

    Constructor & Destructor Documentation

    ◆ IntPatch_WLine() [1/3]

    IntPatch_WLine::IntPatch_WLine ( const occ::handle< IntSurf_LineOn2S > & Line,
    const bool Tang,
    const IntSurf_TypeTrans Trans1,
    const IntSurf_TypeTrans Trans2 )

    Creates a WLine as an intersection when the transitions are In or Out.

    ◆ IntPatch_WLine() [2/3]

    IntPatch_WLine::IntPatch_WLine ( const occ::handle< IntSurf_LineOn2S > & Line,
    const bool Tang,
    const IntSurf_Situation Situ1,
    const IntSurf_Situation Situ2 )

    Creates a WLine as an intersection when the transitions are Touch.

    ◆ IntPatch_WLine() [3/3]

    IntPatch_WLine::IntPatch_WLine ( const occ::handle< IntSurf_LineOn2S > & Line,
    const bool Tang )

    Creates a WLine as an intersection when the transitions are Undecided.

    Member Function Documentation

    ◆ AddVertex()

    void IntPatch_WLine::AddVertex ( const IntPatch_Point & Pnt,
    const bool theIsPrepend = false )
    overridevirtual

    Adds a vertex in the list. If theIsPrepend == TRUE the new vertex will be added before the first element of vertices sequence. Otherwise, to the end of the sequence.

    Implements IntPatch_PointLine.

    ◆ ChangeVertex()

    IntPatch_Point & IntPatch_WLine::ChangeVertex ( const int Index)
    overridevirtual

    Returns the vertex of range Index on the line.

    Implements IntPatch_PointLine.

    ◆ ClearVertexes()

    void IntPatch_WLine::ClearVertexes ( )
    overridevirtual

    Removes vertices from the line (i.e. cleans svtx member).

    Implements IntPatch_PointLine.

    ◆ ComputeVertexParameters()

    void IntPatch_WLine::ComputeVertexParameters ( const double Tol)

    Set the parameters of all the vertex on the line. if a vertex is already in the line, its parameter is modified else a new point in the line is inserted.

    ◆ Curve()

    occ::handle< IntSurf_LineOn2S > IntPatch_WLine::Curve ( ) const
    overridevirtual

    Returns set of intersection points.

    Implements IntPatch_PointLine.

    ◆ Dump()

    void IntPatch_WLine::Dump ( const int theMode) const

    if (theMode == 0) then prints the information about WLine if (theMode == 1) then prints the list of 3d-points if (theMode == 2) then prints the list of 2d-points on the 1st surface Otherwise, prints list of 2d-points on the 2nd surface

    ◆ EnablePurging()

    void IntPatch_WLine::EnablePurging ( const bool theIsEnabled)
    inline

    Allows or forbids purging of existing WLine.

    ◆ FirstPoint() [1/2]

    const IntPatch_Point & IntPatch_WLine::FirstPoint ( ) const

    Returns the Point corresponding to the FirstPoint.

    ◆ FirstPoint() [2/2]

    const IntPatch_Point & IntPatch_WLine::FirstPoint ( int & Indfirst) const

    Returns the Point corresponding to the FirstPoint. Indfirst is the index of the first in the list of vertices.

    ◆ GetArcOnS1()

    const occ::handle< Adaptor2d_Curve2d > & IntPatch_WLine::GetArcOnS1 ( ) const

    ◆ GetArcOnS2()

    const occ::handle< Adaptor2d_Curve2d > & IntPatch_WLine::GetArcOnS2 ( ) const

    ◆ GetCreatingWay()

    IntPatch_WLType IntPatch_WLine::GetCreatingWay ( ) const
    inline

    Returns the way of <*this> creation.

    ◆ HasArcOnS1()

    bool IntPatch_WLine::HasArcOnS1 ( ) const

    ◆ HasArcOnS2()

    bool IntPatch_WLine::HasArcOnS2 ( ) const

    ◆ HasFirstPoint()

    bool IntPatch_WLine::HasFirstPoint ( ) const

    Returns True if the line has a known First point. This point is given by the method FirstPoint().

    ◆ HasLastPoint()

    bool IntPatch_WLine::HasLastPoint ( ) const

    Returns True if the line has a known Last point. This point is given by the method LastPoint().

    ◆ InsertVertexBefore()

    void IntPatch_WLine::InsertVertexBefore ( const int theIndex,
    const IntPatch_Point & thePnt )

    ◆ IsOutBox()

    bool IntPatch_WLine::IsOutBox ( const gp_Pnt & theP) const
    inlineoverridevirtual

    Returns TRUE if theP is out of the box built from 3D-points.

    Implements IntPatch_PointLine.

    ◆ IsOutSurf1Box()

    bool IntPatch_WLine::IsOutSurf1Box ( const gp_Pnt2d & theP) const
    inlineoverridevirtual

    Returns TRUE if theP is out of the box built from the points on 1st surface.

    Implements IntPatch_PointLine.

    ◆ IsOutSurf2Box()

    bool IntPatch_WLine::IsOutSurf2Box ( const gp_Pnt2d & theP) const
    inlineoverridevirtual

    Returns TRUE if theP is out of the box built from the points on 2nd surface.

    Implements IntPatch_PointLine.

    ◆ IsPurgingAllowed()

    bool IntPatch_WLine::IsPurgingAllowed ( )
    inline

    Returns TRUE if purging is allowed or forbidden for existing WLine.

    ◆ LastPoint() [1/2]

    const IntPatch_Point & IntPatch_WLine::LastPoint ( ) const

    Returns the Point corresponding to the LastPoint.

    ◆ LastPoint() [2/2]

    const IntPatch_Point & IntPatch_WLine::LastPoint ( int & Indlast) const

    Returns the Point corresponding to the LastPoint. Indlast is the index of the last in the list of vertices.

    ◆ NbPnts()

    int IntPatch_WLine::NbPnts ( ) const
    overridevirtual

    Returns the number of intersection points.

    Implements IntPatch_PointLine.

    ◆ NbVertex()

    int IntPatch_WLine::NbVertex ( ) const
    overridevirtual

    Returns number of vertices (IntPatch_Point) of the line.

    Implements IntPatch_PointLine.

    ◆ Point()

    const IntSurf_PntOn2S & IntPatch_WLine::Point ( const int Index) const
    overridevirtual

    Returns the intersection point of range Index.

    Implements IntPatch_PointLine.

    ◆ RemoveVertex()

    void IntPatch_WLine::RemoveVertex ( const int theIndex)
    overridevirtual

    Removes single vertex from the line.

    Implements IntPatch_PointLine.

    ◆ Replace()

    void IntPatch_WLine::Replace ( const int Index,
    const IntPatch_Point & Pnt )

    Replaces the element of range Index in the list of points. The exception OutOfRange is raised when Index <= 0 or Index > NbVertex.

    ◆ SetArcOnS1()

    void IntPatch_WLine::SetArcOnS1 ( const occ::handle< Adaptor2d_Curve2d > & A)

    ◆ SetArcOnS2()

    void IntPatch_WLine::SetArcOnS2 ( const occ::handle< Adaptor2d_Curve2d > & A)

    ◆ SetCreatingWayInfo()

    void IntPatch_WLine::SetCreatingWayInfo ( IntPatch_WLType theAlgo)
    inline

    Sets the info about the way of <*this> creation.

    ◆ SetFirstPoint()

    void IntPatch_WLine::SetFirstPoint ( const int IndFirst)

    ◆ SetLastPoint()

    void IntPatch_WLine::SetLastPoint ( const int IndLast)

    ◆ SetPeriod()

    void IntPatch_WLine::SetPeriod ( const double pu1,
    const double pv1,
    const double pu2,
    const double pv2 )

    ◆ SetPoint()

    void IntPatch_WLine::SetPoint ( const int Index,
    const IntPatch_Point & Pnt )

    Set the Point of index <Index> in the LineOn2S.

    ◆ U1Period()

    double IntPatch_WLine::U1Period ( ) const

    ◆ U2Period()

    double IntPatch_WLine::U2Period ( ) const

    ◆ V1Period()

    double IntPatch_WLine::V1Period ( ) const

    ◆ V2Period()

    double IntPatch_WLine::V2Period ( ) const

    ◆ Vertex()

    const IntPatch_Point & IntPatch_WLine::Vertex ( const int Index) const
    overridevirtual

    Returns the vertex of range Index on the line.

    Implements IntPatch_PointLine.


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