OCC.GCPnts module¶

class
GCPnts_AbscissaPoint
(*args)¶ Bases:
object
Return type: None  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>.
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance.
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance.
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>.
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> is the starting value used in the iterative process which find the solution, it must be close to the final solution
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> is the starting value used in the iterative process which find the solution, it must be closed to the final solution
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> is the starting value used in the iterative process which find the solution, it must be close to the final solution
Parameters: Return type:  the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> is the starting value used in the iterative process which find the solution, it must be close to the final solution
Parameters: Return type: 
IsDone
()¶  True if the computation was successful, False otherwise. IsDone is a protection against:  nonconvergence of the algorithm  querying the results before computation.
Return type: bool

static
Length
(*args)¶  Computes the length of the Curve <C>.
Parameters: C (Adaptor3d_Curve &) – Return type: float  Computes the length of the Curve <C>.
Parameters: C (Adaptor2d_Curve2d &) – Return type: float  Computes the length of the Curve <C> with the given tolerance.
Parameters:  C (Adaptor3d_Curve &) –
 Tol (float) –
Return type:  Computes the length of the Curve <C> with the given tolerance.
Parameters:  C (Adaptor2d_Curve2d &) –
 Tol (float) –
Return type:  Computes the length of the Curve <C>.
Parameters: Return type:  Computes the length of the Curve <C>.
Parameters: Return type:  Computes the length of the Curve <C> with the given tolerance.
Parameters: Return type:  Computes the length of the Curve <C> with the given tolerance. Constructs an empty algorithm. This function is used only for initializing a framework to compute the length of a curve (or a series of curves). Warning The function IsDone will return the value false after the use of this function.
Parameters: Return type:

Parameter
()¶  Returns the parameter on the curve of the point solution of this algorithm. Exceptions StdFail_NotDone if the computation was not successful, or was not done.
Return type: float

thisown
¶ The membership flag

GCPnts_AbscissaPoint_Length
(*args)¶  Computes the length of the Curve <C>.
Parameters: C (Adaptor3d_Curve &) – Return type: float  Computes the length of the Curve <C>.
Parameters: C (Adaptor2d_Curve2d &) – Return type: float  Computes the length of the Curve <C> with the given tolerance.
Parameters:  C (Adaptor3d_Curve &) –
 Tol (float) –
Return type:  Computes the length of the Curve <C> with the given tolerance.
Parameters:  C (Adaptor2d_Curve2d &) –
 Tol (float) –
Return type:  Computes the length of the Curve <C>.
Parameters: Return type:  Computes the length of the Curve <C>.
Parameters: Return type:  Computes the length of the Curve <C> with the given tolerance.
Parameters: Return type:  Computes the length of the Curve <C> with the given tolerance. Constructs an empty algorithm. This function is used only for initializing a framework to compute the length of a curve (or a series of curves). Warning The function IsDone will return the value false after the use of this function.
Parameters: Return type:

class
GCPnts_QuasiUniformAbscissa
(*args)¶ Bases:
object
 Constructs an empty algorithm. To define the problem to be solved, use the function Initialize.
Return type: None  Computes a uniform abscissa distribution of points  on the curve C where Abscissa is the curvilinear distance between two consecutive points of the distribution.
Parameters:  C (Adaptor3d_Curve &) –
 NbPoints (int) –
Return type:  Computes a uniform abscissa distribution of points on the part of curve C limited by the two parameter values U1 and U2, where Abscissa is the curvilinear distance between two consecutive points of the distribution. The first point of the distribution is either the origin of curve C or the point of parameter U1. The following points are computed such that the curvilinear distance between two consecutive points is equal to Abscissa. The last point of the distribution is either the end point of curve C or the point of parameter U2. However the curvilinear distance between this last point and the point just preceding it in the distribution is, of course, generally not equal to Abscissa. Use the function IsDone to verify that the computation was successful, the function NbPoints to obtain the number of points of the computed distribution, and the function Parameter to read the parameter of each point. Warning The roles of U1 and U2 are inverted if U1 > U2 . Warning C is an adapted curve, that is, an object which is an interface between:  the services provided by either a 2D curve from the package Geom2d (in the case of an Adaptor2d_Curve2d curve) or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve),  and those required on the curve by the computation algorithm.
Parameters: Return type:  Computes a uniform abscissa distribution of points on the Curve2d <C>. <NbPoints> defines the nomber of desired points.
Parameters:  C (Adaptor2d_Curve2d &) –
 NbPoints (int) –
Return type:  Computes a Uniform abscissa distribution of points on a part of the Curve2d <C>.
Parameters: Return type: 
Initialize
()¶  Initialize the algoritms with <C>, <NbPoints> and
Parameters:  C (Adaptor3d_Curve &) –
 NbPoints (int) –
Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>.
Parameters: Return type:  Initialize the algoritms with <C>, <NbPoints> and
Parameters:  C (Adaptor2d_Curve2d &) –
 NbPoints (int) –
Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>.
Parameters: Return type:

IsDone
()¶  Returns true if the computation was successful. IsDone is a protection against:  nonconvergence of the algorithm  querying the results before computation.
Return type: bool

NbPoints
()¶  Returns the number of points of the distribution computed by this algorithm. This value is either:  the one imposed on the algorithm at the time of construction (or initialization), or  the one computed by the algorithm when the curvilinear distance between two consecutive points of the distribution is imposed on the algorithm at the time of construction (or initialization). Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Return type: int

Parameter
()¶  Returns the parameter of the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Parameters: Index (int) – Return type: float

thisown
¶ The membership flag

class
GCPnts_QuasiUniformDeflection
(*args)¶ Bases:
object
 Constructs an empty algorithm. To define the problem to be solved, use the function Initialize.
Return type: None  Computes a QuasiUniform Deflection distribution of points on the Curve <C>.
Parameters:  C (Adaptor3d_Curve &) –
 Deflection (float) –
 Continuity (GeomAbs_Shape) – default value is GeomAbs_C1
Return type:  Computes a QuasiUniform Deflection distribution of points on the Curve <C>.
Parameters:  C (Adaptor2d_Curve2d &) –
 Deflection (float) –
 Continuity (GeomAbs_Shape) – default value is GeomAbs_C1
Return type:  Computes a QuasiUniform Deflection distribution of points on a part of the Curve <C>.
Parameters: Return type:  Computes a QuasiUniform Deflection distribution of points on a part of the Curve <C>. This and the above algorithms compute a distribution of points:  on the curve C, or  on the part of curve C limited by the two parameter values U1 and U2, where the deflection resulting from the distributed points is not greater than Deflection. The first point of the distribution is either the origin of curve C or the point of parameter U1. The last point of the distribution is either the end point of curve C or the point of parameter U2. Intermediate points of the distribution are built such that the deflection is not greater than Deflection. Using the following evaluation of the deflection: if Pi and Pj are two consecutive points of the distribution, respectively of parameter ui and uj on the curve, the deflection is the distance between:  the midpoint of Pi and Pj (the center of the chord joining these two points)  and the point of midparameter of these two points (the point of parameter [(ui+uj) / 2 ] on curve C). Continuity, defaulted to GeomAbs_C1, gives the degree of continuity of the curve C. (Note that C is an Adaptor3d_Curve or an Adaptor2d_Curve2d object, and does not know the degree of continuity of the underlying curve). Use the function IsDone to verify that the computation was successful, the function NbPoints to obtain the number of points of the computed distribution, and the function Parameter to read the parameter of each point. Warning  The roles of U1 and U2 are inverted if U1 > U2.  Derivative functions on the curve are called according to Continuity. An error may occur if Continuity is greater than the real degree of continuity of the curve. Warning C is an adapted curve, i.e. an object which is an interface between:  the services provided by either a 2D curve from the package Geom2d (in the case of an Adaptor2d_Curve2d curve) or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve),  and those required on the curve by the computation algorithm.
Parameters: Return type: 
Deflection
()¶  Returns the deflection between the curve and the polygon resulting from the points of the distribution computed by this algorithm. This is the value given to the algorithm at the time of construction (or initialization). Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Return type: float

Initialize
()¶  Initialize the algoritms with <C>, <Deflection>
Parameters:  C (Adaptor3d_Curve &) –
 Deflection (float) –
 Continuity (GeomAbs_Shape) – default value is GeomAbs_C1
Return type:  Initialize the algoritms with <C>, <Deflection>
Parameters:  C (Adaptor2d_Curve2d &) –
 Deflection (float) –
 Continuity (GeomAbs_Shape) – default value is GeomAbs_C1
Return type:  Initialize the algoritms with <C>, <Deflection>, <U1>,<U2>
Parameters: Return type:  Initialize the algoritms with <C>, <Deflection>, – <U1>,<U2> This and the above algorithms initialize (or reinitialize) this algorithm and compute a distribution of points:  on the curve C, or  on the part of curve C limited by the two parameter values U1 and U2, where the deflection resulting from the distributed points is not greater than Deflection. The first point of the distribution is either the origin of curve C or the point of parameter U1. The last point of the distribution is either the end point of curve C or the point of parameter U2. Intermediate points of the distribution are built in such a way that the deflection is not greater than Deflection. Using the following evaluation of the deflection: if Pi and Pj are two consecutive points of the distribution, respectively of parameter ui and uj on the curve, the deflection is the distance between:  the midpoint of Pi and Pj (the center of the chord joining these two points)  and the point of midparameter of these two points (the point of parameter [(ui+uj) / 2 ] on curve C). Continuity, defaulted to GeomAbs_C1, gives the degree of continuity of the curve C. (Note that C is an Adaptor3d_Curve or an Adaptor2d_Curve2d object, and does not know the degree of continuity of the underlying curve). Use the function IsDone to verify that the computation was successful, the function NbPoints to obtain the number of points of the computed distribution, and the function Parameter to read the parameter of each point. Warning  The roles of U1 and U2 are inverted if U1 > U2.  Derivative functions on the curve are called according to Continuity. An error may occur if Continuity is greater than the real degree of continuity of the curve. Warning C is an adapted curve, i.e. an object which is an interface between:  the services provided by either a 2D curve from the package Geom2d (in the case of an Adaptor2d_Curve2d curve) or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve), and those required on the curve by the computation algorithm.
Parameters: Return type:

IsDone
()¶  Returns true if the computation was successful. IsDone is a protection against:  nonconvergence of the algorithm  querying the results before computation.
Return type: bool

NbPoints
()¶  Returns the number of points of the distribution computed by this algorithm. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Return type: int

Parameter
()¶  Returns the parameter of the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Parameters: Index (int) – Return type: float

Value
()¶  Returns the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Parameters: Index (int) – Return type: gp_Pnt

thisown
¶ The membership flag

class
GCPnts_TangentialDeflection
(*args)¶ Bases:
object
Return type: Parameters:  C (Adaptor2d_Curve2d &) –
 AngularDeflection (float) –
 CurvatureDeflection (float) –
 MinimumOfPoints (int) – default value is 2
 UTol (float) – default value is 1.0e9
 C –
 FirstParameter (float) –
 LastParameter (float) –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
 C –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
 C –
 FirstParameter –
 LastParameter –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
Return type: Return type: Return type: Return type: 
AddPoint
()¶  Add point to already calculated points (or replace existing) Returns index of new added point or founded with parametric tolerance (replaced if theIsReplace is true)
Parameters: Return type:

Initialize
()¶ Parameters:  C (Adaptor2d_Curve2d &) –
 AngularDeflection (float) –
 CurvatureDeflection (float) –
 MinimumOfPoints (int) – default value is 2
 UTol (float) – default value is 1.0e9
 C –
 FirstParameter (float) –
 LastParameter (float) –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
 C –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
 C –
 FirstParameter –
 LastParameter –
 AngularDeflection –
 CurvatureDeflection –
 MinimumOfPoints – default value is 2
 UTol – default value is 1.0e9
Return type: Return type: Return type: Return type:

thisown
¶ The membership flag

class
GCPnts_UniformAbscissa
(*args)¶ Bases:
object
 creation of a indefinite UniformAbscissa
Return type: None  Computes a uniform abscissa distribution of points on the Curve <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a Uniform abscissa distribution of points on a part of the Curve <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a uniform abscissa distribution of points on the Curve <C>. <NbPoints> defines the nomber of desired points. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a Uniform abscissa distribution of points on a part of the Curve <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a uniform abscissa distribution of points on the Curve2d <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a Uniform abscissa distribution of points on a part of the Curve2d <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a uniform abscissa distribution of points on the Curve2d <C>. <NbPoints> defines the nomber of desired points. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type:  Computes a Uniform abscissa distribution of points on a part of the Curve2d <C>. Parameter Toler is equal Precision::Confusion by default. It Is used for more precise calculation of curve length
Parameters: Return type: 
Abscissa
()¶  returne the current abscissa ie the distance between two consecutive points
Return type: float

Initialize
()¶  Initialize the algoritms with <C>, <Abscissa>, <Toler>
Parameters: Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>, <Toler>
Parameters: Return type:  Initialize the algoritms with <C>, <NbPoints>, <Toler> and
Parameters: Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>, <Toler>.
Parameters: Return type:  Initialize the algoritms with <C>, <Abscissa>, <Toler>
Parameters: Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>, <Toler>
Parameters: Return type:  Initialize the algoritms with <C>, <NbPoints>, <Toler> and
Parameters: Return type:  Initialize the algoritms with <C>, <Abscissa>, <U1>, <U2>, <Toler>.
Parameters: Return type:

Parameter
()¶  returns the computed Parameter of index <Index>.
Parameters: Index (int) – Return type: float

thisown
¶ The membership flag

class
GCPnts_UniformDeflection
(*args)¶ Bases:
object
 Constructs an empty algorithm. To define the problem to be solved, use the function Initialize.
Return type: None  Computes a uniform Deflection distribution of points on the Curve <C>. if <WithControl> is True,the algorithm controls the estimate deflection
Parameters: Return type:  Computes a uniform Deflection distribution of points on the Curve <C>. if <WithControl> is True,the algorithm controls the estimate deflection
Parameters: Return type:  Computes a Uniform Deflection distribution of points on a part of the Curve <C>. if <WithControl> is True,the algorithm controls the estimate deflection
Parameters: Return type:  Computes a Uniform Deflection distribution of points on a part of the Curve <C>. if <WithControl> is True,the algorithm controls the estimate deflection
Parameters: Return type: 
Deflection
()¶  Returns the deflection between the curve and the polygon resulting from the points of the distribution computed by this algorithm. This value is the one given to the algorithm at the time of construction (or initialization). Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Return type: float

Initialize
()¶  Initialize the algoritms with <C>, <Deflection>
Parameters: Return type:  Initialize the algoritms with <C>, <Deflection>
Parameters: Return type:  Initialize the algoritms with <C>, <Deflection>, <U1>,<U2>
Parameters: Return type:  Initialize the algoritms with <C>, <Deflection>, <U1>,<U2> This and the above methods initialize (or reinitialize) this algorithm and compute a distribution of points:  on the curve C, or  on the part of curve C limited by the two parameter values U1 and U2, where the maximum distance between C and the polygon that results from the points of the distribution is not greater than Deflection. The first point of the distribution is either the origin of curve C or the point of parameter U1. The last point of the distribution is either the end point of curve C or the point of parameter U2. Intermediate points of the distribution are built using interpolations of segments of the curve limited at the 2nd degree. The construction ensures, in a first step, that the chordal deviation for this interpolation of the curve is less than or equal to Deflection. However, it does not ensure that the chordal deviation for the curve itself is less than or equal to Deflection. To do this a check is necessary, which may generate (second step) additional intermediate points. This check is time consuming, and can be avoided by setting WithControl to false. Note that by default WithControl is true and check is performed. Use the function IsDone to verify that the computation was successful, the function NbPoints to obtain the number of points of the computed distribution, and the function Parameter to read the parameter of each point. Warning  C is necessary, ‘C2’ continuous. This property is not checked at construction time.  The roles of U1 and U2 are inverted if U1 > U2. Warning C is an adapted curve, i.e. an object which is an interface between:  the services provided by either a 2D curve from the package Geom2d (in the case of an Adaptor2d_Curve2d curve) or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve),  and those required on the curve by the computation algorithm.
Parameters: Return type:

IsDone
()¶  Returns true if the computation was successful. IsDone is a protection against:  nonconvergence of the algorithm  querying the results before computation.
Return type: bool

NbPoints
()¶  Returns the number of points of the distribution computed by this algorithm. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Return type: int

Parameter
()¶  Returns the parameter of the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Parameters: Index (int) – Return type: float

Value
()¶  Returns the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFAil_NotDone if this algorithm has not been initialized, or if the computation was not successful.
Parameters: Index (int) – Return type: gp_Pnt

thisown
¶ The membership flag

class
SwigPyIterator
(*args, **kwargs)¶ Bases:
object

advance
()¶

copy
()¶

decr
()¶

distance
()¶

equal
()¶

incr
()¶

next
()¶

previous
()¶

thisown
¶ The membership flag

value
()¶


register_handle
(handle, base_object)¶ Inserts the handle into the base object to prevent memory corruption in certain cases