OCC.Core.GeomAPI module¶

GeomAPI module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_geomapi.html

class GeomAPI_ExtremaCurveCurve(*args)¶

Bases: object

Constructs an empty algorithm for computing extrema between two curves. Use an Init function to define the curves on which it is going to work.

rtype

None* Computes the extrema between the curves C1 and C2.

param C1

type C1

Geom_Curve

param C2

type C2

Geom_Curve

rtype

None* Computes the portion of the curve C1 limited by the two points of parameter (U1min,U1max), and - the portion of the curve C2 limited by the two points of parameter (U2min,U2max). Warning Use the function NbExtrema to obtain the number of solutions. If this algorithm fails, NbExtrema returns 0.

param C1

type C1

Geom_Curve

param C2

type C2

Geom_Curve

param U1min

type U1min

float

param U1max

type U1max

float

param U2min

type U2min

float

param U2max

type U2max

float

rtype

None

Distance()¶

Computes the distance between the end points of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

rtype

float

Extrema()¶

return the algorithmic object from Extrema

rtype

Extrema_ExtCC

Init()¶

Initializes this algorithm with the given arguments and computes the extrema between the curves C1 and C2

param C1

type C1

Geom_Curve

param C2

type C2

Geom_Curve

rtype

None* Initializes this algorithm with the given arguments and computes the extrema between : - the portion of the curve C1 limited by the two points of parameter (U1min,U1max), and - the portion of the curve C2 limited by the two points of parameter (U2min,U2max). Warning Use the function NbExtrema to obtain the number of solutions. If this algorithm fails, NbExtrema returns 0.

param C1

type C1

Geom_Curve

param C2

type C2

Geom_Curve

param U1min

type U1min

float

param U1max

type U1max

float

param U2min

type U2min

float

param U2max

type U2max

float

rtype

None

LowerDistance()¶

Computes the distance between the end points of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

rtype

float

LowerDistanceParameters()¶

Returns the parameters U1 of the point on the first curve and U2 of the point on the second curve, which are the ends of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

param U1

type U1

float

param U2

type U2

float

rtype

None

NbExtrema()¶

Returns the number of extrema computed by this algorithm. Note: if this algorithm fails, NbExtrema returns 0.

rtype

int

NearestPoints()¶

Returns the points P1 on the first curve and P2 on the second curve, which are the ends of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

None

Parameters()¶

Returns the parameters U1 of the point on the first curve and U2 of the point on the second curve, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param U1

type U1

float

param U2

type U2

float

rtype

None

Points()¶

Returns the points P1 on the first curve and P2 on the second curve, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

None

TotalLowerDistance()¶

return the distance of the total nearest couple solution point. if <myExtCC> is not done

rtype

float

TotalLowerDistanceParameters()¶

set in <U1> and <U2> the parameters of the couple solution points which represents the total nearest solution.

param U1

type U1

float

param U2

type U2

float

rtype

bool

TotalNearestPoints()¶

set in <P1> and <P2> the couple solution points such a the distance [P1,P2] is the minimum. taking in account extremity points of curves.

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

bool

property thisown¶: The membership flag

class GeomAPI_ExtremaCurveSurface(*args)¶

Bases: object

Constructs an empty algorithm for computing extrema between a curve and a surface. Use an Init function to define the curve and the surface on which it is going to work.

rtype

None* Computes the extrema distances between the curve <C> and the surface <S>.

param Curve

type Curve

Geom_Curve

param Surface

type Surface

Geom_Surface

rtype

None* Computes the extrema distances between the curve <C> and the surface <S>. The solution point are computed in the domain [Wmin,Wmax] of the curve and in the domain [Umin,Umax] [Vmin,Vmax] of the surface. Warning Use the function NbExtrema to obtain the number of solutions. If this algorithm fails, NbExtrema returns 0.

param Curve

type Curve

Geom_Curve

param Surface

type Surface

Geom_Surface

param Wmin

type Wmin

float

param Wmax

type Wmax

float

param Umin

type Umin

float

param Umax

type Umax

float

param Vmin

type Vmin

float

param Vmax

type Vmax

float

rtype

None

Distance()¶

Computes the distance between the end points of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

rtype

float

Extrema()¶

Missing detailed docstringic object from Extrema

rtype

Extrema_ExtCS

Init()¶

Computes the extrema distances between the curve <C> and the surface <S>.

param Curve

type Curve

Geom_Curve

param Surface

type Surface

Geom_Surface

rtype

None* Computes the extrema distances between the curve <C> and the surface <S>. The solution point are computed in the domain [Wmin,Wmax] of the curve and in the domain [Umin,Umax] [Vmin,Vmax] of the surface. Warning Use the function NbExtrema to obtain the number of solutions. If this algorithm fails, NbExtrema returns 0.

param Curve

type Curve

Geom_Curve

param Surface

type Surface

Geom_Surface

param Wmin

type Wmin

float

param Wmax

type Wmax

float

param Umin

type Umin

float

param Umax

type Umax

float

param Vmin

type Vmin

float

param Vmax

type Vmax

float

rtype

None

LowerDistance()¶

Computes the distance between the end points of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.

rtype

float

LowerDistanceParameters()¶

Returns the parameters W of the point on the curve and (U,V) of the point on the surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.

param W

type W

float

param U

type U

float

param V

type V

float

rtype

None

NbExtrema()¶

Returns the number of extrema computed by this algorithm. Note: if this algorithm fails, NbExtrema returns 0.

rtype

int

NearestPoints()¶

Returns the points PC on the curve and PS on the surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.

param PC

type PC

gp_Pnt

param PS

type PS

gp_Pnt

rtype

None

Parameters()¶

Returns the parameters W of the point on the curve, and (U,V) of the point on the surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param W

type W

float

param U

type U

float

param V

type V

float

rtype

None

Points()¶

Returns the points P1 on the curve and P2 on the surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

None

property thisown¶: The membership flag

class GeomAPI_ExtremaSurfaceSurface(*args)¶

Bases: object

Constructs an empty algorithm for computing extrema between two surfaces. Use an Init function to define the surfaces on which it is going to work.

rtype

None* Computes the extrema distances between the surfaces <S1> and <S2>

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

rtype

None* Computes the extrema distances between the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and - the portion of the surface S2 limited by the two values of parameter (U2min,U2max) in the u parametric direction, and by the two values of parameter (V2min,V2max) in the v parametric direction.

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

param U1min

type U1min

float

param U1max

type U1max

float

param V1min

type V1min

float

param V1max

type V1max

float

param U2min

type U2min

float

param U2max

type U2max

float

param V2min

type V2min

float

param V2max

type V2max

float

rtype

None

Distance()¶

Computes the distance between the end points of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

rtype

float

Extrema()¶

return the algorithmic object from Extrema

rtype

Extrema_ExtSS

Init()¶

Initializes this algorithm with the given arguments and computes the extrema distances between the surfaces <S1> and <S2>

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

rtype

None* Initializes this algorithm with the given arguments and computes the extrema distances between - the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and - the portion of the surface S2 limited by the two values of parameter (U2min,U2max) in the u parametric direction, and by the two values of parameter (V2min,V2max) in the v parametric direction.

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

param U1min

type U1min

float

param U1max

type U1max

float

param V1min

type V1min

float

param V1max

type V1max

float

param U2min

type U2min

float

param U2max

type U2max

float

param V2min

type V2min

float

param V2max

type V2max

float

rtype

None

LowerDistance()¶

Computes the distance between the end points of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

rtype

float

LowerDistanceParameters()¶

Returns the parameters (U1,V1) of the point on the first surface and (U2,V2) of the point on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.

param U1

type U1

float

param V1

type V1

float

param U2

type U2

float

param V2

type V2

float

rtype

None

NbExtrema()¶

Returns the number of extrema computed by this algorithm. Note: if this algorithm fails, NbExtrema returns 0.

rtype

int

NearestPoints()¶

Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

None

Parameters()¶

Returns the parameters (U1,V1) of the point on the first surface, and (U2,V2) of the point on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param U1

type U1

float

param V1

type V1

float

param U2

type U2

float

param V2

type V2

float

rtype

None

Points()¶

Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

param Index

type Index

int

param P1

type P1

gp_Pnt

param P2

type P2

gp_Pnt

rtype

None

property thisown¶: The membership flag

class GeomAPI_IntCS(*args)¶

Bases: object

Creates an empty object. Use the function Perform for further initialization of the algorithm by the curve and the surface.

rtype

None* Computes the intersections between the curve C and the surface S. Warning Use function IsDone to verify that the intersections are computed successfully.

param C

type C

Geom_Curve

param S

type S

Geom_Surface

rtype

None

IsDone()¶

Returns true if the intersections are successfully computed.

rtype

bool

NbPoints()¶

Returns the number of Intersection Points if IsDone returns True. else NotDone is raised.

rtype

int

NbSegments()¶

Returns the number of computed intersection segments in case of tangential intersection. Exceptions StdFail_NotDone if the intersection algorithm fails or is not initialized.

rtype

int

Parameters()¶

Returns parameter W on the curve and (parameters U,V) on the surface of the computed intersection point of index Index in case of cross intersection. Exceptions StdFail_NotDone if intersection algorithm fails or is not initialized. Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of computed intersection points.

param Index

type Index

int

param U

type U

float

param V

type V

float

param W

type W

float

rtype

None* Returns the parameters of the first (U1,V1) and the last (U2,V2) points of curve’s segment on the surface in case of tangential intersection. Index is the number of computed intersection segments. Exceptions StdFail_NotDone if intersection algorithm fails or is not initialized. Standard_OutOfRange if Index is not in the range [ 1,NbSegments ], where NbSegments is the number of computed intersection segments.

param Index

type Index

int

param U1

type U1

float

param V1

type V1

float

param U2

type U2

float

param V2

type V2

float

rtype

None

Perform()¶

This function Initializes an algorithm with the curve C and the surface S and computes the intersections between C and S. Warning Use function IsDone to verify that the intersections are computed successfully.

param C

type C

Geom_Curve

param S

type S

Geom_Surface

rtype

None

Point()¶

Returns the Intersection Point of range <Index>in case of cross intersection. Raises NotDone if the computation has failed or if the computation has not been done raises OutOfRange if Index is not in the range <1..NbPoints>

param Index

type Index

int

rtype

gp_Pnt

Segment()¶

Returns the computed intersection segment of index Index in case of tangential intersection. Intersection segment is a portion of the initial curve tangent to surface. Exceptions StdFail_NotDone if intersection algorithm fails or is not initialized. Standard_OutOfRange if Index is not in the range [ 1,NbSegments ], where NbSegments is the number of computed intersection segments.

param Index

type Index

int

rtype

opencascade::handle<Geom_Curve>

property thisown¶: The membership flag

class GeomAPI_IntSS(*args)¶

Bases: object

Constructs an empty object. Use the function Perform for further initialization algorithm by two surfaces.

rtype

None* Computes the intersection curves between the two surfaces S1 and S2. Parameter Tol defines the precision of curves computation. For most cases the value 1.0e-7 is recommended to use. Warning Use the function IsDone to verify that the intersections are successfully computed.I

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

param Tol

type Tol

float

rtype

None

IsDone()¶

Returns True if the intersection was successful.

rtype

bool

Line()¶

Returns the computed intersection curve of index Index. Exceptions StdFail_NotDone if the computation fails. Standard_OutOfRange if Index is out of range [1, NbLines] where NbLines is the number of computed intersection curves.

param Index

type Index

int

rtype

opencascade::handle<Geom_Curve>

NbLines()¶

Returns the number of computed intersection curves. Exceptions StdFail_NotDone if the computation fails.

rtype

int

Perform()¶

Initializes an algorithm with the given arguments and computes the intersection curves between the two surfaces S1 and S2. Parameter Tol defines the precision of curves computation. For most cases the value 1.0e-7 is recommended to use. Warning Use function IsDone to verify that the intersections are successfully computed.

param S1

type S1

Geom_Surface

param S2

type S2

Geom_Surface

param Tol

type Tol

float

rtype

None

property thisown¶: The membership flag

class GeomAPI_Interpolate(*args)¶

Bases: object

Initializes an algorithm for constructing a constrained BSpline curve passing through the points of the table Points. Tangential vectors can then be assigned, using the function Load. If PeriodicFlag is true, the constrained BSpline curve will be periodic and closed. In this case, the junction point is the first point of the table Points. The tolerance value Tolerance is used to check that: - points are not too close to each other, or - tangential vectors (defined using the function Load) are not too small. The resulting BSpline curve will be ‘C2’ continuous, except where a tangency constraint is defined on a point through which the curve passes (by using the Load function). In this case, it will be only ‘C1’ continuous. Once all the constraints are defined, use the function Perform to compute the curve. Warning - There must be at least 2 points in the table Points. - If PeriodicFlag is false, there must be as many parameters in the array Parameters as there are points in the array Points. - If PeriodicFlag is true, there must be one more parameter in the table Parameters: this is used to give the parameter on the resulting BSpline curve of the junction point of the curve (which is also the first point of the table Points). Exceptions - Standard_ConstructionError if the distance between two consecutive points in the table Points is less than or equal to Tolerance. - Standard_OutOfRange if: - there are less than two points in the table Points, or - conditions relating to the respective number of elements in the parallel tables Points and Parameters are not respected.

param Points

type Points

TColgp_HArray1OfPnt

param PeriodicFlag

type PeriodicFlag

bool

param Tolerance

type Tolerance

float

rtype

None* Initializes an algorithm for constructing a constrained BSpline curve passing through the points of the table Points, where the parameters of each of its points are given by the parallel table Parameters. Tangential vectors can then be assigned, using the function Load. If PeriodicFlag is true, the constrained BSpline curve will be periodic and closed. In this case, the junction point is the first point of the table Points. The tolerance value Tolerance is used to check that: - points are not too close to each other, or - tangential vectors (defined using the function Load) are not too small. The resulting BSpline curve will be ‘C2’ continuous, except where a tangency constraint is defined on a point through which the curve passes (by using the Load function). In this case, it will be only ‘C1’ continuous. Once all the constraints are defined, use the function Perform to compute the curve. Warning - There must be at least 2 points in the table Points. - If PeriodicFlag is false, there must be as many parameters in the array Parameters as there are points in the array Points. - If PeriodicFlag is true, there must be one more parameter in the table Parameters: this is used to give the parameter on the resulting BSpline curve of the junction point of the curve (which is also the first point of the table Points). Exceptions - Standard_ConstructionError if the distance between two consecutive points in the table Points is less than or equal to Tolerance. - Standard_OutOfRange if: - there are less than two points in the table Points, or - conditions relating to the respective number of elements in the parallel tables Points and Parameters are not respected.

param Points

type Points

TColgp_HArray1OfPnt

param Parameters

type Parameters

TColStd_HArray1OfReal

param PeriodicFlag

type PeriodicFlag

bool

param Tolerance

type Tolerance

float

rtype

None

Curve()¶

Returns the computed BSpline curve. Raises StdFail_NotDone if the interpolation fails.

rtype

opencascade::handle<Geom_BSplineCurve>

IsDone()¶

Returns true if the constrained BSpline curve is successfully constructed. Note: in this case, the result is given by the function Curve.

rtype

bool

Load()¶

Assigns this constrained BSpline curve to be tangential to vectors InitialTangent and FinalTangent at its first and last points respectively (i.e. the first and last points of the table of points through which the curve passes, as defined at the time of initialization).

param InitialTangent

type InitialTangent

gp_Vec

param FinalTangent

type FinalTangent

gp_Vec

param Scale

default value is Standard_True

type Scale

bool

rtype

None* Assigns this constrained BSpline curve to be tangential to vectors defined in the table Tangents, which is parallel to the table of points through which the curve passes, as defined at the time of initialization. Vectors in the table Tangents are defined only if the flag given in the parallel table TangentFlags is true: only these vectors are set as tangency constraints.

param Tangents

type Tangents

TColgp_Array1OfVec

param TangentFlags

type TangentFlags

TColStd_HArray1OfBoolean

param Scale

default value is Standard_True

type Scale

bool

rtype

None

Perform()¶

Computes the constrained BSpline curve. Use the function IsDone to verify that the computation is successful, and then the function Curve to obtain the result.

rtype

None

property thisown¶: The membership flag

class GeomAPI_PointsToBSpline(*args)¶

Bases: object

Constructs an empty approximation algorithm. Use an Init function to define and build the BSpline curve.

rtype

None* Approximate a BSpline Curve passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param ParType

type ParType

Approx_ParametrizationType

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point, which parameters are given by the array <Parameters>. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param Parameters

type Parameters

TColStd_Array1OfReal

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point using variational smoothing algorithm, which tries to minimize additional criterium: Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion

param Points

type Points

TColgp_Array1OfPnt

param Weight1

type Weight1

float

param Weight2

type Weight2

float

param Weight3

type Weight3

float

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None

Curve()¶

Returns the computed BSpline curve. Raises StdFail_NotDone if the curve is not built.

rtype

opencascade::handle<Geom_BSplineCurve>

Init()¶

Approximate a BSpline Curve passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param ParType

type ParType

Approx_ParametrizationType

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point, which parameters are given by the array <Parameters>. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D

param Points

type Points

TColgp_Array1OfPnt

param Parameters

type Parameters

TColStd_Array1OfReal

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximate a BSpline Curve passing through an array of Point using variational smoothing algorithm, which tries to minimize additional criterium: Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion

param Points

type Points

TColgp_Array1OfPnt

param Weight1

type Weight1

float

param Weight2

type Weight2

float

param Weight3

type Weight3

float

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None

IsDone()¶

Return type: bool

property thisown¶: The membership flag

class GeomAPI_PointsToBSplineSurface(*args)¶

Bases: object

Constructs an empty algorithm for approximation or interpolation of a surface. Use: - an Init function to define and build the BSpline surface by approximation, or - an Interpolate function to define and build the BSpline surface by interpolation.

rtype

None* Approximates a BSpline Surface passing through an array of Points. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D.

param Points

type Points

TColgp_Array2OfPnt

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximates a BSpline Surface passing through an array of Points. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D.

param Points

type Points

TColgp_Array2OfPnt

param ParType

type ParType

Approx_ParametrizationType

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximates a BSpline Surface passing through an array of points using variational smoothing algorithm, which tries to minimize additional criterium: Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion.

param Points

type Points

TColgp_Array2OfPnt

param Weight1

type Weight1

float

param Weight2

type Weight2

float

param Weight3

type Weight3

float

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximates a BSpline Surface passing through an array of Points. //! The points will be constructed as follow: P(i,j) = gp_Pnt( X0 + (i-1)*dX , Y0 + (j-1)*dY , ZPoints(i,j) ) //! The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D 4- the parametrization of the surface will verify: S->Value( U, V) = gp_Pnt( U, V, Z(U,V) );

param ZPoints

type ZPoints

TColStd_Array2OfReal

param X0

type X0

float

param dX

type dX

float

param Y0

type Y0

float

param dY

type dY

float

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None

Init()¶

Approximates a BSpline Surface passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D.

param Points

type Points

TColgp_Array2OfPnt

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximates a BSpline Surface passing through an array of Points. //! The points will be constructed as follow: P(i,j) = gp_Pnt( X0 + (i-1)*dX , Y0 + (j-1)*dY , ZPoints(i,j) ) //! The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D 4- the parametrization of the surface will verify: S->Value( U, V) = gp_Pnt( U, V, Z(U,V) );

param ZPoints

type ZPoints

TColStd_Array2OfReal

param X0

type X0

float

param dX

type dX

float

param Y0

type Y0

float

param dY

type dY

float

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None* Approximates a BSpline Surface passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be in the range [Degmin,Degmax] 2- his continuity will be at least <Continuity> 3- the distance from the point <Points> to the BSpline will be lower to Tol3D.

param Points

type Points

TColgp_Array2OfPnt

param ParType

type ParType

Approx_ParametrizationType

param DegMin

default value is 3

type DegMin

int

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

param thePeriodic

default value is Standard_False

type thePeriodic

bool

rtype

None* Approximates a BSpline Surface passing through an array of point using variational smoothing algorithm, which tries to minimize additional criterium: Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion.

param Points

type Points

TColgp_Array2OfPnt

param Weight1

type Weight1

float

param Weight2

type Weight2

float

param Weight3

type Weight3

float

param DegMax

default value is 8

type DegMax

int

param Continuity

default value is GeomAbs_C2

type Continuity

GeomAbs_Shape

param Tol3D

default value is 1.0e-3

type Tol3D

float

rtype

None

Interpolate()¶

Interpolates a BSpline Surface passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be 3. 2- his continuity will be C2.

param Points

type Points

TColgp_Array2OfPnt

param thePeriodic

default value is Standard_False

type thePeriodic

bool

rtype

None* Interpolates a BSpline Surface passing through an array of Point. The resulting BSpline will have the following properties: 1- his degree will be 3. 2- his continuity will be C2.

param Points

type Points

TColgp_Array2OfPnt

param ParType

type ParType

Approx_ParametrizationType

param thePeriodic

default value is Standard_False

type thePeriodic

bool

rtype

None* Interpolates a BSpline Surface passing through an array of Points. //! The points will be constructed as follow: P(i,j) = gp_Pnt( X0 + (i-1)*dX , Y0 + (j-1)*dY , ZPoints(i,j) ) //! The resulting BSpline will have the following properties: 1- his degree will be 3 2- his continuity will be C2. 4- the parametrization of the surface will verify: S->Value( U, V) = gp_Pnt( U, V, Z(U,V) );

param ZPoints

type ZPoints

TColStd_Array2OfReal

param X0

type X0

float

param dX

type dX

float

param Y0

type Y0

float

param dY

type dY

float

rtype

None

IsDone()¶

Return type: bool

Surface()¶

Returns the approximate BSpline Surface

rtype

opencascade::handle<Geom_BSplineSurface>

property thisown¶: The membership flag

class GeomAPI_ProjectPointOnCurve(*args)¶

Bases: object

Creates an empty object. Use an Init function for further initialization.

rtype

None* Create the projection of a point on a curve <Curve>

param P

type P

gp_Pnt

param Curve

type Curve

Geom_Curve

rtype

None* Create the projection of a point on a curve <Curve> limited by the two points of parameter Umin and Usup.

param P

type P

gp_Pnt

param Curve

type Curve

Geom_Curve

param Umin

type Umin

float

param Usup

type Usup

float

rtype

None

Distance()¶

Computes the distance between the point and its orthogonal projection on the curve. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

rtype

float

Extrema()¶

return the algorithmic object from Extrema

rtype

Extrema_ExtPC

Init()¶

Init the projection of a point on a curve <Curve>

param P

type P

gp_Pnt

param Curve

type Curve

Geom_Curve

rtype

None* Init the projection of a point on a curve <Curve> limited by the two points of parameter Umin and Usup.

param P

type P

gp_Pnt

param Curve

type Curve

Geom_Curve

param Umin

type Umin

float

param Usup

type Usup

float

rtype

None* Init the projection of a point on a curve <Curve> limited by the two points of parameter Umin and Usup.

param Curve

type Curve

Geom_Curve

param Umin

type Umin

float

param Usup

type Usup

float

rtype

None

LowerDistance()¶

Computes the distance between the point and its nearest orthogonal projection on the curve. Exceptions: StdFail_NotDone if this algorithm fails.

rtype

float

LowerDistanceParameter()¶

Returns the parameter on the curve of the nearest orthogonal projection of the point. Exceptions: StdFail_NotDone if this algorithm fails.

rtype

float

NbPoints()¶

Returns the number of computed orthogonal projection points. Note: if this algorithm fails, NbPoints returns 0.

rtype

int

NearestPoint()¶

Returns the nearest orthogonal projection of the point on the curve. Exceptions: StdFail_NotDone if this algorithm fails.

rtype

gp_Pnt

Parameter()¶

Returns the parameter on the curve of the point, which is the orthogonal projection. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

rtype

float* Returns the parameter on the curve of the point, which is the orthogonal projection. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.-

param Index

type Index

int

param U

type U

float

rtype

None

Perform()¶

Performs the projection of a point on the current curve.

param P

type P

gp_Pnt

rtype

None

Point()¶

Returns the orthogonal projection on the curve. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

rtype

gp_Pnt

property thisown¶: The membership flag

class GeomAPI_ProjectPointOnSurf(*args)¶

Bases: object

Creates an empty object. Use the Init function for further initialization.

rtype

None* Create the projection of a point on a surface <Surface>

param P

type P

gp_Pnt

param Surface

type Surface

Geom_Surface

param Algo

default value is Extrema_ExtAlgo_Grad

type Algo

Extrema_ExtAlgo

rtype

None* Create the projection of a point on a surface <Surface> Create the projection of a point on a surface <Surface>. The solution are computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.

param P

type P

gp_Pnt

param Surface

type Surface

Geom_Surface

param Tolerance

type Tolerance

float

param Algo

default value is Extrema_ExtAlgo_Grad

type Algo

Extrema_ExtAlgo

rtype

None:param P:

type P

gp_Pnt

param Surface

type Surface

Geom_Surface

param Umin

type Umin

float

param Usup

type Usup

float

param Vmin

type Vmin

float

param Vsup

type Vsup

float

param Tolerance

type Tolerance

float

param Algo

default value is Extrema_ExtAlgo_Grad

type Algo

Extrema_ExtAlgo

rtype

None* Init the projection of a point on a surface <Surface>

param P

type P

gp_Pnt

param Surface

type Surface

Geom_Surface

param Umin

type Umin

float

param Usup

type Usup

float

param Vmin

type Vmin

float

param Vsup

type Vsup

float

param Algo

default value is Extrema_ExtAlgo_Grad

type Algo

Extrema_ExtAlgo

rtype

None

Distance()¶

Computes the distance between the point and its orthogonal projection on the surface. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

rtype

float

Extrema()¶

return the algorithmic object from Extrema

rtype

Extrema_ExtPS

Init()¶

Parameters

P –

type P: gp_Pnt
param Surface
type Surface: Geom_Surface
param Tolerance
type Tolerance: float
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None* Init the projection of a point on a surface <Surface>. The solution are computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.
param P
type P: gp_Pnt
param Surface
type Surface: Geom_Surface
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None:param P:
type P: gp_Pnt
param Surface
type Surface: Geom_Surface
param Umin
type Umin: float
param Usup
type Usup: float
param Vmin
type Vmin: float
param Vsup
type Vsup: float
param Tolerance
type Tolerance: float
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None* Init the projection for many points on a surface <Surface>. The solutions will be computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.
param P
type P: gp_Pnt
param Surface
type Surface: Geom_Surface
param Umin
type Umin: float
param Usup
type Usup: float
param Vmin
type Vmin: float
param Vsup
type Vsup: float
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None:param Surface:
type Surface: Geom_Surface
param Umin
type Umin: float
param Usup
type Usup: float
param Vmin
type Vmin: float
param Vsup
type Vsup: float
param Tolerance
type Tolerance: float
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None:param Surface:
type Surface: Geom_Surface
param Umin
type Umin: float
param Usup
type Usup: float
param Vmin
type Vmin: float
param Vsup
type Vsup: float
param Algo: default value is Extrema_ExtAlgo_Grad
type Algo: Extrema_ExtAlgo
rtype: None

IsDone()¶

Return type: bool

LowerDistance()¶

Computes the distance between the point and its nearest orthogonal projection on the surface. Exceptions StdFail_NotDone if projection fails.

rtype

float

LowerDistanceParameters()¶

Returns the parameters (U,V) on the surface of the nearest computed orthogonal projection of the point. Exceptions StdFail_NotDone if projection fails.

param U

type U

float

param V

type V

float

rtype

None

NbPoints()¶

Returns the number of computed orthogonal projection points. Note: if projection fails, NbPoints returns 0.

rtype

int

NearestPoint()¶

Returns the nearest orthogonal projection of the point on the surface. Exceptions StdFail_NotDone if projection fails.

rtype

gp_Pnt

Parameters()¶

Returns the parameters (U,V) on the surface of the orthogonal projection. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

param U

type U

float

param V

type V

float

rtype

None

Perform()¶

Performs the projection of a point on the current surface.

param P

type P

gp_Pnt

rtype

None

Point()¶

Returns the orthogonal projection on the surface. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.

param Index

type Index

int

rtype

gp_Pnt

SetExtremaAlgo()¶

Sets the Extrema search algorithm - Grad or Tree. By default the Extrema is initialized with Grad algorithm.

param theAlgo

type theAlgo

Extrema_ExtAlgo

rtype

None

SetExtremaFlag()¶

Sets the Extrema search flag - MIN or MAX or MINMAX. By default the Extrema is set to search the MinMax solutions.

param theExtFlag

type theExtFlag

Extrema_ExtFlag

rtype

None

property thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class geomapi¶

Bases: object

static To2d()¶

This function builds (in the parametric space of the plane P) a 2D curve equivalent to the 3D curve C. The 3D curve C is considered to be located in the plane P. Warning The 3D curve C must be of one of the following types: - a line - a circle - an ellipse - a hyperbola - a parabola - a Bezier curve - a BSpline curve Exceptions Standard_NoSuchObject if C is not a defined type curve.

param C

type C

Geom_Curve

param P

type P

gp_Pln

rtype

opencascade::handle<Geom2d_Curve>

static To3d()¶

Builds a 3D curve equivalent to the 2D curve C described in the parametric space defined by the local coordinate system of plane P. The resulting 3D curve is of the same nature as that of the curve C.

param C

type C

Geom2d_Curve

param P

type P

gp_Pln

rtype

opencascade::handle<Geom_Curve>

property thisown¶: The membership flag