OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    GccEnt_QualifiedCirc Class Reference

    Creates a qualified 2d Circle. A qualified 2D circle is a circle (gp_Circ2d circle) with a qualifier which specifies whether the solution of a construction algorithm using the qualified circle (as an argument): More...

    #include <GccEnt_QualifiedCirc.hxx>

    Public Member Functions

     GccEnt_QualifiedCirc (const gp_Circ2d &Qualified, const GccEnt_Position Qualifier)
     Constructs a qualified circle by assigning the qualifier Qualifier to the circle Qualified. Qualifier may be:
    gp_Circ2d Qualified () const
     Returns a 2D circle to which the qualifier is assigned.
    GccEnt_Position Qualifier () const
     Returns.
    bool IsUnqualified () const
     Returns true if the Circ2d is Unqualified and false in the other cases.
    bool IsEnclosing () const
     Returns true if the solution computed by a construction algorithm using this qualified circle encloses the circle.
    bool IsEnclosed () const
     Returns true if the solution computed by a construction algorithm using this qualified circle is enclosed by the circle.
    bool IsOutside () const
     Returns true if both the solution computed by a construction algorithm using this qualified circle and the circle are external to one another.

    Detailed Description

    Creates a qualified 2d Circle. A qualified 2D circle is a circle (gp_Circ2d circle) with a qualifier which specifies whether the solution of a construction algorithm using the qualified circle (as an argument):

    • encloses the circle, or
    • is enclosed by the circle, or
    • is built so that both the circle and it are external to one another, or
    • is undefined (all solutions apply).

    Constructor & Destructor Documentation

    ◆ GccEnt_QualifiedCirc()

    GccEnt_QualifiedCirc::GccEnt_QualifiedCirc ( const gp_Circ2d & Qualified,
    const GccEnt_Position Qualifier )

    Constructs a qualified circle by assigning the qualifier Qualifier to the circle Qualified. Qualifier may be:

    • GccEnt_enclosing if the solution computed by a construction algorithm using the qualified circle encloses the circle, or
    • GccEnt_enclosed if the solution is enclosed by the circle, or
    • GccEnt_outside if both the solution and the circle are external to one another, or
    • GccEnt_unqualified if all solutions apply.

    Member Function Documentation

    ◆ IsEnclosed()

    bool GccEnt_QualifiedCirc::IsEnclosed ( ) const

    Returns true if the solution computed by a construction algorithm using this qualified circle is enclosed by the circle.

    ◆ IsEnclosing()

    bool GccEnt_QualifiedCirc::IsEnclosing ( ) const

    Returns true if the solution computed by a construction algorithm using this qualified circle encloses the circle.

    ◆ IsOutside()

    bool GccEnt_QualifiedCirc::IsOutside ( ) const

    Returns true if both the solution computed by a construction algorithm using this qualified circle and the circle are external to one another.

    ◆ IsUnqualified()

    bool GccEnt_QualifiedCirc::IsUnqualified ( ) const

    Returns true if the Circ2d is Unqualified and false in the other cases.

    ◆ Qualified()

    gp_Circ2d GccEnt_QualifiedCirc::Qualified ( ) const

    Returns a 2D circle to which the qualifier is assigned.

    ◆ Qualifier()

    GccEnt_Position GccEnt_QualifiedCirc::Qualifier ( ) const

    Returns.

    • the qualifier of this qualified circle, if it is enclosing, enclosed or outside, or
    • GccEnt_noqualifier if it is unqualified.

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