OCC.ShapeAnalysis module

class Handle_ShapeAnalysis_DataMapNodeOfDataMapOfShapeListOfReal(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_FreeBoundData(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_HSequenceOfFreeBounds(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_SequenceNodeOfSequenceOfFreeBounds(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_Surface(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_TransferParameters(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_TransferParametersProj(*args)

Bases: OCC.ShapeAnalysis.Handle_ShapeAnalysis_TransferParameters

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_ShapeAnalysis_Wire(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class ShapeAnalysis_CheckSmallFace(*args)

Bases: object

  • Creates an empty tool Checks a Shape i.e. each of its faces, records checks as diagnostics in the <infos> //! If <infos> has not been set before, no check is done //! For faces which are in a Shell, topological data are recorded to allow recovering connectivities after fixing or removing the small faces or parts of faces Enchains various checks on a face inshell : to compute more informations, relevant to topology
Return type:None
CheckPin()
  • Checks if a Face has a pin, which can be edited No singularity : no pin, returns 0 If there is a pin, checked topics, with returned value : - 0 : nothing to do more - 1 : ‘smooth’, i.e. not a really sharp pin -> diagnostic ‘SmoothPin’ - 2 : stretched pin, i.e. is possible to relimit the face by another vertex, so that this vertex still gives a pin -> diagnostic ‘StretchedPin’ with location of vertex (Pnt)
Parameters:
  • F (TopoDS_Face &) –
  • whatrow (int &) –
  • sence (int &) –
Return type:

bool

CheckPinEdges()
Parameters:
  • theFirstEdge (TopoDS_Edge &) –
  • theSecondEdge (TopoDS_Edge &) –
  • coef1 (float) –
  • coef2 (float) –
  • toler (float) –
Return type:

bool

CheckPinFace()
Parameters:
  • F (TopoDS_Face &) –
  • mapEdges (TopTools_DataMapOfShapeShape &) –
  • toler (float) – default value is -1.0
Return type:

bool

CheckSingleStrip()
  • Checks if a Face is a single strip, i.e. brings two great edges which are confused on their whole length, possible other edges are small or null length //! Returns 0 if not a strip support, 1 strip in U, 2 strip in V Records diagnostic in info if it is a single strip
Parameters:
  • F (TopoDS_Face &) –
  • E1 (TopoDS_Edge &) –
  • E2 (TopoDS_Edge &) –
  • tol (float) – default value is -1.0
Return type:

bool

CheckSplittingVertices()
  • Checks if a Face brings vertices which split it, either confused with non adjacent vertices, or confused with their projection on non adjacent edges Returns the count of found splitting vertices Each vertex then brings a diagnostic ‘SplittingVertex’, with data : ‘Face’ for the face, ‘Edge’ for the split edge
Parameters:
  • F (TopoDS_Face &) –
  • MapEdges (TopTools_DataMapOfShapeListOfShape &) –
  • MapParam (ShapeAnalysis_DataMapOfShapeListOfReal &) –
  • theAllVert (TopoDS_Compound &) –
Return type:

int

CheckSpotFace()
  • Acts as IsSpotFace, but records in <infos> a diagnostic ‘SpotFace’ with the Pnt as value (data ‘Location’)
Parameters:
  • F (TopoDS_Face &) –
  • tol (float) – default value is -1.0
Return type:

bool

CheckStripEdges()
  • Checks if two edges define a strip, i.e. distance maxi below tolerance, given or some of those of E1 and E2
Parameters:
  • E1 (TopoDS_Edge &) –
  • E2 (TopoDS_Edge &) –
  • tol (float) –
  • dmax (float &) –
Return type:

bool

CheckStripFace()
  • Checks if a Face is as a Strip Returns 0 if not or non determined, 1 if in U, 2 if in V By default, considers the tolerance zone of its edges A given value <tol> may be given to check a strip of max this width //! If a Face is determined as a Strip, it is delinited by two lists of edges. These lists are recorded in diagnostic Diagnostic ‘StripFace’ brings data ‘Direction’ (U or V), ‘List1’ , ‘List2’ (if they could be computed)
Parameters:
  • F (TopoDS_Face &) –
  • E1 (TopoDS_Edge &) –
  • E2 (TopoDS_Edge &) –
  • tol (float) – default value is -1.0
Return type:

bool

CheckTwisted()
  • Checks if a Face is twisted (apart from checking Pin, i.e. it does not give information on pin, only ‘it is twisted’)
Parameters:
  • F (TopoDS_Face &) –
  • paramu (float &) –
  • paramv (float &) –
Return type:

bool

FindStripEdges()
  • Searchs for two and only two edges up tolerance Returns True if OK, false if not 2 edges If True, returns the two edges and their maximum distance
Parameters:
  • F (TopoDS_Face &) –
  • E1 (TopoDS_Edge &) –
  • E2 (TopoDS_Edge &) –
  • tol (float) –
  • dmax (float &) –
Return type:

bool

IsSpotFace()
  • Checks if a Face is as a Spot Returns 0 if not, 1 if yes, 2 if yes and all vertices are the same By default, considers the tolerance zone of its vertices A given value <tol> may be given to check a spot of this size If a Face is a Spot, its location is returned in <spot>, and <spotol> returns an equivalent tolerance, which is computed as half of max dimension of min-max box of the face
Parameters:
  • F (TopoDS_Face &) –
  • spot (gp_Pnt) –
  • spotol (float &) –
  • tol (float) – default value is -1.0
Return type:

int

IsStripSupport()
  • Checks if a Face lies on a Surface which is a strip So the Face is a strip. But a Face may be a strip elsewhere .. //! A given value <tol> may be given to check max width By default, considers the tolerance zone of its edges Returns 0 if not a strip support, 1 strip in U, 2 strip in V
Parameters:
  • F (TopoDS_Face &) –
  • tol (float) – default value is -1.0
Return type:

bool

SetTolerance()
  • Sets a fixed Tolerance to check small face By default, local tolerance zone is considered Sets a fixed MaxTolerance to check small face Sets a fixed Tolerance to check small face By default, local tolerance zone is considered Unset fixed tolerance, comes back to local tolerance zones Unset fixed tolerance, comes back to local tolerance zones
Parameters:tol (float) –
Return type:None
Status()
  • Returns the status of last call to Perform() ShapeExtend_OK : face was OK, nothing done ShapeExtend_DONE1: some wires are fixed ShapeExtend_DONE2: orientation of wires fixed ShapeExtend_DONE3: missing seam added ShapeExtend_DONE4: small area wire removed ShapeExtend_DONE5: natural bounds added ShapeExtend_FAIL1: some fails during fixing wires ShapeExtend_FAIL2: cannot fix orientation of wires ShapeExtend_FAIL3: cannot add missing seam ShapeExtend_FAIL4: cannot remove small area wire
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusPin()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusPinEdges()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusPinFace()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusSplitVert()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusSpot()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusStrip()
Parameters:status (ShapeExtend_Status) –
Return type:bool
StatusTwisted()
Parameters:status (ShapeExtend_Status) –
Return type:bool
Tolerance()
  • Returns the tolerance to check small faces, negative value if local tolerances zones are to be considered
Return type:float
thisown

The membership flag

class ShapeAnalysis_Curve

Bases: object

FillBndBox()
  • Computes a boundary box on segment of curve C2d from First to Last. This is done by taking NPoints points from the curve and, if Exact is True, by searching for exact extrema. All these points are added to Box.
Parameters:
  • C2d (Handle_Geom2d_Curve &) –
  • First (float) –
  • Last (float) –
  • NPoints (int) –
  • Exact (bool) –
  • Box (Bnd_Box2d &) –
Return type:

None

static GetSamplePoints(*args)
  • Returns sample points which will serve as linearisation of the2d curve in range (first, last) The distribution of sample points is consystent with what is used by BRepTopAdaptor_FClass2d
Parameters:
Return type:

bool

  • Returns sample points which will serve as linearisation of the curve in range (first, last)
Parameters:
Return type:

bool

static IsClosed(*args)
  • Tells if the Curve is closed with given precision. If <preci> < 0 then Precision::Confusion is used.
Parameters:
  • curve (Handle_Geom_Curve &) –
  • preci (float) – default value is -1
Return type:

bool

static IsPeriodic(*args)
  • This method was implemented as fix for changes in trimmed curve behaviour. For the moment trimmed curve returns false anyway. So it is necessary to adapt all Data exchange tools for this behaviour. Current implementation takes into account that curve may be offset.
Parameters:curve (Handle_Geom_Curve &) –
Return type:bool
  • The same as for Curve3d.
Parameters:curve (Handle_Geom2d_Curve &) –
Return type:bool
static IsPlanar(*args)
  • Checks if points are planar with given preci. If Normal has not zero modulus, checks with given normal
Parameters:
Return type:

bool

  • Checks if curve is planar with given preci. If Normal has not zero modulus, checks with given normal
Parameters:
  • curve (Handle_Geom_Curve &) –
  • Normal (gp_XYZ) –
  • preci (float) – default value is 0
Return type:

bool

NextProject()
  • Projects a Point on a Curve using Newton method. <paramPrev> is taken as the first approximation of solution. If Newton algorithm fails the method Project() is used. If AdjustToEnds is True, point will be adjusted to the end of the curve if distance is less than <preci>
Parameters:
  • paramPrev (float) –
  • C3D (Handle_Geom_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
  • cf (float) –
  • cl (float) –
  • AdjustToEnds (bool) – default value is Standard_True
Return type:

float

  • Projects a Point on a Curve using Newton method. <paramPrev> is taken as the first approximation of solution. If Newton algorithm fails the method Project() is used.
Parameters:
  • paramPrev (float) –
  • C3D (Adaptor3d_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
Return type:

float

Project()
  • Projects a Point on a Curve. Computes the projected point and its parameter on the curve. <preci> is used as 3d precision (hence, 0 will produce reject unless exact confusion). The number of iterations is limited. If AdjustToEnds is True, point will be adjusted to the end of the curve if distance is less than <preci> //! Returned value is the distance between the given point and computed one.
Parameters:
  • C3D (Handle_Geom_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
  • AdjustToEnds (bool) – default value is Standard_True
Return type:

float

  • Projects a Point on a Curve. Computes the projected point and its parameter on the curve. <preci> is used as 3d precision (hence, 0 will produce reject unless exact confusion). The number of iterations is limited. //! Returned value is the distance between the given point and computed one.
Parameters:
  • C3D (Adaptor3d_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
  • AdjustToEnds (bool) – default value is Standard_True
Return type:

float

  • Projects a Point on a Curve, but parameters are limited between <cf> and <cl>. The range [cf, cl] is extended with help of Adaptor3d on the basis of 3d precision <preci>. If AdjustToEnds is True, point will be adjusted to the end of the curve if distance is less than <preci>
Parameters:
  • C3D (Handle_Geom_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
  • cf (float) –
  • cl (float) –
  • AdjustToEnds (bool) – default value is Standard_True
Return type:

float

ProjectAct()
Parameters:
  • C3D (Adaptor3d_Curve &) –
  • P3D (gp_Pnt) –
  • preci (float) –
  • proj (gp_Pnt) –
  • param (float &) –
Return type:

float

SelectForwardSeam()
  • Defines which pcurve (C1 or C2) should be chosen for FORWARD seam edge.
Parameters:
  • C1 (Handle_Geom2d_Curve &) –
  • C2 (Handle_Geom2d_Curve &) –
Return type:

int

ValidateRange()
  • Validate parameters First and Last for the given curve in order to make them valid for creation of edge. This includes: - limiting range [First,Last] by range of curve - adjusting range [First,Last] for periodic (or closed) curve if Last < First Returns True if parameters are OK or are successfully corrected, or False if parameters cannot be corrected. In the latter case, parameters are reset to range of curve.
Parameters:
  • Crv (Handle_Geom_Curve &) –
  • First (float &) –
  • Last (float &) –
  • prec (float) –
Return type:

bool

thisown

The membership flag

ShapeAnalysis_Curve_GetSamplePoints(*args)
  • Returns sample points which will serve as linearisation of the2d curve in range (first, last) The distribution of sample points is consystent with what is used by BRepTopAdaptor_FClass2d
Parameters:
Return type:

bool

  • Returns sample points which will serve as linearisation of the curve in range (first, last)
Parameters:
Return type:

bool

ShapeAnalysis_Curve_IsClosed(*args)
  • Tells if the Curve is closed with given precision. If <preci> < 0 then Precision::Confusion is used.
Parameters:
  • curve (Handle_Geom_Curve &) –
  • preci (float) – default value is -1
Return type:

bool

ShapeAnalysis_Curve_IsPeriodic(*args)
  • This method was implemented as fix for changes in trimmed curve behaviour. For the moment trimmed curve returns false anyway. So it is necessary to adapt all Data exchange tools for this behaviour. Current implementation takes into account that curve may be offset.
Parameters:curve (Handle_Geom_Curve &) –
Return type:bool
  • The same as for Curve3d.
Parameters:curve (Handle_Geom2d_Curve &) –
Return type:bool
ShapeAnalysis_Curve_IsPlanar(*args)
  • Checks if points are planar with given preci. If Normal has not zero modulus, checks with given normal
Parameters:
Return type:

bool

  • Checks if curve is planar with given preci. If Normal has not zero modulus, checks with given normal
Parameters:
  • curve (Handle_Geom_Curve &) –
  • Normal (gp_XYZ) –
  • preci (float) – default value is 0
Return type:

bool

class ShapeAnalysis_DataMapIteratorOfDataMapOfShapeListOfReal(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (ShapeAnalysis_DataMapOfShapeListOfReal &) –
Return type:None
Initialize()
Parameters:aMap (ShapeAnalysis_DataMapOfShapeListOfReal &) –
Return type:None
Key()
Return type:TopoDS_Shape
Value()
Return type:TColStd_ListOfReal
thisown

The membership flag

class ShapeAnalysis_DataMapNodeOfDataMapOfShapeListOfReal(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TopoDS_Shape &) –
  • I (TColStd_ListOfReal &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TopoDS_Shape
Value()
Return type:TColStd_ListOfReal
thisown

The membership flag

class ShapeAnalysis_DataMapOfShapeListOfReal(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (ShapeAnalysis_DataMapOfShapeListOfReal &) –
Return type:ShapeAnalysis_DataMapOfShapeListOfReal
Bind()
Parameters:
  • K (TopoDS_Shape &) –
  • I (TColStd_ListOfReal &) –
Return type:

bool

ChangeFind()
Parameters:K (TopoDS_Shape &) –
Return type:TColStd_ListOfReal
ChangeFind1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TopoDS_Shape &) –
Return type:TColStd_ListOfReal
Find1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
IsBound()
Parameters:K (TopoDS_Shape &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (ShapeAnalysis_DataMapOfShapeListOfReal &) –
Return type:ShapeAnalysis_DataMapOfShapeListOfReal
UnBind()
Parameters:K (TopoDS_Shape &) –
Return type:bool
thisown

The membership flag

class ShapeAnalysis_Edge(*args)

Bases: object

  • Empty constructor; initialises Status to OK
Return type:None
BoundUV()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
  • first (gp_Pnt2d) –
  • last (gp_Pnt2d) –
Return type:

bool

  • Returns the ends of pcurve Calls method PCurve with <orient> equal to True
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
  • first (gp_Pnt2d) –
  • last (gp_Pnt2d) –
Return type:

bool

CheckCurve3dWithPCurve()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
Return type:

bool

  • Checks mutual orientation of 3d curve and pcurve on the analysis of curves bounding points
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
Return type:

bool

CheckOverlapping()
  • Checks the first edge is overlapped with second edge. If distance between two edges is less then theTolOverlap edges is overlapped. theDomainDis - length of part of edges on wich edges is overlapped.
Parameters:
  • theEdge1 (TopoDS_Edge &) –
  • theEdge2 (TopoDS_Edge &) –
  • theTolOverlap (float &) –
  • theDomainDist (float) – default value is 0.0
Return type:

bool

CheckSameParameter()
  • Checks the edge to be SameParameter. Calculates the maximal deviation between 3d curve and each pcurve of the edge on <NbControl> equidistant points (the same algorithm as in BRepCheck; default value is 23 as in BRepCheck). This deviation is returned in <maxdev> parameter. If deviation is greater than tolerance of the edge (i.e. incorrect flag) returns False, else returns True.
Parameters:
  • edge (TopoDS_Edge &) –
  • maxdev (float &) –
  • NbControl (int) – default value is 23
Return type:

bool

CheckVertexTolerance()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
  • toler1 (float &) –
  • toler2 (float &) –
Return type:

bool

  • Checks if it is necessary to increase tolerances of the edge vertices to comprise the ends of 3d curve and pcurve on the given face (first method) or all pcurves stored in an edge (second one) toler1 returns necessary tolerance for first vertex, toler2 returns necessary tolerance for last vertex.
Parameters:
  • edge (TopoDS_Edge &) –
  • toler1 (float &) –
  • toler2 (float &) –
Return type:

bool

CheckVerticesWithCurve3d()
  • Checks the start and/or end vertex of the edge for matching with 3d curve with the given precision. <vtx> = 1 : start vertex only <vtx> = 2 : end vertex only <vtx> = 0 : both (default) If preci < 0 the vertices are considered with their own tolerances, else with the given <preci>.
Parameters:
  • edge (TopoDS_Edge &) –
  • preci (float) – default value is -1
  • vtx (int) – default value is 0
Return type:

bool

CheckVerticesWithPCurve()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
  • preci (float) – default value is -1
  • vtx (int) – default value is 0
Return type:

bool

  • Checks the start and/or end vertex of the edge for matching with pcurve with the given precision. <vtx> = 1 : start vertex <vtx> = 2 : end vertex <vtx> = 0 : both If preci < 0 the vertices are considered with their own tolerances, else with the given <preci>.
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
  • preci (float) – default value is -1
  • vtx (int) – default value is 0
Return type:

bool

static ComputeDeviation(*args)
  • Computes the maximal deviation between the two curve representations. dev is an input/output parameter and contains the computed deviation (should be initialized with 0. for the first call). Used by CheckSameParameter().
Parameters:
  • CRef (Adaptor3d_Curve &) –
  • Other (Adaptor3d_Curve &) –
  • SameParameter (bool) –
  • dev (float &) –
  • NCONTROL (int) –
Return type:

bool

Curve3d()
  • Returns the 3d curve and bounding parameteres for the edge Returns False if no 3d curve. If <orient> is True (default), takes orientation into account: if the edge is reversed, cf and cl are toggled
Parameters:
  • edge (TopoDS_Edge &) –
  • C3d (Handle_Geom_Curve &) –
  • cf (float &) –
  • cl (float &) –
  • orient (bool) – default value is Standard_True
Return type:

bool

FirstVertex()
  • Returns start vertex of the edge (taking edge orientation into account).
Parameters:edge (TopoDS_Edge &) –
Return type:TopoDS_Vertex
GetEndTangent2d()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
  • atEnd (bool) –
  • pos (gp_Pnt2d) –
  • tang (gp_Vec2d) –
  • dparam (float) – default value is 0.0
Return type:

bool

  • Returns tangent of the edge pcurve at its start (if atEnd is False) or end (if True), regarding the orientation of edge. If edge is REVERSED, tangent is reversed before return. Returns True if pcurve is available and tangent is computed and is not null, else False.
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
  • atEnd (bool) –
  • pos (gp_Pnt2d) –
  • tang (gp_Vec2d) –
  • dparam (float) – default value is 0.0
Return type:

bool

HasCurve3d()
  • Tells if the edge has a 3d curve
Parameters:edge (TopoDS_Edge &) –
Return type:bool
HasPCurve()
  • Tells if the Edge has a pcurve on the face.
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
Return type:

bool

  • Tells if the edge has a pcurve on the surface (with location).
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
Return type:

bool

IsClosed3d()
  • Gives True if the edge has a 3d curve, this curve is closed, and the edge has the same vertex at start and end
Parameters:edge (TopoDS_Edge &) –
Return type:bool
IsSeam()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
Return type:

bool

  • Returns True if the edge has two pcurves on one surface
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
Return type:

bool

LastVertex()
  • Returns end vertex of the edge (taking edge orientation into account).
Parameters:edge (TopoDS_Edge &) –
Return type:TopoDS_Vertex
PCurve()
Parameters:
  • edge (TopoDS_Edge &) –
  • face (TopoDS_Face &) –
  • C2d (Handle_Geom2d_Curve &) –
  • cf (float &) –
  • cl (float &) –
  • orient (bool) – default value is Standard_True
Return type:

bool

  • Returns the pcurve and bounding parameteres for the edge lying on the surface. Returns False if the edge has no pcurve on this surface. If <orient> is True (default), takes orientation into account: if the edge is reversed, cf and cl are toggled
Parameters:
  • edge (TopoDS_Edge &) –
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
  • C2d (Handle_Geom2d_Curve &) –
  • cf (float &) –
  • cl (float &) –
  • orient (bool) – default value is Standard_True
Return type:

bool

Status()
  • Returns the status (in the form of True/False) of last Check
Parameters:status (ShapeExtend_Status) –
Return type:bool
thisown

The membership flag

ShapeAnalysis_Edge_ComputeDeviation(*args)
  • Computes the maximal deviation between the two curve representations. dev is an input/output parameter and contains the computed deviation (should be initialized with 0. for the first call). Used by CheckSameParameter().
Parameters:
  • CRef (Adaptor3d_Curve &) –
  • Other (Adaptor3d_Curve &) –
  • SameParameter (bool) –
  • dev (float &) –
  • NCONTROL (int) –
Return type:

bool

class ShapeAnalysis_FreeBoundData(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Empty constructor
Return type:None
  • Creates object with contour given in the form of TopoDS_Wire
Parameters:freebound (TopoDS_Wire &) –
Return type:None
AddNotch()
  • Adds notch on the contour with its maximum width
Parameters:
  • notch (TopoDS_Wire &) –
  • width (float) –
Return type:

None

Area()
  • Returns area of the contour
Return type:float
Clear()
  • Clears all properties of the contour. Contour bound itself is not cleared.
Return type:None
FreeBound()
  • Returns contour
Return type:TopoDS_Wire
GetHandle()
NbNotches()
  • Returns number of notches on the contour
Return type:int
Notch()
  • Returns notch on the contour
Parameters:index (int) –
Return type:TopoDS_Wire
NotchWidth()
  • Returns maximum width of notch specified by its rank number on the contour
Parameters:index (int) –
Return type:float
  • Returns maximum width of notch specified as TopoDS_Wire on the contour
Parameters:notch (TopoDS_Wire &) –
Return type:float
Notches()
  • Returns sequence of notches on the contour
Return type:Handle_TopTools_HSequenceOfShape
Perimeter()
  • Returns perimeter of the contour
Return type:float
Ratio()
  • Returns ratio of average length to average width of the contour
Return type:float
SetArea()
  • Sets area of the contour
Parameters:area (float) –
Return type:None
SetFreeBound()
  • Sets contour
Parameters:freebound (TopoDS_Wire &) –
Return type:None
SetPerimeter()
  • Sets perimeter of the contour
Parameters:perimeter (float) –
Return type:None
SetRatio()
  • Sets ratio of average length to average width of the contour
Parameters:ratio (float) –
Return type:None
SetWidth()
  • Sets average width of the contour
Parameters:width (float) –
Return type:None
Width()
  • Returns average width of the contour
Return type:float
thisown

The membership flag

class ShapeAnalysis_FreeBounds(*args)

Bases: object

  • Empty constructor
Return type:None
  • Builds forecasting free bounds of the <shape>. <shape> should be a compound of faces. This constructor is to be used for forecasting free edges with help of sewing analyzer BRepAlgo_Sewing which is called with tolerance <toler>. Free edges are connected into wires only when their ends are at distance less than <toler>. If <splitclosed> is True extracts closed sub-wires out of built closed wires. If <splitopen> is True extracts closed sub-wires out of built open wires.
Parameters:
  • shape (TopoDS_Shape &) –
  • toler (float) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_True
Return type:

None

  • Builds actual free bounds of the <shape>. <shape> should be a compound of shells. This constructor is to be used for getting free edges (ones referenced by the only face) with help of analyzer ShapeAnalysis_Shell. Free edges are connected into wires only when they share the same vertex. If <splitclosed> is True extracts closed sub-wires out of built closed wires. If <splitopen> is True extracts closed sub-wires out of built open wires.
Parameters:
  • shape (TopoDS_Shape &) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_True
  • checkinternaledges (bool) – default value is Standard_False
Return type:

None

static ConnectEdgesToWires(*args)
  • Builds sequnce of <wires> out of sequence of not sorted <edges>. Tries to build wires of maximum length. Building a wire is stopped when no edges can be connected to it at its head or at its tail. //! Orientation of the edge can change when connecting. If <shared> is True connection is performed only when adjacent edges share the same vertex. If <shared> is False connection is performed only when ends of adjacent edges are at distance less than <toler>.
Parameters:
  • edges (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • wires (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

static ConnectWiresToWires(*args)
Parameters:
  • iwires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • owires (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

  • Builds sequnce of <owires> out of sequence of not sorted <iwires>. Tries to build wires of maximum length. Building a wire is stopped when no wires can be connected to it at its head or at its tail. //! Orientation of the wire can change when connecting. If <shared> is True connection is performed only when adjacent wires share the same vertex. If <shared> is False connection is performed only when ends of adjacent wires are at distance less than <toler>. Map <vertices> stores the correspondence between original end vertices of the wires and new connecting vertices.
Parameters:
  • iwires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • owires (Handle_TopTools_HSequenceOfShape &) –
  • vertices (TopTools_DataMapOfShapeShape &) –
Return type:

void

static DispatchWires(*args)
  • Dispatches sequence of <wires> into two compounds <closed> for closed wires and <open> for open wires. If a compound is not empty wires are added into it.
Parameters:
  • wires (Handle_TopTools_HSequenceOfShape &) –
  • closed (TopoDS_Compound &) –
  • open (TopoDS_Compound &) –
Return type:

void

GetClosedWires()
  • Returns compound of closed wires out of free edges.
Return type:TopoDS_Compound
GetOpenWires()
  • Returns compound of open wires out of free edges.
Return type:TopoDS_Compound
static SplitWires(*args)
  • Extracts closed sub-wires out of <wires> and adds them to <closed>, open wires remained after extraction are put into <open>. If <shared> is True extraction is performed only when edges share the same vertex. If <shared> is False connection is performed only when ends of the edges are at distance less than <toler>.
Parameters:
  • wires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • closed (Handle_TopTools_HSequenceOfShape &) –
  • open (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

thisown

The membership flag

class ShapeAnalysis_FreeBoundsProperties(*args)

Bases: object

  • Empty constructor
Return type:None
  • Creates the object and calls corresponding Init. <shape> should be a compound of faces.
Parameters:
  • shape (TopoDS_Shape &) –
  • tolerance (float) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_False
Return type:

None

  • Creates the object and calls corresponding Init. <shape> should be a compound of shells.
Parameters:
  • shape (TopoDS_Shape &) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_False
Return type:

None

CheckContours()
Parameters:prec (float) – default value is 0.0
Return type:bool
CheckNotches()
Parameters:
  • prec (float) – default value is 0.0
  • fbData (Handle_ShapeAnalysis_FreeBoundData &) –
  • prec – default value is 0.0
  • freebound (TopoDS_Wire &) –
  • num (int) –
  • notch (TopoDS_Wire &) –
  • distMax (float &) –
  • prec – default value is 0.0
Return type:

bool

Return type:

bool

Return type:

bool

ClosedFreeBound()
  • Returns properties of closed free bound specified by its rank number
Parameters:index (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
ClosedFreeBounds()
  • Returns all closed free bounds
Return type:Handle_ShapeAnalysis_HSequenceOfFreeBounds
DispatchBounds()
Return type:bool
FillProperties()
Parameters:
  • fbData (Handle_ShapeAnalysis_FreeBoundData &) –
  • prec (float) – default value is 0.0
Return type:

bool

Init()
  • Initializes the object with given parameters. <shape> should be a compound of faces.
Parameters:
  • shape (TopoDS_Shape &) –
  • tolerance (float) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_False
Return type:

None

  • Initializes the object with given parameters. <shape> should be a compound of shells.
Parameters:
  • shape (TopoDS_Shape &) –
  • splitclosed (bool) – default value is Standard_False
  • splitopen (bool) – default value is Standard_False
Return type:

None

IsLoaded()
  • Returns True if shape is loaded
Return type:bool
NbClosedFreeBounds()
  • Returns number of closed free bounds
Return type:int
NbFreeBounds()
  • Returns number of free bounds
Return type:int
NbOpenFreeBounds()
  • Returns number of open free bounds
Return type:int
OpenFreeBound()
  • Returns properties of open free bound specified by its rank number
Parameters:index (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
OpenFreeBounds()
  • Returns all open free bounds
Return type:Handle_ShapeAnalysis_HSequenceOfFreeBounds
Perform()
  • Builds and analyzes free bounds of the shape. First calls ShapeAnalysis_FreeBounds for building free bounds. Then on each free bound computes its properties: - area of the contour, - perimeter of the contour, - ratio of average length to average width of the contour, - average width of contour, - notches on the contour and for each notch - maximum width of the notch.
Return type:bool
Shape()
  • Returns shape
Return type:TopoDS_Shape
Tolerance()
  • Returns tolerance
Return type:float
thisown

The membership flag

ShapeAnalysis_FreeBounds_ConnectEdgesToWires(*args)
  • Builds sequnce of <wires> out of sequence of not sorted <edges>. Tries to build wires of maximum length. Building a wire is stopped when no edges can be connected to it at its head or at its tail. //! Orientation of the edge can change when connecting. If <shared> is True connection is performed only when adjacent edges share the same vertex. If <shared> is False connection is performed only when ends of adjacent edges are at distance less than <toler>.
Parameters:
  • edges (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • wires (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

ShapeAnalysis_FreeBounds_ConnectWiresToWires(*args)
Parameters:
  • iwires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • owires (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

  • Builds sequnce of <owires> out of sequence of not sorted <iwires>. Tries to build wires of maximum length. Building a wire is stopped when no wires can be connected to it at its head or at its tail. //! Orientation of the wire can change when connecting. If <shared> is True connection is performed only when adjacent wires share the same vertex. If <shared> is False connection is performed only when ends of adjacent wires are at distance less than <toler>. Map <vertices> stores the correspondence between original end vertices of the wires and new connecting vertices.
Parameters:
  • iwires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • owires (Handle_TopTools_HSequenceOfShape &) –
  • vertices (TopTools_DataMapOfShapeShape &) –
Return type:

void

ShapeAnalysis_FreeBounds_DispatchWires(*args)
  • Dispatches sequence of <wires> into two compounds <closed> for closed wires and <open> for open wires. If a compound is not empty wires are added into it.
Parameters:
  • wires (Handle_TopTools_HSequenceOfShape &) –
  • closed (TopoDS_Compound &) –
  • open (TopoDS_Compound &) –
Return type:

void

ShapeAnalysis_FreeBounds_SplitWires(*args)
  • Extracts closed sub-wires out of <wires> and adds them to <closed>, open wires remained after extraction are put into <open>. If <shared> is True extraction is performed only when edges share the same vertex. If <shared> is False connection is performed only when ends of the edges are at distance less than <toler>.
Parameters:
  • wires (Handle_TopTools_HSequenceOfShape &) –
  • toler (float) –
  • shared (bool) –
  • closed (Handle_TopTools_HSequenceOfShape &) –
  • open (Handle_TopTools_HSequenceOfShape &) –
Return type:

void

class ShapeAnalysis_Geom

Bases: object

static NearestPlane(*args)
  • Builds a plane out of a set of points in array Returns in <dmax> the maximal distance between the produced plane and given points
Parameters:
Return type:

bool

static PositionTrsf(*args)
  • Builds transfromation object out of matrix. Matrix must be 3 x 4. Unit is used as multiplier.
Parameters:
  • coefs (Handle_TColStd_HArray2OfReal &) –
  • trsf (gp_Trsf) –
  • unit (float) –
  • prec (float) –
Return type:

bool

thisown

The membership flag

ShapeAnalysis_Geom_NearestPlane(*args)
  • Builds a plane out of a set of points in array Returns in <dmax> the maximal distance between the produced plane and given points
Parameters:
Return type:

bool

ShapeAnalysis_Geom_PositionTrsf(*args)
  • Builds transfromation object out of matrix. Matrix must be 3 x 4. Unit is used as multiplier.
Parameters:
  • coefs (Handle_TColStd_HArray2OfReal &) –
  • trsf (gp_Trsf) –
  • unit (float) –
  • prec (float) –
Return type:

bool

class ShapeAnalysis_HSequenceOfFreeBounds(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
Append()
Parameters:
  • anItem (Handle_ShapeAnalysis_FreeBoundData &) –
  • aSequence (Handle_ShapeAnalysis_HSequenceOfFreeBounds &) –
Return type:

None

Return type:

None

ChangeSequence()
Return type:ShapeAnalysis_SequenceOfFreeBounds
ChangeValue()
Parameters:anIndex (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
Clear()
Return type:None
Exchange()
Parameters:
  • anIndex (int) –
  • anOtherIndex (int) –
Return type:

None

GetHandle()
InsertAfter()
Parameters:
  • anIndex (int) –
  • anItem (Handle_ShapeAnalysis_FreeBoundData &) –
  • anIndex
  • aSequence (Handle_ShapeAnalysis_HSequenceOfFreeBounds &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • anIndex (int) –
  • anItem (Handle_ShapeAnalysis_FreeBoundData &) –
  • anIndex
  • aSequence (Handle_ShapeAnalysis_HSequenceOfFreeBounds &) –
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Length()
Return type:int
Prepend()
Parameters:
  • anItem (Handle_ShapeAnalysis_FreeBoundData &) –
  • aSequence (Handle_ShapeAnalysis_HSequenceOfFreeBounds &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • anIndex (int) –
  • fromIndex (int) –
  • toIndex (int) –
Return type:

None

Return type:

None

Reverse()
Return type:None
Sequence()
Return type:ShapeAnalysis_SequenceOfFreeBounds
SetValue()
Parameters:
  • anIndex (int) –
  • anItem (Handle_ShapeAnalysis_FreeBoundData &) –
Return type:

None

Split()
Parameters:anIndex (int) –
Return type:Handle_ShapeAnalysis_HSequenceOfFreeBounds
Value()
Parameters:anIndex (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
thisown

The membership flag

class ShapeAnalysis_SequenceNodeOfSequenceOfFreeBounds(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (Handle_ShapeAnalysis_FreeBoundData &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_ShapeAnalysis_FreeBoundData
thisown

The membership flag

class ShapeAnalysis_SequenceOfFreeBounds(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:None
Append()
Parameters:
  • T (Handle_ShapeAnalysis_FreeBoundData &) –
  • S (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:ShapeAnalysis_SequenceOfFreeBounds
ChangeValue()
Parameters:Index (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
Clear()
Return type:None
First()
Return type:Handle_ShapeAnalysis_FreeBoundData
InsertAfter()
Parameters:
  • Index (int) –
  • T (Handle_ShapeAnalysis_FreeBoundData &) –
  • Index
  • S (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (int) –
  • T (Handle_ShapeAnalysis_FreeBoundData &) –
  • Index
  • S (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_ShapeAnalysis_FreeBoundData
Prepend()
Parameters:
  • T (Handle_ShapeAnalysis_FreeBoundData &) –
  • S (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (int) –
  • FromIndex (int) –
  • ToIndex (int) –
Return type:

None

Return type:

None

Set()
Parameters:Other (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:ShapeAnalysis_SequenceOfFreeBounds
SetValue()
Parameters:
  • Index (int) –
  • I (Handle_ShapeAnalysis_FreeBoundData &) –
Return type:

None

Split()
Parameters:
  • Index (int) –
  • Sub (ShapeAnalysis_SequenceOfFreeBounds &) –
Return type:

None

Value()
Parameters:Index (int) –
Return type:Handle_ShapeAnalysis_FreeBoundData
thisown

The membership flag

class ShapeAnalysis_ShapeContents(*args)

Bases: object

  • Initialize fields and call ClearFlags()
Return type:None
BigSplineSec()
Return type:Handle_TopTools_HSequenceOfShape
Clear()
  • Clears all accumulated statictics
Return type:None
ClearFlags()
  • Clears all flags
Return type:None
GetModifyBigSplineMode()

ShapeAnalysis_ShapeContents_GetModifyBigSplineMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

GetModifyIndirectMode()

ShapeAnalysis_ShapeContents_GetModifyIndirectMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

GetModifyOffestSurfaceMode()

ShapeAnalysis_ShapeContents_GetModifyOffestSurfaceMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

GetModifyOffsetCurveMode()

ShapeAnalysis_ShapeContents_GetModifyOffsetCurveMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

GetModifyTrimmed2dMode()

ShapeAnalysis_ShapeContents_GetModifyTrimmed2dMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

GetModifyTrimmed3dMode()

ShapeAnalysis_ShapeContents_GetModifyTrimmed3dMode(ShapeAnalysis_ShapeContents self) -> Standard_Boolean

IndirectSec()
Return type:Handle_TopTools_HSequenceOfShape
NbBSplibeSurf()
Return type:int
NbBezierSurf()
Return type:int
NbBigSplines()
Return type:int
NbC0Curves()
Return type:int
NbC0Surfaces()
Return type:int
NbEdges()
Return type:int
NbFaceWithSevWires()
Return type:int
NbFaces()
Return type:int
NbFreeEdges()
Return type:int
NbFreeFaces()
Return type:int
NbFreeWires()
Return type:int
NbIndirectSurf()
Return type:int
NbNoPCurve()
Return type:int
NbOffsetCurves()
Return type:int
NbOffsetSurf()
Return type:int
NbSharedEdges()
Return type:int
NbSharedFaces()
Return type:int
NbSharedFreeEdges()
Return type:int
NbSharedFreeWires()
Return type:int
NbSharedShells()
Return type:int
NbSharedSolids()
Return type:int
NbSharedVertices()
Return type:int
NbSharedWires()
Return type:int
NbShells()
Return type:int
NbSolids()
Return type:int
NbSolidsWithVoids()
Return type:int
NbTrimSurf()
Return type:int
NbTrimmedCurve2d()
Return type:int
NbTrimmedCurve3d()
Return type:int
NbVertices()
Return type:int
NbWireWithSevSeams()
Return type:int
NbWireWitnSeam()
Return type:int
NbWires()
Return type:int
OffsetCurveSec()
Return type:Handle_TopTools_HSequenceOfShape
OffsetSurfaceSec()
Return type:Handle_TopTools_HSequenceOfShape
Perform()
  • Counts quantities of sun-shapes in shape and stores sub-shapes according to flags
Parameters:shape (TopoDS_Shape &) –
Return type:None
SetModifyBigSplineMode()

ShapeAnalysis_ShapeContents_SetModifyBigSplineMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

SetModifyIndirectMode()

ShapeAnalysis_ShapeContents_SetModifyIndirectMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

SetModifyOffestSurfaceMode()

ShapeAnalysis_ShapeContents_SetModifyOffestSurfaceMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

SetModifyOffsetCurveMode()

ShapeAnalysis_ShapeContents_SetModifyOffsetCurveMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

SetModifyTrimmed2dMode()

ShapeAnalysis_ShapeContents_SetModifyTrimmed2dMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

SetModifyTrimmed3dMode()

ShapeAnalysis_ShapeContents_SetModifyTrimmed3dMode(ShapeAnalysis_ShapeContents self, Standard_Boolean value)

Trimmed2dSec()
Return type:Handle_TopTools_HSequenceOfShape
Trimmed3dSec()
Return type:Handle_TopTools_HSequenceOfShape
thisown

The membership flag

class ShapeAnalysis_ShapeTolerance(*args)

Bases: object

  • Empty constructor
Return type:None
AddTolerance()
  • Adds data on new Shape to compute Cumulated Tolerance (prepares three computations : maximal, average, minimal)
Parameters:
  • shape (TopoDS_Shape &) –
  • type (TopAbs_ShapeEnum) – default value is TopAbs_SHAPE
Return type:

None

GlobalTolerance()
  • Returns the computed tolerance according to the <mode> <mode> = 0 : average <mode> > 0 : maximal <mode> < 0 : minimal
Parameters:mode (int) –
Return type:float
InTolerance()
  • Determines which shapes have a tolerance within a given interval <type> is interpreted as in the method Tolerance
Parameters:
  • shape (TopoDS_Shape &) –
  • valmin (float) –
  • valmax (float) –
  • type (TopAbs_ShapeEnum) – default value is TopAbs_SHAPE
Return type:

Handle_TopTools_HSequenceOfShape

InitTolerance()
  • Initializes computation of cumulated tolerance
Return type:None
OverTolerance()
  • Determines which shapes have a tolerance over the given value <type> is interpreted as in the method Tolerance
Parameters:
  • shape (TopoDS_Shape &) –
  • value (float) –
  • type (TopAbs_ShapeEnum) – default value is TopAbs_SHAPE
Return type:

Handle_TopTools_HSequenceOfShape

Tolerance()
  • Determines a tolerance from the ones stored in a shape Remark : calls InitTolerance and AddTolerance, hence, can be used to start a series for cumulating tolerance <mode> = 0 : returns the average value between sub-shapes, <mode> > 0 : returns the maximal found, <mode> < 0 : returns the minimal found. <type> defines what kinds of sub-shapes to consider: SHAPE (default) : all : VERTEX, EDGE, FACE, VERTEX : only vertices, EDGE : only edges, FACE : only faces, SHELL : combined SHELL + FACE, for each face (and containing shell), also checks EDGE and VERTEX
Parameters:
  • shape (TopoDS_Shape &) –
  • mode (int) –
  • type (TopAbs_ShapeEnum) – default value is TopAbs_SHAPE
Return type:

float

thisown

The membership flag

class ShapeAnalysis_Shell

Bases: object

BadEdges()
  • Returns the list of bad edges as a Compound It is empty (not null) if no edge are recorded as bad
Return type:TopoDS_Compound
CheckOrientedShells()
  • Checks if shells fulfill orientation condition, i.e. if each edge is, either present once (free edge) or twice (connected edge) but with different orientations (FORWARD/REVERSED) Edges which do not fulfill these conditions are bad //! If <alsofree> is True free edges are considered. Free edges can be queried but are not bad
Parameters:
  • shape (TopoDS_Shape &) –
  • alsofree (bool) – default value is Standard_False
  • checkinternaledges (bool) – default value is Standard_False
Return type:

bool

Clear()
  • Clears data about loaded shells and performed checks
Return type:None
FreeEdges()
  • Returns the list of free (not connected) edges as a Compound It is empty (not null) if no edge are recorded as free
Return type:TopoDS_Compound
HasBadEdges()
  • Tells if at least one edge is recorded as bad
Return type:bool
HasConnectedEdges()
  • Tells if at least one edge is connected (shared twice or more)
Return type:bool
HasFreeEdges()
  • Tells if at least one edge is recorded as free (not connected)
Return type:bool
IsLoaded()
  • Tells if a shape is loaded (only shells are checked)
Parameters:shape (TopoDS_Shape &) –
Return type:bool
LoadShells()
  • Adds shells contained in the <shape> to the list of loaded shells
Parameters:shape (TopoDS_Shape &) –
Return type:None
Loaded()
  • Returns a loaded shape specified by its rank number. Returns null shape if <num> is out of range
Parameters:num (int) –
Return type:TopoDS_Shape
NbLoaded()
  • Returns the actual number of loaded shapes (i.e. shells)
Return type:int
thisown

The membership flag

class ShapeAnalysis_Surface(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an analyzer object on the basis of existing surface
Parameters:S (Handle_Geom_Surface &) –
Return type:None
Adaptor3d()
  • Returns the Adaptor. Creates it if not yet done.
Return type:Handle_GeomAdaptor_HSurface
Bounds()
  • Returns the bounds of the surface (from Bounds from Surface, but buffered)
Parameters:
  • ufirst (float &) –
  • ulast (float &) –
  • vfirst (float &) –
  • vlast (float &) –
Return type:

None

ComputeBoundIsos()
  • Computes bound isos (protected against exceptions)
Return type:None
DegeneratedValues()
  • Returns True if there is at least one surface iso-line which is considered as degenerated with <preci> and distance between P3d and corresponding singular point is less than <preci> (like IsDegenerated). Returns characteristics of the first found boundary matching those criteria.
Parameters:
  • P3d (gp_Pnt) –
  • preci (float) –
  • firstP2d (gp_Pnt2d) –
  • lastP2d (gp_Pnt2d) –
  • firstpar (float &) –
  • lastpar (float &) –
  • forward (bool) – default value is Standard_True
Return type:

bool

Gap()
  • Returns 3D distance found by one of the following methods. IsDegenerated, DegeneratedValues, ProjectDegenerated (distance between 3D point and found or last (if not found) singularity), IsUClosed, IsVClosed (minimum value of precision to consider the surface to be closed), ValueOfUV (distance between 3D point and found solution).
Return type:float
GetBoxUF()
Return type:Bnd_Box
GetBoxUL()
Return type:Bnd_Box
GetBoxVF()
Return type:Bnd_Box
GetBoxVL()
Return type:Bnd_Box
GetHandle()
HasSingularities()
  • Returns True if the surface has singularities for the given precision (i.e. if there are surface singularities with sizes not greater than precision).
Parameters:preci (float) –
Return type:bool
Init()
  • Loads existing surface
Parameters:S (Handle_Geom_Surface &) –
Return type:None
  • Reads all the data from another Surface, without recomputing
Parameters:other (Handle_ShapeAnalysis_Surface &) –
Return type:None
IsDegenerated()
  • Returns True if there is at least one surface boundary which is considered as degenerated with <preci> and distance between P3d and corresponding singular point is less than <preci>
Parameters:
Return type:

bool

  • Returns True if straight pcurve going from point p2d1 to p2d2 is degenerate, i.e. lies in the singularity of the surface. NOTE: it uses another method of detecting singularity than used by ComputeSingularities() et al.! For that, maximums of distances between points p2d1, p2d2 and 0.5*(p2d1+p2d2) and between corresponding 3d points are computed. The pcurve (p2d1, p2d2) is considered as degenerate if: - max distance in 3d is less than <tol> - max distance in 2d is at least <ratio> times greather than the Resolution computed from max distance in 3d (max3d < tol && max2d > ratio * Resolution(max3d)) NOTE: <ratio> should be >1 (e.g. 10)
Parameters:
Return type:

bool

IsUClosed()
  • Tells if the Surface is spatially closed in U with given precision. If <preci> < 0 then Precision::Confusion is used. If Geom_Surface says that the surface is U-closed, this method also says this. Otherwise additional analysis is performed, comparing given precision with the following distances: - periodic B-Splines are closed, - polinomial B-Spline with boundary multiplicities degree+1 and Bezier - maximum distance between poles, - rational B-Spline or one with boundary multiplicities not degree+1 - maximum distance computed at knots and their middles, - surface of extrusion - distance between ends of basis curve, - other (RectangularTrimmed and Offset) - maximum distance computed at 100 equi-distanted points.
Parameters:preci (float) – default value is -1
Return type:bool
IsVClosed()
  • Tells if the Surface is spatially closed in V with given precision. If <preci> < 0 then Precision::Confusion is used. If Geom_Surface says that the surface is V-closed, this method also says this. Otherwise additional analysis is performed, comparing given precision with the following distances: - periodic B-Splines are closed, - polinomial B-Spline with boundary multiplicities degree+1 and Bezier - maximum distance between poles, - rational B-Spline or one with boundary multiplicities not degree+1 - maximum distance computed at knots and their middles, - surface of revolution - distance between ends of basis curve, - other (RectangularTrimmed and Offset) - maximum distance computed at 100 equi-distanted points.
Parameters:preci (float) – default value is -1
Return type:bool
NbSingularities()
  • Returns the number of singularities for the given precision (i.e. number of surface singularities with sizes not greater than precision).
Parameters:preci (float) –
Return type:int
NextValueOfUV()
  • Projects a point P3D on the surface. Does the same thing as ValueOfUV but tries to optimize computations by taking into account previous point <p2dPrev>: makes a step by UV and tries Newton algorithm. If <maxpreci> >0. and distance between solution and P3D is greater than <maxpreci>, that solution is considered as bad, and ValueOfUV() is used. If not succeded, calls ValueOfUV()
Parameters:
Return type:

gp_Pnt2d

ProjectDegenerated()
  • Projects a point <P3d> on a singularity by computing one of the coordinates of preliminary computed <result>. //! Finds the iso-line which is considered as degenerated with <preci> and a. distance between P3d and corresponding singular point is less than <preci> (like IsDegenerated) or b. difference between already computed <result>’s coordinate and iso-coordinate of the boundary is less than 2D resolution (computed from <preci> by Geom_Adaptor). Then sets not yet computed <result>’s coordinate taking it from <neighbour> and returns True.
Parameters:
Return type:

bool

  • Checks points at the beginning (direct is True) or end (direct is False) of array <points> to lie in singularity of surface, and if yes, adjusts the indeterminate 2d coordinate of these points by nearest point which is not in singularity. Returns True if some points were adjusted.
Parameters:
Return type:

bool

SetDomain()
Parameters:
Return type:

None

Singularity()
  • Returns the characteristics of the singularity specified by its rank number <num>. That means, that it is not neccessary for <num> to be in the range [1, NbSingularities] but must be not greater than possible (see ComputeSingularities). The returned characteristics are: preci: the smallest precision with which the iso-line is considered as degenerated, P3d: 3D point of singularity (middle point of the surface iso-line), firstP2d and lastP2d: first and last 2D points of the iso-line in parametrical surface, firstpar and lastpar: first and last parameters of the iso-line in parametrical surface, uisodeg: if the degenerated iso-line is U-iso (True) or V-iso (False). Returns False if <num> is out of range, else returns True.
Parameters:
  • num (int) –
  • preci (float &) –
  • P3d (gp_Pnt) –
  • firstP2d (gp_Pnt2d) –
  • lastP2d (gp_Pnt2d) –
  • firstpar (float &) –
  • lastpar (float &) –
  • uisodeg (bool) –
Return type:

bool

Surface()
  • Returns a surface being analyzed
Return type:Handle_Geom_Surface
TrueAdaptor3d()
  • Returns the Adaptor (may be Null if method Adaptor() was not called)
Return type:Handle_GeomAdaptor_HSurface
UCloseVal()
  • Returns minimum value to consider the surface as U-closed
Return type:float
UIso()
  • Returns a U-Iso. Null if not possible or failed Remark : bound isos are buffered
Parameters:U (float) –
Return type:Handle_Geom_Curve
UVFromIso()
  • Tries a refinement of an already computed couple (U,V) by using projecting 3D point on iso-lines: 1. boundaries of the surface, 2. iso-lines passing through (U,V) 3. iteratively received iso-lines passing through new U and new V (number of iterations is limited by 5 in each direction) Returns the best resulting distance between P3D and Value(U,V) in the case of success. Else, returns a very great value
Parameters:
  • P3D (gp_Pnt) –
  • preci (float) –
  • U (float &) –
  • V (float &) –
Return type:

float

VCloseVal()
  • Returns minimum value to consider the surface as V-closed
Return type:float
VIso()
  • Returns a V-Iso. Null if not possible or failed Remark : bound isos are buffered
Parameters:V (float) –
Return type:Handle_Geom_Curve
Value()
  • Returns a 3D point specified by parameters in surface parametrical space
Parameters:
Return type:

gp_Pnt

  • Returns a 3d point specified by a point in surface parametrical space
Parameters:p2d (gp_Pnt2d) –
Return type:gp_Pnt
ValueOfUV()
  • Computes the parameters in the surface parametrical space of 3D point. The result is parameters of the point projected onto the surface. This method enhances functionality provided by the standard tool GeomAPI_ProjectPointOnSurface by treatment of cases when the projected point is near to the surface boundaries and when this standard tool fails.
Parameters:
Return type:

gp_Pnt2d

thisown

The membership flag

class ShapeAnalysis_TransferParameters(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates empty tool with myShift = 0 and myScale = 1
Return type:None
  • Creates a tool and initializes it with edge and face
Parameters:
  • E (TopoDS_Edge &) –
  • F (TopoDS_Face &) –
Return type:

None

GetHandle()
Init()
  • Initialize a tool with edge and face
Parameters:
  • E (TopoDS_Edge &) –
  • F (TopoDS_Face &) –
Return type:

void

IsSameRange()
  • Returns True if 3d curve of edge and pcurve are SameRange (in default implementation, if myScale == 1 and myShift == 0)
Return type:bool
Perform()
  • Transfers parameters given by sequence Params from 3d curve to pcurve (if To2d is True) or back (if To2d is False)
Parameters:
  • Params (Handle_TColStd_HSequenceOfReal &) –
  • To2d (bool) –
Return type:

Handle_TColStd_HSequenceOfReal

  • Transfers parameter given by sequence Params from 3d curve to pcurve (if To2d is True) or back (if To2d is False)
Parameters:
Return type:

float

SetMaxTolerance()
  • Sets maximal tolerance to use linear recomputation of parameters.
Parameters:maxtol (float) –
Return type:None
TransferRange()
  • Recomputes range of curves from NewEdge. If Is2d equals True parameters are recomputed by curve2d else by curve3d.
Parameters:
  • newEdge (TopoDS_Edge &) –
  • prevPar (float) –
  • currPar (float) –
  • To2d (bool) –
Return type:

void

thisown

The membership flag

class ShapeAnalysis_TransferParametersProj(*args)

Bases: OCC.ShapeAnalysis.ShapeAnalysis_TransferParameters

  • Creats empty constructor.
Return type:

None

Parameters:
  • E (TopoDS_Edge &) –
  • F (TopoDS_Face &) –
Return type:

None

static CopyNMVertex(*args)
  • Make a copy of non-manifold vertex theVert (i.e. create new TVertex and replace PointRepresentations for this vertex from fromedge to toedge. Other representations were copied)
Parameters:
  • theVert (TopoDS_Vertex &) –
  • toedge (TopoDS_Edge &) –
  • fromedge (TopoDS_Edge &) –
Return type:

TopoDS_Vertex

  • Make a copy of non-manifold vertex theVert (i.e. create new TVertex and replace PointRepresentations for this vertex from fromFace to toFace. Other representations were copied)
Parameters:
  • theVert (TopoDS_Vertex &) –
  • toFace (TopoDS_Face &) –
  • fromFace (TopoDS_Face &) –
Return type:

TopoDS_Vertex

GetForceProjection()

ShapeAnalysis_TransferParametersProj_GetForceProjection(ShapeAnalysis_TransferParametersProj self) -> Standard_Boolean

GetHandle()
Perform()
  • Transfers parameters given by sequence Params from 3d curve to pcurve (if To2d is True) or back (if To2d is False)
Parameters:
  • Papams (Handle_TColStd_HSequenceOfReal &) –
  • To2d (bool) –
Return type:

Handle_TColStd_HSequenceOfReal

  • Transfers parameter given by Param from 3d curve to pcurve (if To2d is True) or back (if To2d is False)
Parameters:
Return type:

float

SetForceProjection()

ShapeAnalysis_TransferParametersProj_SetForceProjection(ShapeAnalysis_TransferParametersProj self, Standard_Boolean value)

thisown

The membership flag

ShapeAnalysis_TransferParametersProj_CopyNMVertex(*args)
  • Make a copy of non-manifold vertex theVert (i.e. create new TVertex and replace PointRepresentations for this vertex from fromedge to toedge. Other representations were copied)
Parameters:
  • theVert (TopoDS_Vertex &) –
  • toedge (TopoDS_Edge &) –
  • fromedge (TopoDS_Edge &) –
Return type:

TopoDS_Vertex

  • Make a copy of non-manifold vertex theVert (i.e. create new TVertex and replace PointRepresentations for this vertex from fromFace to toFace. Other representations were copied)
Parameters:
  • theVert (TopoDS_Vertex &) –
  • toFace (TopoDS_Face &) –
  • fromFace (TopoDS_Face &) –
Return type:

TopoDS_Vertex

class ShapeAnalysis_Wire(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Empty constructor
Return type:None
  • Creates object with standard TopoDS_Wire, face and precision
Parameters:
  • wire (TopoDS_Wire &) –
  • face (TopoDS_Face &) –
  • precision (float) –
Return type:

None

  • Creates the object with WireData object, face and precision
Parameters:
  • sbwd (Handle_ShapeExtend_WireData &) –
  • face (TopoDS_Face &) –
  • precision (float) –
Return type:

None

CheckClosed()
  • Checks if wire is closed, performs CheckConnected, CheckDegenerated and CheckLacking for the first and the last edges Returns: True if at least one check returned True Status: FAIL1 or DONE1: see CheckConnected FAIL2 or DONE2: see CheckDegenerated
Parameters:prec (float) – default value is 0.0
Return type:bool
CheckConnected()
  • Calls to CheckConnected for each edge Returns: True if at least one pair of disconnected edges (not sharing the same vertex) was detected
Parameters:prec (float) – default value is 0.0
Return type:bool
  • Checks connected edges (num-th and preceeding). Tests with starting preci from <SBWD> or with <prec> if it is greater. Considers Vertices. Returns: False if edges are connected by the common vertex, else True Status : OK : Vertices (end of num-1 th edge and start on num-th one) are already the same DONE1 : Absolutely confused (gp::Resolution) DONE2 : Confused at starting <preci> from <SBWD> DONE3 : Confused at <prec> but not <preci> FAIL1 : Not confused FAIL2 : Not confused but confused with <preci> if reverse num-th edge
Parameters:
  • num (int) –
  • prec (float) – default value is 0.0
Return type:

bool

CheckCurveGap()
  • Checks gap between points on 3D curve and points on surface generated by pcurve of the num-th edge. The distance can be queried by MinDistance3d. //! Returns: True if status is DONE Status: OK : Gap is less than myPrecision DONE : Gap is greater than myPrecision FAIL : No 3d curve(s) on the edge(s)
Parameters:num (int) – default value is 0
Return type:bool
CheckCurveGaps()
Return type:bool
CheckDegenerated()
  • Calls to CheckDegenerated for each edge Returns: True if at least one incorrect degenerated edge was detected
Return type:bool
  • Checks for degenerated edge between two adjacent ones. Fills parameters dgnr1 and dgnr2 with points in paramterical space that correspond to the singularity (either gap that needs to be filled by degenerated edge or that already filled) Returns: False if no singularity or edge is already degenerated, otherwise True Status: OK : No surface singularity, or edge is already degenerated DONE1: Degenerated edge should be inserted (gap in 2D) DONE2: Edge <num> should be made degenerated (recompute pcurve and set the flag) FAIL1: One of edges neighbouring to degenerated one has no pcurve FAIL2: Edge marked as degenerated and has no pcurve but singularity is not detected
Parameters:
Return type:

bool

  • Checks for degenerated edge between two adjacent ones. Remark : Calls previous function Status : See the function above for details
Parameters:num (int) –
Return type:bool
CheckEdgeCurves()
  • Checks edges geometry (consitency of 2d and 3d senses, adjasment of curves to the vertices, etc.). The order of the checks : Call ShapeAnalysis_Wire to check: ShapeAnalysis_Edge::CheckCurve3dWithPCurve (1), ShapeAnalysis_Edge::CheckVertcesWithPCurve (2), ShapeAnalysis_Edge::CheckVertcesWithCurve3d (3), CheckSeam (4) Additional: CheckGap3d (5), CheckGap2d (6), ShapeAnalysis_Edge::CheckSameParameter (7) Returns: True if at least one check returned True Remark: The numbers in brackets show with what DONEi or FAILi the status can be queried
Return type:bool
CheckGap2d()
  • Checks gap between edges in 2D (pcurves). Checks the distance between ends of pcurves of the num-th and preceeding edge. The distance can be queried by MinDistance2d. //! Returns: True if status is DONE Status: OK : Gap is less than parametric precision out of myPrecision DONE : Gap is greater than parametric precision out of myPrecision FAIL : No pcurve(s) on the edge(s)
Parameters:num (int) – default value is 0
Return type:bool
CheckGap3d()
  • Checks gap between edges in 3D (3d curves). Checks the distance between ends of 3d curves of the num-th and preceeding edge. The distance can be queried by MinDistance3d. //! Returns: True if status is DONE Status: OK : Gap is less than myPrecision DONE : Gap is greater than myPrecision FAIL : No 3d curve(s) on the edge(s)
Parameters:num (int) – default value is 0
Return type:bool
CheckGaps2d()
Return type:bool
CheckGaps3d()
Return type:bool
CheckIntersectingEdges()
  • Checks two adjacent edges for intersecting. Intersection is reported only if intersection point is not enclosed by the common end vertex of the edges. Returns: True if intersection is found. If returns True it also fills the sequences of intersection points, corresponding 3d points, and errors for them (half-distances between intersection points in 3d calculated from one and from another edge) Status: FAIL1 : No pcurve FAIL2 : No vertices DONE1 : Self-intersection found
Parameters:
  • num (int) –
  • points2d (IntRes2d_SequenceOfIntersectionPoint &) –
  • points3d (TColgp_SequenceOfPnt) –
  • errors (TColStd_SequenceOfReal &) –
Return type:

bool

  • Checks two adjacent edges for intersecting. Remark : Calls the previous method Status : See the function above for details
Parameters:num (int) –
Return type:bool
  • Checks i-th and j-th edges for intersecting. Remark : See the previous method for details
Parameters:
  • num1 (int) –
  • num2 (int) –
  • points2d (IntRes2d_SequenceOfIntersectionPoint &) –
  • points3d (TColgp_SequenceOfPnt) –
  • errors (TColStd_SequenceOfReal &) –
Return type:

bool

  • Checks i-th and j-th edges for intersecting. Remark : Calls previous method. Status : See the function above for details
Parameters:
  • num1 (int) –
  • num2 (int) –
Return type:

bool

CheckLacking()
  • Calls to CheckLacking for each edge Returns: True if at least one lacking edge was detected
Return type:bool
  • Checks if there is a gap in 2d between edges, not comprised by the tolerance of their common vertex. If <Tolerance> is greater than 0. and less than tolerance of the vertex, then this value is used for check. Returns: True if not closed gap was detected p2d1 and p2d2 are the endpoint of <num-1>th edge and start of the <num>th edge in 2d. Status: OK: No edge is lacking (3d and 2d connection) FAIL1: edges have no vertices (at least one of them) FAIL2: edges are neither connected by common vertex, nor have coincided vertices FAIL1: edges have no pcurves DONE1: the gap is detected which cannot be closed by the tolerance of the common vertex (or with value of <Tolerance>) DONE2: is set (together with DONE1) if gap is detected and the vector (p2d2 - p2d1) goes in direction opposite to the pcurves of the edges (if angle is more than 0.9*PI).
Parameters:
Return type:

bool

  • Checks if there is a gap in 2D between edges and not comprised by vertex tolerance The value of SBWD.thepreci is used. Returns: False if no edge should be inserted Status: OK : No edge is lacking (3d and 2d connection) DONE1 : The vertex tolerance should be increased only (2d gap is small) DONE2 : Edge can be inserted (3d and 2d gaps are large enough)
Parameters:
  • num (int) –
  • Tolerance (float) – default value is 0.0
Return type:

bool

CheckLoop()
  • Checks existance of loop on wire and return vertices wich are loop vertices (vertices belonging to a few pairs of edges)
Parameters:
  • aMapLoopVertices (TopTools_IndexedMapOfShape &) –
  • aMapVertexEdges (TopTools_DataMapOfShapeListOfShape &) –
  • aMapSmallEdges (TopTools_MapOfShape &) –
  • aMapSeemEdges (TopTools_MapOfShape &) –
Return type:

bool

CheckNotchedEdges()
  • Detects a notch
Parameters:
  • num (int) –
  • shortNum (int &) –
  • param (float &) –
  • Tolerance (float) – default value is 0.0
Return type:

bool

CheckOrder()
  • Calls CheckOrder and returns False if wire is already ordered (tail-to-head), True otherwise Flag <isClosed> defines if the wire is closed or not Flag <mode3d> defines which mode is used (3d or 2d)
Parameters:
  • isClosed (bool) – default value is Standard_True
  • mode3d (bool) – default value is Standard_True
Return type:

bool

  • Analyzes the order of the edges in the wire, uses class WireOrder for that purpose. Flag <isClosed> defines if the wire is closed or not Flag <mode3d> defines which mode is used (3d or 2d) Returns False if wire is already ordered (tail-to-head), True otherwise. Use returned WireOrder object for deeper analysis. Status: OK : the same edges orientation, the same edges sequence DONE1: the same edges orientation, not the same edges sequence DONE2: as DONE1 and gaps more than myPrecision DONE3: not the same edges orientation (some need to be reversed) DONE4: as DONE3 and gaps more than myPrecision FAIL : algorithm failed (could not detect order)
Parameters:
  • sawo (ShapeAnalysis_WireOrder &) –
  • isClosed (bool) – default value is Standard_True
  • mode3d (bool) – default value is Standard_True
Return type:

bool

CheckOuterBound()
  • Checks if wire defines an outer bound on the face Uses ShapeAnalysis::IsOuterBound for analysis If <APIMake> is True uses BRepAPI_MakeWire to build the wire, if False (to be used only when edges share common vertices) uses BRep_Builder to build the wire
Parameters:APIMake (bool) – default value is Standard_True
Return type:bool
CheckSeam()
  • Checks if a seam pcurves are correct oriented Returns: False (status OK) if given edge is not a seam or if it is OK C1 - current pcurve for FORWARD edge, C2 - current pcurve for REVERSED edge (if returns True they should be swapped for the seam), cf, cl - first and last parameters on curves Status: OK : Pcurves are correct or edge is not seam DONE : Seam pcurves should be swapped
Parameters:
  • num (int) –
  • C1 (Handle_Geom2d_Curve &) –
  • C2 (Handle_Geom2d_Curve &) –
  • cf (float &) –
  • cl (float &) –
Return type:

bool

  • Checks if a seam pcurves are correct oriented See previous functions for details
Parameters:num (int) –
Return type:bool
CheckSelfIntersectingEdge()
  • Checks if num-th edge is self-intersecting. Self-intersection is reported only if intersection point lies outside of both end vertices of the edge. Returns: True if edge is self-intersecting. If returns True it also fills the sequences of intersection points and corresponding 3d points (only that are not enclosed by a vertices) Status: FAIL1 : No pcurve FAIL2 : No vertices DONE1 : Self-intersection found
Parameters:
Return type:

bool

Return type:

bool

CheckSelfIntersection()
  • Checks self-intersection of the wire (considering pcurves) Looks for self-intersecting edges and each pair of intersecting edges. Warning: It does not check each edge with any other one (only each two adjacent edges) The order of the checks : CheckSelfIntersectingEdge, CheckIntersectingEdges Returns: True if at least one check returned True Status: FAIL1 or DONE1 - see CheckSelfIntersectingEdge FAIL2 or DONE2 - see CheckIntersectingEdges
Return type:bool
CheckShapeConnect()
  • Checks with what orientation <shape> (wire or edge) can be connected to the wire. Tests distances with starting <preci> from <SBWD> (close confusion), but if given <prec> is greater, tests with <prec> (coarse confusion). The smallest found distance can be returned by MinDistance3d //! Returns: False if status is FAIL (see below) Status: DONE1 : If <shape> follows <SBWD>, direct sense (normal) DONE2 : If <shape> follows <SBWD>, but if reversed DONE3 : If <shape> preceeds <SBWD>, direct sense DONE4 : If <shape> preceeds <SBWD>, but if reversed FAIL1 : If <shape> is neither an edge nor a wire FAIL2 : If <shape> cannot be connected to <SBWD> //! DONE5 : To the tail of <SBWD> the <shape> is closer with direct sense DONE6 : To the head of <SBWD> the <shape> is closer with direct sense //! Remark: Statuses DONE1 - DONE4, FAIL1 - FAIL2 are basic and describe the nearest connection of the <shape> to <SBWD>. Statuses DONE5 and DONE6 are advanced and are to be used when analyzing with what sense (direct or reversed) the <shape> should be connected to <SBWD>: For tail of <SBWD> if DONE4 is True <shape> should be direct, otherwise reversed. For head of <SBWD> if DONE5 is True <shape> should be direct, otherwise reversed.
Parameters:
  • shape (TopoDS_Shape &) –
  • prec (float) – default value is 0.0
Return type:

bool

  • The same as previous CheckShapeConnect but is more advanced. It returns the distances between each end of <sbwd> and each end of <shape>. For example, <tailhead> stores distance between tail of <sbwd> and head of <shape> Remark: First method CheckShapeConnect calls this one
Parameters:
  • tailhead (float &) –
  • tailtail (float &) –
  • headtail (float &) –
  • headhead (float &) –
  • shape (TopoDS_Shape &) –
  • prec (float) – default value is 0.0
Return type:

bool

CheckSmall()
  • Calls to CheckSmall for each edge Returns: True if at least one small edge was detected
Parameters:precsmall (float) – default value is 0.0
Return type:bool
  • Checks if an edge has a length not greater than myPreci or precsmall (if it is smaller) Returns: False if its length is greater than precision Status: OK : edge is not small or degenerated DONE1: edge is small, vertices are the same DONE2: edge is small, vertices are not the same FAIL : no 3d curve and pcurve
Parameters:
  • num (int) –
  • precsmall (float) – default value is 0.0
Return type:

bool

CheckSmallArea()
  • Checks if wire has parametric area less than prec2d.
Parameters:prec2d (float) – default value is 0
Return type:bool
ClearStatuses()
  • Unsets all the status and distance fields wire, face and precision are not cleared
Return type:None
Face()
  • Returns the working face
Return type:TopoDS_Face
GetHandle()
Init()
  • Initializes the object with standard TopoDS_Wire, face and precision
Parameters:
  • wire (TopoDS_Wire &) –
  • face (TopoDS_Face &) –
  • precision (float) –
Return type:

None

  • Initializes the object with WireData object, face and precision
Parameters:
  • sbwd (Handle_ShapeExtend_WireData &) –
  • face (TopoDS_Face &) –
  • precision (float) –
Return type:

None

IsLoaded()
  • Returns True if wire is loaded and has number of edges >0
Return type:bool
IsReady()
  • Returns True if IsLoaded and underlying face is not null
Return type:bool
LastCheckStatus()
  • Querying the status of the LAST perfomed ‘Advanced’ checking procedure
Parameters:Status (ShapeExtend_Status) –
Return type:bool
Load()
  • Loads the object with standard TopoDS_Wire
Parameters:wire (TopoDS_Wire &) –
Return type:None
  • Loads the object with WireData object
Parameters:sbwd (Handle_ShapeExtend_WireData &) –
Return type:None
MaxDistance2d()
  • Returns the last maximal distance in 2D-UV computed by CheckContinuity2d
Return type:float
MaxDistance3d()
  • Returns the last maximal distance in 3D computed by CheckOrientation, CheckConnected, CheckContinuity3d, CheckVertex, CheckNewVertex, CheckSameParameter
Return type:float
MinDistance2d()
  • Returns the last lowest distance in 2D-UV computed by CheckContinuity2d
Return type:float
MinDistance3d()
  • Returns the last lowest distance in 3D computed by CheckOrientation, CheckConnected, CheckContinuity3d, CheckVertex, CheckNewVertex
Return type:float
NbEdges()
  • Returns the number of edges in the wire, or 0 if it is not loaded
Return type:int
Perform()
  • Performs all the checks in the following order : CheckOrder, CheckSmall, CheckConected, CheckEdgeCurves, CheckDegenerated, CheckSelfIntersection, CheckLacking, CheckClosed Returns: True if at least one method returned True; For deeper analysis use Status...(status) methods
Return type:bool
Precision()
  • Returns the value of precision
Return type:float
SetFace()
  • Loads the face the wire lies on
Parameters:face (TopoDS_Face &) –
Return type:None
SetPrecision()
Parameters:precision (float) –
Return type:None
SetSurface()
  • Loads the surface the wire lies on
Parameters:surface (Handle_Geom_Surface &) –
Return type:None
  • Loads the surface the wire lies on
Parameters:
  • surface (Handle_Geom_Surface &) –
  • location (TopLoc_Location &) –
Return type:

None

StatusClosed()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusConnected()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusCurveGaps()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusDegenerated()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusEdgeCurves()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusGaps2d()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusGaps3d()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusLacking()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusLoop()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusOrder()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusSelfIntersection()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
StatusSmall()
Parameters:Status (ShapeExtend_Status) –
Return type:bool
Surface()
  • Returns the working surface
Return type:Handle_ShapeAnalysis_Surface
WireData()
  • Returns wire object being analyzed
Return type:Handle_ShapeExtend_WireData
thisown

The membership flag

class ShapeAnalysis_WireOrder(*args)

Bases: object

  • Empty constructor
Return type:None
  • Creates a WireOrder in 3D (if mode3d is True) or 2D (if False) with a tolerance
Parameters:
Return type:

None

Add()
  • Adds a couple of points 3D (start,end)
Parameters:
Return type:

None

  • Adds a couple of points 2D (start,end)
Parameters:
Return type:

None

Chain()
  • Returns, for the chain n0 num, starting and ending numbers of edges. In the list of ordered edges (see Ordered for originals)
Parameters:
  • num (int) –
  • n1 (int &) –
  • n2 (int &) –
Return type:

None

Clear()
  • Clears the list of edges, but not mode and tol
Return type:None
Couple()
  • Returns, for the couple n0 num, the two implied edges In the list of ordered edges
Parameters:
  • num (int) –
  • n1 (int &) –
  • n2 (int &) –
Return type:

None

Gap()
  • Returns the gap between a couple and its preceeding <num> is considered ordered If <num> = 0 (D), returns the greatest gap found
Parameters:num (int) – default value is 0
Return type:float
GetKeepLoopsMode()

ShapeAnalysis_WireOrder_GetKeepLoopsMode(ShapeAnalysis_WireOrder self) -> Standard_Boolean

IsDone()
  • Tells if Perform has been done Else, the following methods returns original values
Return type:bool
NbChains()
  • Returns the count of computed chains
Return type:int
NbCouples()
  • Returns the count of computed couples
Return type:int
NbEdges()
  • Returns the count of added couples of points (one per edges)
Return type:int
Ordered()
  • Returns the number of original edge which correspond to the newly ordered number <n> Warning : the returned value is NEGATIVE if edge should be reversed
Parameters:n (int) –
Return type:int
Perform()
  • Computes the better order If <closed> is True (D) considers also closure Optimised if the couples were already in order The criterium is : two couples in order if distance between end-prec and start-cur is less then starting tolerance <tol> Else, the smallest distance is reached Gap corresponds to a smallest distance greater than <tol>
Parameters:closed (bool) – default value is Standard_True
Return type:None
SetChains()
  • Determines the chains inside which successive edges have a gap less than a given value. Queried by NbChains and Chain
Parameters:gap (float) –
Return type:None
SetCouples()
  • Determines the couples of edges for which end and start fit inside a given gap. Queried by NbCouples and Couple
Parameters:gap (float) –
Return type:None
SetKeepLoopsMode()

ShapeAnalysis_WireOrder_SetKeepLoopsMode(ShapeAnalysis_WireOrder self, Standard_Boolean value)

SetMode()
  • Sets new values. Clears the connexion list If <mode3d> changes, also clears the edge list (else, doesnt)
Parameters:
Return type:

None

Status()
  • Returns the status of the order (0 if not done) : 0 : all edges are direct and in sequence 1 : all edges are direct but some are not in sequence 2 : in addition, unresolved gaps remain -1 : some edges are reversed, but no gap remain -2 : some edges are reversed and some gaps remain -10 : COULD NOT BE RESOLVED, Failure on Reorder gap : regarding starting <tol>
Return type:int
Tolerance()
  • Returns the working tolerance
Return type:float
XY()
  • Returns the values of the couple <num>, as 2D values
Parameters:
Return type:

None

XYZ()
  • Returns the values of the couple <num>, as 3D values
Parameters:
Return type:

None

thisown

The membership flag

class ShapeAnalysis_WireVertex(*args)

Bases: object

  • Empty constructor
Return type:None
Analyze()
Return type:None
Data()
  • Returns the recorded status for a vertex With its recorded position and parameters on both edges These values are relevant regarding the status: Status Meaning Position Preceeding Following 0 Same no no no 1 SameCoord no no no 2 Close no no no 3 End yes no yes 4 Start yes yes no 5 Inters yes yes yes -1 Disjoined no no no
Parameters:
  • num (int) –
  • pos (gp_XYZ) –
  • upre (float &) –
  • ufol (float &) –
Return type:

int

Init()
Parameters:
  • wire (TopoDS_Wire &) –
  • preci (float) –
  • swbd (Handle_ShapeExtend_WireData &) –
  • preci
Return type:

None

Return type:

None

IsDone()
  • Returns True if analysis was performed, else returns False
Return type:bool
Load()
Parameters:
  • wire (TopoDS_Wire &) –
  • sbwd (Handle_ShapeExtend_WireData &) –
Return type:

None

Return type:

None

NbEdges()
  • Returns the number of edges in analyzed wire (i.e. the length of all arrays)
Return type:int
NextCriter()
  • For a given criter, returns the rank of the vertex which follows <num> and has the same status. 0 if no more Acts as an iterator, starts on the first one Criters are: 0: same vertex (status 0) 1: a solution exists (status >= 0) 2: same coords (i.e. same params) (status 0 1 2) 3: same coods but not same vertex (status 1 2) 4: redefined coords (status 3 4 5) -1: no solution (status -1)
Parameters:
  • crit (int) –
  • num (int) – default value is 0
Return type:

int

NextStatus()
  • For a given status, returns the rank of the vertex which follows <num> and has the same status. 0 if no more Acts as an iterator, starts on the first one
Parameters:
  • stat (int) –
  • num (int) – default value is 0
Return type:

int

Position()
Parameters:num (int) –
Return type:gp_XYZ
Precision()
  • Returns precision value used in analysis
Return type:float
SetClose()
  • Records status ‘Close Coords’ (at the Precision of <self>)
Parameters:num (int) –
Return type:None
SetDisjoined()
  • <num> cannot be said as same vertex
Parameters:num (int) –
Return type:None
SetEnd()
  • <num> is the End of preceeding Edge, and its projection on the following one lies on it at the Precision of <self> <ufol> gives the parameter on the following edge
Parameters:
Return type:

None

SetInters()
  • <num> is the Intersection of both Edges <upre> is the parameter on preceeding edge, <ufol> on following edge
Parameters:
Return type:

None

SetPrecision()
  • Sets the precision for work Analysing: for each Vertex, comparison between the end of the preceeding edge and the start of the following edge Each Vertex rank corresponds to the End Vertex of the Edge of same rank, in the ShapeExtend_WireData. I.E. for Vertex <num>, Edge <num> is the preceeding one, <num+1> is the following one
Parameters:preci (float) –
Return type:None
SetSameCoords()
  • Records status ‘Same Coords’ (at the Vertices Tolerances)
Parameters:num (int) –
Return type:None
SetSameVertex()
  • Records status ‘Same Vertex’ (logically) on Vertex <num>
Parameters:num (int) –
Return type:None
SetStart()
  • <num> is the Start of following Edge, its projection on the preceeding one lies on it at the Precision of <self> <upre> gives the parameter on the preceeding edge
Parameters:
Return type:

None

Status()
  • Returns the recorded status for a vertex More detail by method Data
Parameters:num (int) –
Return type:int
UFollowing()
Parameters:num (int) –
Return type:float
UPrevious()
Parameters:num (int) –
Return type:float
WireData()
  • Returns analyzed wire
Return type:Handle_ShapeExtend_WireData
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

class shapeanalysis

Bases: object

static AdjustByPeriod(*args)
  • Returns a shift required to move point <Val> to the range [ToVal-Period/2,ToVal+Period/2]. This shift will be the divisible by Period. Intended for adjusting parameters on periodic surfaces.
Parameters:
Return type:

float

static AdjustToPeriod(*args)
  • Returns a shift required to move point <Val> to the range [ValMin,ValMax]. This shift will be the divisible by Period with Period = ValMax - ValMin. Intended for adjusting parameters on periodic surfaces.
Parameters:
Return type:

float

static ContourArea(*args)
  • Returns a total area of 3d wire
Parameters:theWire (TopoDS_Wire &) –
Return type:float
static FindBounds(*args)
  • Finds the start and end vertices of the shape Shape can be of the following type: vertex: V1 and V2 are the same and equal to <shape>, edge : V1 is start and V2 is end vertex (see ShapeAnalysis_Edge methods FirstVertex and LastVertex), wire : V1 is start vertex of the first edge, V2 is end vertex of the last edge (also see ShapeAnalysis_Edge). If wire contains no edges V1 and V2 are nullified If none of the above V1 and V2 are nullified
Parameters:
  • shape (TopoDS_Shape &) –
  • V1 (TopoDS_Vertex &) –
  • V2 (TopoDS_Vertex &) –
Return type:

void

static GetFaceUVBounds(*args)
  • Computes exact UV bounds of all wires on the face
Parameters:
  • F (TopoDS_Face &) –
  • Umin (float &) –
  • Umax (float &) –
  • Vmin (float &) –
  • Vmax (float &) –
Return type:

void

static IsOuterBound(*args)
  • Returns True if <F> has outer bound.
Parameters:face (TopoDS_Face &) –
Return type:bool
static OuterWire(*args)
  • Returns the outer wire on the face <Face>. This is replacement of the method BRepTools::OuterWire until it works badly. Returns the first wire oriented as outer according to FClass2d_Classifier. If none, last wire is returned.
Parameters:face (TopoDS_Face &) –
Return type:TopoDS_Wire
static TotCross2D(*args)
  • Returns a total area of 2d wire
Parameters:
  • sewd (Handle_ShapeExtend_WireData &) –
  • aFace (TopoDS_Face &) –
Return type:

float

thisown

The membership flag

shapeanalysis_AdjustByPeriod(*args)
  • Returns a shift required to move point <Val> to the range [ToVal-Period/2,ToVal+Period/2]. This shift will be the divisible by Period. Intended for adjusting parameters on periodic surfaces.
Parameters:
Return type:

float

shapeanalysis_AdjustToPeriod(*args)
  • Returns a shift required to move point <Val> to the range [ValMin,ValMax]. This shift will be the divisible by Period with Period = ValMax - ValMin. Intended for adjusting parameters on periodic surfaces.
Parameters:
Return type:

float

shapeanalysis_ContourArea(*args)
  • Returns a total area of 3d wire
Parameters:theWire (TopoDS_Wire &) –
Return type:float
shapeanalysis_FindBounds(*args)
  • Finds the start and end vertices of the shape Shape can be of the following type: vertex: V1 and V2 are the same and equal to <shape>, edge : V1 is start and V2 is end vertex (see ShapeAnalysis_Edge methods FirstVertex and LastVertex), wire : V1 is start vertex of the first edge, V2 is end vertex of the last edge (also see ShapeAnalysis_Edge). If wire contains no edges V1 and V2 are nullified If none of the above V1 and V2 are nullified
Parameters:
  • shape (TopoDS_Shape &) –
  • V1 (TopoDS_Vertex &) –
  • V2 (TopoDS_Vertex &) –
Return type:

void

shapeanalysis_GetFaceUVBounds(*args)
  • Computes exact UV bounds of all wires on the face
Parameters:
  • F (TopoDS_Face &) –
  • Umin (float &) –
  • Umax (float &) –
  • Vmin (float &) –
  • Vmax (float &) –
Return type:

void

shapeanalysis_IsOuterBound(*args)
  • Returns True if <F> has outer bound.
Parameters:face (TopoDS_Face &) –
Return type:bool
shapeanalysis_OuterWire(*args)
  • Returns the outer wire on the face <Face>. This is replacement of the method BRepTools::OuterWire until it works badly. Returns the first wire oriented as outer according to FClass2d_Classifier. If none, last wire is returned.
Parameters:face (TopoDS_Face &) –
Return type:TopoDS_Wire
shapeanalysis_TotCross2D(*args)
  • Returns a total area of 2d wire
Parameters:
  • sewd (Handle_ShapeExtend_WireData &) –
  • aFace (TopoDS_Face &) –
Return type:

float