GccEnt

OCCT package GccEnt: GccEnt, GccEnt_BadQualifier, GccEnt_Position, GccEnt_QualifiedCirc, and 1 more bound classes.

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.

Constructors(1)

constructor(): GccEnt

Static methods(10)

PositionToString(thePosition: GccEnt_Position): string
Returns the string name for a given position.
Parameters (1)
- thePosition —
  position type
Returns
string identifier from the list UNQUALIFIED ENCLOSING ENCLOSED OUTSIDE NOQUALIFIER
PositionFromString(thePositionString: string): GccEnt_Position
Returns the position from the given string identifier (using case-insensitive comparison).
Parameters (1)
- thePositionString —
  string identifier
Returns
position or GccEnt_unqualified if string identifier is invalid
PositionFromString(thePositionString: string, thePosition?: GccEnt_Position): { returnValue: boolean; thePosition: GccEnt_Position }
Determines the position from the given string identifier (using case-insensitive comparison).
Parameters (2)
- thePositionString —
  string identifier
- thePosition —
  detected shape type
Returns
A result object with fields:
- returnValue: TRUE if string identifier is known
- thePosition: detected shape type
Unqualified(Obj: gp_Lin2d): GccEnt_QualifiedLin
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.
Parameters (1)
- Obj
Unqualified(Obj: gp_Circ2d): GccEnt_QualifiedCirc
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.
Parameters (1)
- Obj
Enclosing(Obj: gp_Circ2d): GccEnt_QualifiedCirc
Constructs such a qualified circle that the solution computed by a construction algorithm using the qualified circle encloses the circle.
Parameters (1)
- Obj
Enclosed(Obj: gp_Lin2d): GccEnt_QualifiedLin
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.
Parameters (1)
- Obj
Enclosed(Obj: gp_Circ2d): GccEnt_QualifiedCirc
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.
Parameters (1)
- Obj
Outside(Obj: gp_Lin2d): GccEnt_QualifiedLin
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.
Parameters (1)
- Obj
Outside(Obj: gp_Circ2d): GccEnt_QualifiedCirc
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.
Parameters (1)
- Obj

GccEnt_BadQualifier

Standard_DomainErrorStandard_Failureexception

Constructors(2)

constructor(theMessage: string): GccEnt_BadQualifier
Parameters (1)
- theMessage
constructor(theMessage: string, theStackTrace: string): GccEnt_BadQualifier
Parameters (2)
- theMessage
- theStackTrace

Instance methods(1)

ExceptionType(): string

GccEnt_Position

Properties(5)

GccEnt_unqualified:'GccEnt_unqualified'readonly
GccEnt_enclosing:'GccEnt_enclosing'readonly
GccEnt_enclosed:'GccEnt_enclosed'readonly
GccEnt_outside:'GccEnt_outside'readonly
GccEnt_noqualifier:'GccEnt_noqualifier'readonly

GccEnt_QualifiedCirc

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

Constructors(1)

constructor(Qualified: gp_Circ2d, Qualifier: GccEnt_Position): GccEnt_QualifiedCirc
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.
Parameters (2)
- Qualified
- Qualifier

Instance methods(6)

Qualified(): gp_Circ2d
Returns a 2D circle to which the qualifier is assigned.
Qualifier(): GccEnt_Position
Returns.
- the qualifier of this qualified circle, if it is enclosing, enclosed or outside, or
- GccEnt_noqualifier if it is unqualified.
IsUnqualified(): boolean
Returns true if the Circ2d is Unqualified and false in the other cases.
IsEnclosing(): boolean
Returns true if the solution computed by a construction algorithm using this qualified circle encloses the circle.
IsEnclosed(): boolean
Returns true if the solution computed by a construction algorithm using this qualified circle is enclosed by the circle.
IsOutside(): boolean
Returns true if both the solution computed by a construction algorithm using this qualified circle and the circle are external to one another.

GccEnt_QualifiedLin

Describes a qualified 2D line. A qualified 2D line is a line (gp_Lin2d line) with a qualifier which specifies whether the solution of a construction algorithm using the qualified line (as an argument):

is 'enclosed' by the line, or
is built so that both the line and it are external to one another, or
is undefined (all solutions apply). Note: the interior of a line is defined as the left-hand side of the line in relation to its orientation (i.e. when moving from the start to the end of the curve).

Constructors(1)

constructor(Qualified: gp_Lin2d, Qualifier: GccEnt_Position): GccEnt_QualifiedLin
Constructs a qualified line by assigning the qualifier Qualifier to the line Qualified. Qualifier may be:
- GccEnt_enclosed if the solution is enclosed by the line, or
- GccEnt_outside if both the solution and the line are external to one another, or
- GccEnt_unqualified if all solutions apply. Note : the interior of a line is defined as the left-hand side of the line in relation to its orientation.
Parameters (2)
- Qualified
- Qualifier

Instance methods(5)

Qualified(): gp_Lin2d
Returns a 2D line to which the qualifier is assigned.
Qualifier(): GccEnt_Position
Returns the qualifier of this qualified line, if it is "enclosed" or "outside", or.
- GccEnt_noqualifier if it is unqualified.
IsUnqualified(): boolean
Returns true if the solution is unqualified and false in the other cases.
IsEnclosed(): boolean
Returns true if the solution is Enclosed in the Lin2d and false in the other cases.
IsOutside(): boolean
Returns true if the solution is Outside the Lin2d and false in the other cases.