OCC.Core.BRepGProp module¶

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

class BRepGProp_Cinert(*args)¶

Bases: OCC.Core.GProp.GProp_GProps

Return type: None:param C: :type C: BRepAdaptor_Curve :param CLocation: :type CLocation: gp_Pnt :rtype: None

Perform()¶

Parameters

C –

type C: BRepAdaptor_Curve
rtype: None

SetLocation()¶

Parameters

CLocation –

type CLocation: gp_Pnt
rtype: None

property thisown¶: The membership flag

class BRepGProp_Domain(*args)¶

Bases: object

Empty constructor.

rtype

None* Constructor. Initializes the domain with the face.

param F

type F

TopoDS_Face

rtype

None

Init()¶

Initializes the domain with the face.

param F

type F

TopoDS_Face

rtype

None* Initializes the exploration with the face already set.

rtype

None

More()¶

Returns True if there is another arc of curve in the list.

rtype

bool

Next()¶

Sets the index of the arc iterator to the next arc of curve.

rtype

None

Value()¶

Returns the current edge.

rtype

TopoDS_Edge

property thisown¶: The membership flag

class BRepGProp_EdgeTool¶

Bases: object

static D1()¶

Returns the point of parameter U and the first derivative at this point.

param C

type C

BRepAdaptor_Curve

param U

type U

float

param P

type P

gp_Pnt

param V1

type V1

gp_Vec

rtype

void

static FirstParameter()¶

Returns the parametric value of the start point of the curve. The curve is oriented from the start point to the end point.

param C

type C

BRepAdaptor_Curve

rtype

float

static IntegrationOrder()¶

Returns the number of Gauss points required to do the integration with a good accuracy using the Gauss method. For a polynomial curve of degree n the maxima of accuracy is obtained with an order of integration equal to 2*n-1.

param C

type C

BRepAdaptor_Curve

rtype

int

static Intervals()¶

Stores in <T> the parameters bounding the intervals of continuity <S>. //! The array must provide enough room to accomodate for the parameters. i.e. T.Length() > NbIntervals()

param C

type C

BRepAdaptor_Curve

param T

type T

TColStd_Array1OfReal

param S

type S

GeomAbs_Shape

rtype

void

static LastParameter()¶

Returns the parametric value of the end point of the curve. The curve is oriented from the start point to the end point.

param C

type C

BRepAdaptor_Curve

rtype

float

static NbIntervals()¶

Returns the number of intervals for continuity <S>. May be one if Continuity(me) >= <S>

param C

type C

BRepAdaptor_Curve

param S

type S

GeomAbs_Shape

rtype

int

static Value()¶

Returns the point of parameter U on the loaded curve.

param C

type C

BRepAdaptor_Curve

param U

type U

float

rtype

gp_Pnt

property thisown¶: The membership flag

class BRepGProp_Face(*args)¶

Bases: object

Constructor. Initializes the object with a flag IsUseSpan that says if it is necessary to define spans on a face. This option has an effect only for BSpline faces. Spans are returned by the methods GetUKnots and GetTKnots.

param IsUseSpan

default value is Standard_False

type IsUseSpan

bool

rtype

None* Constructor. Initializes the object with the face and the flag IsUseSpan that says if it is necessary to define spans on a face. This option has an effect only for BSpline faces. Spans are returned by the methods GetUKnots and GetTKnots.

param F

type F

TopoDS_Face

param IsUseSpan

default value is Standard_False

type IsUseSpan

bool

rtype

None

Bounds()¶

Returns the parametric bounds of the Face.

param U1

type U1

float

param U2

type U2

float

param V1

type V1

float

param V2

type V2

float

rtype

None

D12d()¶

Returns the point of parameter U and the first derivative at this point of a boundary curve.

param U

type U

float

param P

type P

gp_Pnt2d

param V1

type V1

gp_Vec2d

rtype

None

FirstParameter()¶

Returns the parametric value of the start point of the current arc of curve.

rtype

float

GetFace()¶

Returns the TopoDS face.

rtype

TopoDS_Face

GetTKnots()¶

Returns an array of combination of T knots of the arc and V knots of the face. The first and last elements of the array will be theTMin and theTMax. The middle elements will be the Knots of the arc and the values of parameters of arc on which the value points have V coordinates close to V knots of face. All the parameter will be greater then theTMin and lower then theTMax in increasing order. If the face is not a BSpline, the array initialized with theTMin and theTMax only.

param theTMin

type theTMin

float

param theTMax

type theTMax

float

param theTKnots

type theTKnots

TColStd_HArray1OfReal

rtype

None

GetUKnots()¶

Returns an array of U knots of the face. The first and last elements of the array will be theUMin and theUMax. The middle elements will be the U Knots of the face greater then theUMin and lower then theUMax in increasing order. If the face is not a BSpline, the array initialized with theUMin and theUMax only.

param theUMin

type theUMin

float

param theUMax

type theUMax

float

param theUKnots

type theUKnots

TColStd_HArray1OfReal

rtype

None

IntegrationOrder()¶

Returns the number of points required to do the integration along the parameter of curve.

rtype

int

LIntOrder()¶

Parameters

Eps –

type Eps: float
rtype: int

LIntSubs()¶

Return type: int

LKnots()¶

Parameters

Knots –

type Knots: TColStd_Array1OfReal
rtype: None

LastParameter()¶

Returns the parametric value of the end point of the current arc of curve.

rtype

float

Load()¶

Parameters

F –

type F: TopoDS_Face
rtype: None* Loading the boundary arc. Returns False if edge has no P-Curve.
param E
type E: TopoDS_Edge
rtype: bool* Loading the boundary arc. This arc is either a top, bottom, left or right bound of a UV rectangle in which the parameters of surface are defined. If IsFirstParam is equal to Standard_True, the face is initialized by either left of bottom bound. Otherwise it is initialized by the top or right one. If theIsoType is equal to GeomAbs_IsoU, the face is initialized with either left or right bound. Otherwise - with either top or bottom one.
param IsFirstParam
type IsFirstParam: bool
param theIsoType
type theIsoType: GeomAbs_IsoType
rtype: None

NaturalRestriction()¶

Returns Standard_True if the face is not trimmed.

rtype

bool

Normal()¶

Computes the point of parameter U, V on the Face <S> and the normal to the face at this point.

param U

type U

float

param V

type V

float

param P

type P

gp_Pnt

param VNor

type VNor

gp_Vec

rtype

None

SIntOrder()¶

Parameters

Eps –

type Eps: float
rtype: int

SUIntSubs()¶

Return type: int

SVIntSubs()¶

Return type: int

UIntegrationOrder()¶

Returns the number of points required to do the integration in the U parametric direction with a good accuracy.

rtype

int

UKnots()¶

Parameters

Knots –

type Knots: TColStd_Array1OfReal
rtype: None

VIntegrationOrder()¶

Return type: int

VKnots()¶

Parameters

Knots –

type Knots: TColStd_Array1OfReal
rtype: None

Value2d()¶

Returns the value of the boundary curve of the face.

param U

type U

float

rtype

gp_Pnt2d

property thisown¶: The membership flag

class BRepGProp_Gauss(*args)¶

Bases: object

Constructor

param theType

type theType

BRepGProp_GaussType

rtype

None

Sinert = 1¶

Vinert = 0¶

property thisown¶: The membership flag

class BRepGProp_MeshCinert(*args)¶

Bases: OCC.Core.GProp.GProp_GProps

Return type: None

Perform()¶

Computes the global properties of of polylines represented by set of points.

param theNodes

type theNodes

TColgp_Array1OfPnt

rtype

None

static PreparePolygon()¶

Prepare set of 3d points on base of any available edge polygons: 3D polygon, polygon on triangulation, 2d polygon on surface If edge has no polygons, array thePolyg is left unchanged

param theE

type theE

TopoDS_Edge

param thePolyg

type thePolyg

TColgp_HArray1OfPnt

rtype

void

SetLocation()¶

Parameters

CLocation –

type CLocation: gp_Pnt
rtype: None

property thisown¶: The membership flag

class BRepGProp_Sinert(*args)¶

Bases: OCC.Core.GProp.GProp_GProps

Return type: None:param S: :type S: BRepGProp_Face :param SLocation: :type SLocation: gp_Pnt :rtype: None* Builds a Sinert to evaluate the global properties of the face <S>. If isNaturalRestriction is true the domain of S is defined with the natural bounds, else it defined with an iterator of Edge from TopoDS (see DomainTool from GProp) :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param SLocation: :type SLocation: gp_Pnt :rtype: None:param S: :type S: BRepGProp_Face :param SLocation: :type SLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None:param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param SLocation: :type SLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None

GetEpsilon()¶

If previously used method contained Eps parameter get actual relative error of the computation, else return 1.0.

rtype

float

Perform()¶

Parameters

S –

type S: BRepGProp_Face
rtype: None:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
rtype: None:param S:
type S: BRepGProp_Face
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param Eps
type Eps: float
rtype: float

SetLocation()¶

Parameters

SLocation –

type SLocation: gp_Pnt
rtype: None

property thisown¶: The membership flag

class BRepGProp_TFunction(*args)¶

Bases: OCC.Core.math.math_Function

Constructor. Initializes the function with the face, the location point, the flag IsByPoint, the coefficients theCoeff that have different meaning depending on the value of IsByPoint. The last two parameters are theUMin - the lower bound of the inner integral. This value is fixed for any integral. And the value of tolerance of inner integral computation. If IsByPoint is equal to Standard_True, the number of the coefficients is equal to 3 and they represent X, Y and Z coordinates (theCoeff[0], theCoeff[1] and theCoeff[2] correspondingly) of the shift if the inertia is computed with respect to the point different then the location. If IsByPoint is equal to Standard_False, the number of the coefficients is 4 and they represent the compbination of plane parameters and shift values.

param theSurface

type theSurface

BRepGProp_Face

param theVertex

type theVertex

gp_Pnt

param IsByPoint

type IsByPoint

bool

param theCoeffs

type theCoeffs

Standard_Address

param theUMin

type theUMin

float

param theTolerance

type theTolerance

float

rtype

None

AbsolutError()¶

Returns the absolut reached error of all values computation since the last call of GetStateNumber method.

rtype

float

ErrorReached()¶

Returns the relative reached error of all values computation since the last call of GetStateNumber method.

rtype

float

Init()¶

Return type: None

SetNbKronrodPoints()¶

Setting the expected number of Kronrod points for the outer integral computation. This number is required for computation of a value of tolerance for inner integral computation. After GetStateNumber method call, this number is recomputed by the same law as in math_KronrodSingleIntegration, i.e. next number of points is equal to the current number plus a square root of the current number. If the law in math_KronrodSingleIntegration is changed, the modification algo should be modified accordingly.

param theNbPoints

type theNbPoints

int

rtype

None

SetTolerance()¶

Setting the tolerance for inner integration

param aTol

type aTol

float

rtype

None

SetValueType()¶

Setting the type of the value to be returned. This parameter is directly passed to the UFunction.

param aType

type aType

GProp_ValueType

rtype

None

property thisown¶: The membership flag

class BRepGProp_UFunction(*args)¶

Bases: OCC.Core.math.math_Function

Constructor. Initializes the function with the face, the location point, the flag IsByPoint and the coefficients theCoeff that have different meaning depending on the value of IsByPoint. If IsByPoint is equal to Standard_True, the number of the coefficients is equal to 3 and they represent X, Y and Z coordinates (theCoeff[0], theCoeff[1] and theCoeff[2] correspondingly) of the shift, if the inertia is computed with respect to the point different then the location. If IsByPoint is equal to Standard_False, the number of the coefficients is 4 and they represent the combination of plane parameters and shift values.

param theSurface

type theSurface

BRepGProp_Face

param theVertex

type theVertex

gp_Pnt

param IsByPoint

type IsByPoint

bool

param theCoeffs

type theCoeffs

Standard_Address

rtype

None

SetVParam()¶

Setting the V parameter that is constant during the integral computation.

param theVParam

type theVParam

float

rtype

None

SetValueType()¶

Setting the type of the value to be returned.

param theType

type theType

GProp_ValueType

rtype

None

property thisown¶: The membership flag

class BRepGProp_Vinert(*args)¶

Bases: OCC.Core.GProp.GProp_GProps

Return type: None* Computes the global properties of a region of 3D space delimited with the surface <S> and the point VLocation. S can be closed The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Errror of the computation is not calculated. :param S: :type S: BRepGProp_Face :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of a region of 3D space delimited with the surface <S> and the point VLocation. S can be closed Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. :param S: :type S: BRepGProp_Face :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the point VLocation. The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Error of the computation is not calculated. :param S: :type S: BRepGProp_Face :param O: :type O: gp_Pnt :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the point VLocation. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. :param S: :type S: BRepGProp_Face :param O: :type O: gp_Pnt :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the plane Pln. The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Error of the computation is not calculated. :param S: :type S: BRepGProp_Face :param Pl: :type Pl: gp_Pln :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the plane Pln. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. :param S: :type S: BRepGProp_Face :param Pl: :type Pl: gp_Pln :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None* Computes the global properties of a region of 3D space delimited with the surface <S> and the point VLocation. S can be closed The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Errror of the computation is not calculated. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of a region of 3D space delimited with the surface <S> and the point VLocation. S can be closed Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the point VLocation. The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Error of the computation is not calculated. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param O: :type O: gp_Pnt :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the point VLocation. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param O: :type O: gp_Pnt :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the plane Pln. The method is quick and its precision is enough for many cases of analytical surfaces. Non-adaptive 2D Gauss integration with predefined numbers of Gauss points is used. Numbers of points depend on types of surfaces and curves. Error of the computation is not calculated. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param Pl: :type Pl: gp_Pln :param VLocation: :type VLocation: gp_Pnt :rtype: None* Computes the global properties of the region of 3D space delimited with the surface <S> and the plane Pln. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. :param S: :type S: BRepGProp_Face :param D: :type D: BRepGProp_Domain :param Pl: :type Pl: gp_Pln :param VLocation: :type VLocation: gp_Pnt :param Eps: :type Eps: float :rtype: None

GetEpsilon()¶

If previously used methods containe Eps parameter gets actual relative error of the computation, else returns 1.0.

rtype

float

Perform()¶

Parameters

S –

type S: BRepGProp_Face
rtype: None:param S:
type S: BRepGProp_Face
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param O
type O: gp_Pnt
rtype: None:param S:
type S: BRepGProp_Face
param O
type O: gp_Pnt
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param Pl
type Pl: gp_Pln
rtype: None:param S:
type S: BRepGProp_Face
param Pl
type Pl: gp_Pln
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
rtype: None:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param O
type O: gp_Pnt
rtype: None:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param O
type O: gp_Pnt
param Eps
type Eps: float
rtype: float:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param Pl
type Pl: gp_Pln
rtype: None:param S:
type S: BRepGProp_Face
param D
type D: BRepGProp_Domain
param Pl
type Pl: gp_Pln
param Eps
type Eps: float
rtype: float

SetLocation()¶

Parameters

VLocation –

type VLocation: gp_Pnt
rtype: None

property thisown¶: The membership flag

class BRepGProp_VinertGK(*args)¶

Bases: OCC.Core.GProp.GProp_GProps

Empty constructor.

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the point VLocation.

param theSurface

type theSurface

BRepGProp_Face

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the point VLocation. The inertia is computed with respect to thePoint.

param theSurface

type theSurface

BRepGProp_Face

param thePoint

type thePoint

gp_Pnt

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the point VLocation.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the point VLocation. The inertia is computed with respect to thePoint.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param thePoint

type thePoint

gp_Pnt

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the plane.

param theSurface

type theSurface

BRepGProp_Face

param thePlane

type thePlane

gp_Pln

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None* Constructor. Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the plane.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param thePlane

type thePlane

gp_Pln

param theLocation

type theLocation

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

None

GetErrorReached()¶

Returns the relative reached computation error.

rtype

float

Perform()¶

Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the point VLocation.

param theSurface

type theSurface

BRepGProp_Face

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float* Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the point VLocation. The inertia is computed with respect to thePoint.

param theSurface

type theSurface

BRepGProp_Face

param thePoint

type thePoint

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float* Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the point VLocation.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float* Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the point VLocation. The inertia is computed with respect to thePoint.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param thePoint

type thePoint

gp_Pnt

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float* Computes the global properties of a region of 3D space delimited with the naturally restricted surface and the plane.

param theSurface

type theSurface

BRepGProp_Face

param thePlane

type thePlane

gp_Pln

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float* Computes the global properties of a region of 3D space delimited with the surface bounded by the domain and the plane.

param theSurface

type theSurface

BRepGProp_Face

param theDomain

type theDomain

BRepGProp_Domain

param thePlane

type thePlane

gp_Pln

param theTolerance

default value is 0.001

type theTolerance

float

param theCGFlag

default value is Standard_False

type theCGFlag

bool

param theIFlag

default value is Standard_False

type theIFlag

bool

rtype

float

SetLocation()¶

Sets the vertex that delimit 3D closed region of space.

param theLocation

type theLocation

gp_Pnt

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 brepgprop¶

Bases: object

static LinearProperties()¶

Computes the linear global properties of the shape S, i.e. the global properties induced by each edge of the shape S, and brings them together with the global properties still retained by the framework LProps. If the current system of LProps was empty, its global properties become equal to the linear global properties of S. For this computation no linear density is attached to the edges. So, for example, the added mass corresponds to the sum of the lengths of the edges of S. The density of the composed systems, i.e. that of each component of the current system of LProps, and that of S which is considered to be equal to 1, must be coherent. Note that this coherence cannot be checked. You are advised to use a separate framework for each density, and then to bring these frameworks together into a global one. The point relative to which the inertia of the system is computed is the reference point of the framework LProps. Note: if your programming ensures that the framework LProps retains only linear global properties (brought together for example, by the function LinearProperties) for objects the density of which is equal to 1 (or is not defined), the function Mass will return the total length of edges of the system analysed by LProps. Warning No check is performed to verify that the shape S retains truly linear properties. If S is simply a vertex, it is not considered to present any additional global properties. SkipShared is a special flag, which allows taking in calculation shared topological entities or not. For ex., if SkipShared = True, edges, shared by two or more faces, are taken into calculation only once. If we have cube with sizes 1, 1, 1, its linear properties = 12 for SkipEdges = true and 24 for SkipEdges = false. UseTriangulation is a special flag, which defines preferable source of geometry data. If UseTriangulation = Standard_False, exact geometry objects (curves) are used, otherwise polygons of triangulation are used first.

param S

type S

TopoDS_Shape

param LProps

type LProps

GProp_GProps

param SkipShared

default value is Standard_False

type SkipShared

bool

param UseTriangulation

default value is Standard_False

type UseTriangulation

bool

rtype

void

static SurfaceProperties()¶

Computes the surface global properties of the shape S, i.e. the global properties induced by each face of the shape S, and brings them together with the global properties still retained by the framework SProps. If the current system of SProps was empty, its global properties become equal to the surface global properties of S. For this computation, no surface density is attached to the faces. Consequently, the added mass corresponds to the sum of the areas of the faces of S. The density of the component systems, i.e. that of each component of the current system of SProps, and that of S which is considered to be equal to 1, must be coherent. Note that this coherence cannot be checked. You are advised to use a framework for each different value of density, and then to bring these frameworks together into a global one. The point relative to which the inertia of the system is computed is the reference point of the framework SProps. Noteif your programming ensures that the framework SProps retains only surface global properties, brought together, for example, by the function SurfaceProperties, for objects the density of which is equal to 1 (or is not defined), the function Mass will return the total area of faces of the system analysed by SProps. Warning No check is performed to verify that the shape S retains truly surface properties. If S is simply a vertex, an edge or a wire, it is not considered to present any additional global properties. SkipShared is a special flag, which allows taking in calculation shared topological entities or not. For ex., if SkipShared = True, faces, shared by two or more shells, are taken into calculation only once. UseTriangulation is a special flag, which defines preferable source of geometry data. If UseTriangulation = Standard_False, exact geometry objects (surfaces) are used, otherwise face triangulations are used first.

param S

type S

TopoDS_Shape

param SProps

type SProps

GProp_GProps

param SkipShared

default value is Standard_False

type SkipShared

bool

param UseTriangulation

default value is Standard_False

type UseTriangulation

bool

rtype

void* Updates <SProps> with the shape <S>, that contains its pricipal properties. The surface properties of all the faces in <S> are computed. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (area) for each face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. Method returns estimation of relative error reached for whole shape. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. SkipShared is a special flag, which allows taking in calculation shared topological entities or not For ex., if SkipShared = True, faces, shared by two or more shells, are taken into calculation only once.

param S

type S

TopoDS_Shape

param SProps

type SProps

GProp_GProps

param Eps

type Eps

float

param SkipShared

default value is Standard_False

type SkipShared

bool

rtype

float

static VolumeProperties()¶

//! Computes the global volume properties of the solid S, and brings them together with the global properties still retained by the framework VProps. If the current system of VProps was empty, its global properties become equal to the global properties of S for volume. For this computation, no volume density is attached to the solid. Consequently, the added mass corresponds to the volume of S. The density of the component systems, i.e. that of each component of the current system of VProps, and that of S which is considered to be equal to 1, must be coherent to each other. Note that this coherence cannot be checked. You are advised to use a separate framework for each density, and then to bring these frameworks together into a global one. The point relative to which the inertia of the system is computed is the reference point of the framework VProps. Note: if your programming ensures that the framework VProps retains only global properties of volume (brought together for example, by the function VolumeProperties) for objects the density of which is equal to 1 (or is not defined), the function Mass will return the total volume of the solids of the system analysed by VProps. Warning The shape S must represent an object whose global volume properties can be computed. It may be a finite solid, or a series of finite solids all oriented in a coherent way. Nonetheless, S must be exempt of any free boundary. Note that these conditions of coherence are not checked by this algorithm, and results will be false if they are not respected. SkipShared a is special flag, which allows taking in calculation shared topological entities or not. For ex., if SkipShared = True, the volumes formed by the equal (the same TShape, location and orientation) faces are taken into calculation only once. UseTriangulation is a special flag, which defines preferable source of geometry data. If UseTriangulation = Standard_False, exact geometry objects (surfaces) are used, otherwise face triangulations are used first.

param S

type S

TopoDS_Shape

param VProps

type VProps

GProp_GProps

param OnlyClosed

default value is Standard_False

type OnlyClosed

bool

param SkipShared

default value is Standard_False

type SkipShared

bool

param UseTriangulation

default value is Standard_False

type UseTriangulation

bool

rtype

void* Updates <VProps> with the shape <S>, that contains its pricipal properties. The volume properties of all the FORWARD and REVERSED faces in <S> are computed. If OnlyClosed is True then computed faces must belong to closed Shells. Adaptive 2D Gauss integration is used. Parameter Eps sets maximal relative error of computed mass (volume) for each face. Error is calculated as Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values for two successive steps of adaptive integration. Method returns estimation of relative error reached for whole shape. WARNING: if Eps > 0.001 algorithm performs non-adaptive integration. SkipShared is a special flag, which allows taking in calculation shared topological entities or not. For ex., if SkipShared = True, the volumes formed by the equal (the same TShape, location and orientation) faces are taken into calculation only once.

param S

type S

TopoDS_Shape

param VProps

type VProps

GProp_GProps

param Eps

type Eps

float

param OnlyClosed

default value is Standard_False

type OnlyClosed

bool

param SkipShared

default value is Standard_False

type SkipShared

bool

rtype

float

static VolumePropertiesGK()¶

Updates <VProps> with the shape <S>, that contains its pricipal properties. The volume properties of all the FORWARD and REVERSED faces in <S> are computed. If OnlyClosed is True then computed faces must belong to closed Shells. Adaptive 2D Gauss integration is used. Parameter IsUseSpan says if it is necessary to define spans on a face. This option has an effect only for BSpline faces. Parameter Eps sets maximal relative error of computed property for each face. Error is delivered by the adaptive Gauss-Kronrod method of integral computation that is used for properties computation. Method returns estimation of relative error reached for whole shape. Returns negative value if the computation is failed. SkipShared is a special flag, which allows taking in calculation shared topological entities or not. For ex., if SkipShared = True, the volumes formed by the equal (the same TShape, location and orientation) faces are taken into calculation only once.

param S

type S

TopoDS_Shape

param VProps

type VProps

GProp_GProps

param Eps

default value is 0.001

type Eps

float

param OnlyClosed

default value is Standard_False

type OnlyClosed

bool

param IsUseSpan

default value is Standard_False

type IsUseSpan

bool

param CGFlag

default value is Standard_False

type CGFlag

bool

param IFlag

default value is Standard_False

type IFlag

bool

param SkipShared

default value is Standard_False

type SkipShared

bool

rtype

float:param S:

type S

TopoDS_Shape

param VProps

type VProps

GProp_GProps

param thePln

type thePln

gp_Pln

param Eps

default value is 0.001

type Eps

float

param OnlyClosed

default value is Standard_False

type OnlyClosed

bool

param IsUseSpan

default value is Standard_False

type IsUseSpan

bool

param CGFlag

default value is Standard_False

type CGFlag

bool

param IFlag

default value is Standard_False

type IFlag

bool

param SkipShared

default value is Standard_False

type SkipShared

bool

rtype

float

property thisown¶: The membership flag