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

    This package provides an implementation of the qualified entities useful to create 2d entities with geometric constraints. The qualifier explains which subfamily of solutions we want to obtain. It uses the following law: the matter/the interior side is at the left of the line, if we go from the beginning to the end. The qualifiers are: Enclosing : the solution(s) must enclose the argument. Enclosed : the solution(s) must be enclosed in the argument. Outside : both the solution(s) and the argument must be outside to each other. Unqualified : the position is undefined, so give all the solutions. The use of a qualifier is always required if such subfamilies exist. For example, it is not used for a point. Note: the interior of a curve is defined as the left-hand side of the curve in relation to its orientation. More...

    #include <GccEnt.hxx>

    Static Public Member Functions

    static Standard_OStreamPrint (const GccEnt_Position thePosition, Standard_OStream &theStream)
     Prints the name of Position type as a String on the Stream.
    static const char * PositionToString (GccEnt_Position thePosition)
     Returns the string name for a given position.
    static GccEnt_Position PositionFromString (const char *thePositionString)
     Returns the position from the given string identifier (using case-insensitive comparison).
    static bool PositionFromString (const char *thePositionString, GccEnt_Position &thePosition)
     Determines the position from the given string identifier (using case-insensitive comparison).
    static GccEnt_QualifiedLin Unqualified (const gp_Lin2d &Obj)
     Constructs a qualified line, so that the relative position to the circle or line of the solution computed by a construction algorithm using the qualified circle or line is not qualified, i.e. all solutions apply.
    static GccEnt_QualifiedCirc Unqualified (const gp_Circ2d &Obj)
     Constructs a qualified circle so that the relative position to the circle or line of the solution computed by a construction algorithm using the qualified circle or line is not qualified, i.e. all solutions apply.
    static GccEnt_QualifiedCirc Enclosing (const gp_Circ2d &Obj)
     Constructs such a qualified circle that the solution computed by a construction algorithm using the qualified circle encloses the circle.
    static GccEnt_QualifiedLin Enclosed (const gp_Lin2d &Obj)
     Constructs a qualified line, so that the solution computed by a construction algorithm using the qualified circle or line is enclosed by the circle or line.
    static GccEnt_QualifiedCirc Enclosed (const gp_Circ2d &Obj)
     Constructs a qualified circle so that the solution computed by a construction algorithm using the qualified circle or line is enclosed by the circle or line.
    static GccEnt_QualifiedLin Outside (const gp_Lin2d &Obj)
     Constructs a qualified line, so that the solution computed by a construction algorithm using the qualified circle or line and the circle or line are external to one another.
    static GccEnt_QualifiedCirc Outside (const gp_Circ2d &Obj)
     Constructs a qualified circle so that the solution computed by a construction algorithm using the qualified circle or line and the circle or line are external to one another.

    Detailed Description

    This package provides an implementation of the qualified entities useful to create 2d entities with geometric constraints. The qualifier explains which subfamily of solutions we want to obtain. It uses the following law: the matter/the interior side is at the left of the line, if we go from the beginning to the end. The qualifiers are: Enclosing : the solution(s) must enclose the argument. Enclosed : the solution(s) must be enclosed in the argument. Outside : both the solution(s) and the argument must be outside to each other. Unqualified : the position is undefined, so give all the solutions. The use of a qualifier is always required if such subfamilies exist. For example, it is not used for a point. Note: the interior of a curve is defined as the left-hand side of the curve in relation to its orientation.

    Member Function Documentation

    ◆ Enclosed() [1/2]

    GccEnt_QualifiedCirc GccEnt::Enclosed ( const gp_Circ2d & Obj)
    static

    Constructs a qualified circle so that the solution computed by a construction algorithm using the qualified circle or line is enclosed by the circle or line.

    ◆ Enclosed() [2/2]

    GccEnt_QualifiedLin GccEnt::Enclosed ( const gp_Lin2d & Obj)
    static

    Constructs a qualified line, so that the solution computed by a construction algorithm using the qualified circle or line is enclosed by the circle or line.

    ◆ Enclosing()

    GccEnt_QualifiedCirc GccEnt::Enclosing ( const gp_Circ2d & Obj)
    static

    Constructs such a qualified circle that the solution computed by a construction algorithm using the qualified circle encloses the circle.

    ◆ Outside() [1/2]

    GccEnt_QualifiedCirc GccEnt::Outside ( const gp_Circ2d & Obj)
    static

    Constructs a qualified circle so that the solution computed by a construction algorithm using the qualified circle or line and the circle or line are external to one another.

    ◆ Outside() [2/2]

    GccEnt_QualifiedLin GccEnt::Outside ( const gp_Lin2d & Obj)
    static

    Constructs a qualified line, so that the solution computed by a construction algorithm using the qualified circle or line and the circle or line are external to one another.

    ◆ PositionFromString() [1/2]

    GccEnt_Position GccEnt::PositionFromString ( const char * thePositionString)
    inlinestatic

    Returns the position from the given string identifier (using case-insensitive comparison).

    Parameters
    thePositionStringstring identifier
    Returns
    position or GccEnt_unqualified if string identifier is invalid

    ◆ PositionFromString() [2/2]

    bool GccEnt::PositionFromString ( const char * thePositionString,
    GccEnt_Position & thePosition )
    static

    Determines the position from the given string identifier (using case-insensitive comparison).

    Parameters
    thePositionStringstring identifier
    thePositiondetected shape type
    Returns
    TRUE if string identifier is known

    ◆ PositionToString()

    const char * GccEnt::PositionToString ( GccEnt_Position thePosition)
    static

    Returns the string name for a given position.

    Parameters
    thePositionposition type
    Returns
    string identifier from the list UNQUALIFIED ENCLOSING ENCLOSED OUTSIDE NOQUALIFIER

    ◆ Print()

    Standard_OStream & GccEnt::Print ( const GccEnt_Position thePosition,
    Standard_OStream & theStream )
    inlinestatic

    Prints the name of Position type as a String on the Stream.

    ◆ Unqualified() [1/2]

    GccEnt_QualifiedCirc GccEnt::Unqualified ( const gp_Circ2d & Obj)
    static

    Constructs a qualified circle so that the relative position to the circle or line of the solution computed by a construction algorithm using the qualified circle or line is not qualified, i.e. all solutions apply.

    ◆ Unqualified() [2/2]

    GccEnt_QualifiedLin GccEnt::Unqualified ( const gp_Lin2d & Obj)
    static

    Constructs a qualified line, so that the relative position to the circle or line of the solution computed by a construction algorithm using the qualified circle or line is not qualified, i.e. all solutions apply.


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