OCC.Core.BRepTools module¶

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

class BRepTools_GTrsfModification(*args)¶

Bases: OCC.Core.BRepTools.BRepTools_Modification

Parameters

T –

type T: gp_GTrsf
rtype: None

static DownCast(t)¶

GTrsf()¶

Gives an access on the GTrsf.

rtype

gp_GTrsf

property thisown¶: The membership flag

class BRepTools_History(BRepTools_History self) → BRepTools_History¶

Bases: OCC.Core.Standard.Standard_Transient

AddGenerated()¶

Methods to set the history. Set the second shape as generated one from the first shape.

param theInitial

type theInitial

TopoDS_Shape

param theGenerated

type theGenerated

TopoDS_Shape

rtype

None

AddModified()¶

Set the second shape as modified one from the first shape.

param theInitial

type theInitial

TopoDS_Shape

param theModified

type theModified

TopoDS_Shape

rtype

None

Clear()¶

Clears the history.

rtype

None

static DownCast(t)¶

DumpToString(BRepTools_History self) → std::string¶

Generated()¶

Methods to read the history. Returns all shapes generated from the shape.

param theInitial

type theInitial

TopoDS_Shape

rtype

TopTools_ListOfShape

HasGenerated()¶

Returns ‘true’ if there any shapes with Generated elements present

rtype

bool

HasModified()¶

Returns ‘true’ if there any Modified shapes present

rtype

bool

HasRemoved()¶

Returns ‘true’ if there any removed shapes present

rtype

bool

IsRemoved()¶

Returns ‘true’ if the shape is removed.

param theInitial

type theInitial

TopoDS_Shape

rtype

bool

static IsSupportedType()¶

Returns ‘true’ if the type of the shape is supported by the history.

param theShape

type theShape

TopoDS_Shape

rtype

bool

Modified()¶

Returns all shapes modified from the shape.

param theInitial

type theInitial

TopoDS_Shape

rtype

TopTools_ListOfShape

Remove()¶

Set the shape as removed one.

param theRemoved

type theRemoved

TopoDS_Shape

rtype

None

ReplaceGenerated()¶

Set the second shape as the only generated one from the first one.

param theInitial

type theInitial

TopoDS_Shape

param theGenerated

type theGenerated

TopoDS_Shape

rtype

None

ReplaceModified()¶

Set the second shape as the only modified one from the first one.

param theInitial

type theInitial

TopoDS_Shape

param theModified

type theModified

TopoDS_Shape

rtype

None

TRelationType_Generated = 1¶

TRelationType_Modified = 2¶

TRelationType_Removed = 0¶

property thisown¶: The membership flag

class BRepTools_MapOfVertexPnt2d(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class BRepTools_Modification(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Continuity()¶

Returns the continuity of <NewE> between <NewF1> and <NewF2>. <NewE> is the new edge created from <E>. <NewF1> (resp. <NewF2>) is the new face created from <F1> (resp. <F2>).

param E

type E

TopoDS_Edge

param F1

type F1

TopoDS_Face

param F2

type F2

TopoDS_Face

param NewE

type NewE

TopoDS_Edge

param NewF1

type NewF1

TopoDS_Face

param NewF2

type NewF2

TopoDS_Face

rtype

GeomAbs_Shape

static DownCast(t)¶

NewCurve()¶

Returns true if the edge, E, has been modified. If the edge has been modified: - C is the new geometry associated with the edge, - L is its new location, and - Tol is the new tolerance. If the edge has not been modified, this function returns false, and the values of C, L and Tol are not significant.

param E

type E

TopoDS_Edge

param C

type C

Geom_Curve

param L

type L

TopLoc_Location

param Tol

type Tol

float

rtype

bool

NewCurve2d()¶

Returns true if the edge, E, has a new curve on surface on the face, F. If a new curve exists: - C is the new geometry of the edge, - L is the new location, and - Tol is the new tolerance. NewE is the new edge created from E, and NewF is the new face created from F. If there is no new curve on the face, this function returns false, and the values of C, L and Tol are not significant.

param E

type E

TopoDS_Edge

param F

type F

TopoDS_Face

param NewE

type NewE

TopoDS_Edge

param NewF

type NewF

TopoDS_Face

param C

type C

Geom2d_Curve

param Tol

type Tol

float

rtype

bool

NewParameter()¶

Returns true if the vertex V has a new parameter on the edge E. If a new parameter exists: - P is the parameter, and - Tol is the new tolerance. If there is no new parameter this function returns false, and the values of P and Tol are not significant.

param V

type V

TopoDS_Vertex

param E

type E

TopoDS_Edge

param P

type P

float

param Tol

type Tol

float

rtype

bool

NewPoint()¶

Returns true if the vertex V has been modified. If V has been modified: - P is the new geometry of the vertex, and - Tol is the new tolerance. If the vertex has not been modified this function returns false, and the values of P and Tol are not significant.

param V

type V

TopoDS_Vertex

param P

type P

gp_Pnt

param Tol

type Tol

float

rtype

bool

NewPolygon()¶

Returns true if the edge has been modified according to changed polygon. If the edge has been modified: - P is a new polygon

param E

type E

TopoDS_Edge

param P

type P

Poly_Polygon3D

rtype

bool

NewPolygonOnTriangulation()¶

Returns true if the edge has been modified according to changed polygon on triangulation. If the edge has been modified: - P is a new polygon on triangulation

param E

type E

TopoDS_Edge

param F

type F

TopoDS_Face

param P

type P

Poly_PolygonOnTriangulation

rtype

bool

NewSurface()¶

Returns true if the face, F, has been modified. If the face has been modified: - S is the new geometry of the face, - L is its new location, and - Tol is the new tolerance. The flag, RevWires, is set to true when the modification reverses the normal of the surface, (i.e. the wires have to be reversed). The flag, RevFace, is set to true if the orientation of the modified face changes in the shells which contain it. If the face has not been modified this function returns false, and the values of S, L, Tol, RevWires and RevFace are not significant.

param F

type F

TopoDS_Face

param S

type S

Geom_Surface

param L

type L

TopLoc_Location

param Tol

type Tol

float

param RevWires

type RevWires

bool

param RevFace

type RevFace

bool

rtype

bool

NewTriangulation()¶

Returns true if the face has been modified according to changed triangulation. If the face has been modified: - T is a new triangulation on the face

param F

type F

TopoDS_Face

param T

type T

Poly_Triangulation

rtype

bool

property thisown¶: The membership flag

class BRepTools_Modifier(*args)¶

Bases: object

Creates an empty Modifier.

param theMutableInput

default value is Standard_False

type theMutableInput

bool

rtype

None* Creates a modifier on the shape <S>.

param S

type S

TopoDS_Shape

rtype

None* Creates a modifier on the shape <S>, and performs the modifications described by <M>.

param S

type S

TopoDS_Shape

param M

type M

BRepTools_Modification

rtype

None

Init()¶

Initializes the modifier with the shape <S>.

param S

type S

TopoDS_Shape

rtype

None

IsDone()¶

Returns Standard_True if the modification has been computed successfully.

rtype

bool

IsMutableInput()¶

Returns the current mutable input state

rtype

bool

ModifiedShape()¶

Returns the modified shape corresponding to <S>.

param S

type S

TopoDS_Shape

rtype

TopoDS_Shape

Perform()¶

Performs the modifications described by <M>.

param M

type M

BRepTools_Modification

param aProgress

default value is NULL

type aProgress

Message_ProgressIndicator

rtype

None

SetMutableInput()¶

Sets the mutable input state If true then the input (original) shape can be modified during modification process

param theMutableInput

type theMutableInput

bool

rtype

None

property thisown¶: The membership flag

class BRepTools_NurbsConvertModification(*args)¶

Bases: OCC.Core.BRepTools.BRepTools_Modification

Return type: None

static DownCast(t)¶

GetUpdatedEdges()¶

Return type: TopTools_ListOfShape

property thisown¶: The membership flag

class BRepTools_Quilt(*args)¶

Bases: object

Return type: None

Add()¶

Add the faces of <S> to the Quilt, the faces containing bounded edges are copied.

param S

type S

TopoDS_Shape

rtype

None

Bind()¶

Binds <Enew> to be the new edge instead of <Eold>. //! The faces of the added shape containing <Eold> will be copied to substitute <Eold> by <Enew>. //! The vertices of <Eold> will be bound to the vertices of <Enew> with the same orientation. //! If <Eold> and <Enew> have different orientations the curves are considered to be opposite and the pcurves of <Eold> will be copied and reversed in the new faces. //! <Eold> must belong to the next added shape, <Enew> must belong to a Shape added before.

param Eold

type Eold

TopoDS_Edge

param Enew

type Enew

TopoDS_Edge

rtype

None* Binds <VNew> to be a new vertex instead of <Vold>. //! The faces of the added shape containing <Vold> will be copied to substitute <Vold> by <Vnew>.

param Vold

type Vold

TopoDS_Vertex

param Vnew

type Vnew

TopoDS_Vertex

rtype

None

Copy()¶

Returns the shape substitued to <S> in the Quilt.

param S

type S

TopoDS_Shape

rtype

TopoDS_Shape

IsCopied()¶

Returns True if <S> has been copied (<S> is a vertex, an edge or a face)

param S

type S

TopoDS_Shape

rtype

bool

Shells()¶

Returns a Compound of shells made from the current set of faces. The shells will be flagged as closed or not closed.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class BRepTools_ReShape(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Returns an empty Reshape

rtype

None

Apply()¶

Applies the substitutions requests to a shape. //! <until> gives the level of type until which requests are taken into account. For subshapes of the type <until> no rebuild and futher exploring are done. //! NOTE: each subshape can be replaced by shape of the same type or by shape containing only shapes of that type (for example, TopoDS_Edge can be replaced by TopoDS_Edge, TopoDS_Wire or TopoDS_Compound containing TopoDS_Edges). If incompatible shape type is encountered, it is ignored and flag FAIL1 is set in Status.

param shape

type shape

TopoDS_Shape

param until

default value is TopAbs_SHAPE

type until

TopAbs_ShapeEnum

rtype

TopoDS_Shape

Clear()¶

Clears all substitutions requests

rtype

void

CopyVertex()¶

Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.

param theV

type theV

TopoDS_Vertex

param theTol

default value is -1.0

type theTol

float

rtype

TopoDS_Vertex* Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.

param theV

type theV

TopoDS_Vertex

param theNewPos

type theNewPos

gp_Pnt

param aTol

type aTol

float

rtype

TopoDS_Vertex

static DownCast(t)¶

GetModeConsiderLocation(BRepTools_ReShape self) → Standard_Boolean¶

History()¶

Returns the history of the substituted shapes.

rtype

opencascade::handle<BRepTools_History>

IsNewShape()¶

Checks if shape has been recorded by reshaper as a value

param theShape

type theShape

TopoDS_Shape

rtype

bool

IsRecorded()¶

Tells if a shape is recorded for Replace/Remove

param shape

type shape

TopoDS_Shape

rtype

bool

Remove()¶

Sets a request to Remove a Shape whatever the orientation

param shape

type shape

TopoDS_Shape

rtype

void

Replace()¶

Sets a request to Replace a Shape by a new one.

param shape

type shape

TopoDS_Shape

param newshape

type newshape

TopoDS_Shape

rtype

None

SetModeConsiderLocation(BRepTools_ReShape self, Standard_Boolean value)¶

Status()¶

Returns a complete substitution status for a shape 0not recorded, <newsh> = original <shape> < 0: to be removed, <newsh> is NULL > 0: to be replaced, <newsh> is a new item If <last> is False, returns status and new shape recorded in the map directly for the shape, if True and status > 0 then recursively searches for the last status and new shape.

param shape

type shape

TopoDS_Shape

param newsh

type newsh

TopoDS_Shape

param last

default value is Standard_False

type last

bool

rtype

int

Value()¶

Returns the new value for an individual shape If not recorded, returns the original shape itself If to be Removed, returns a Null Shape Else, returns the replacing item

param shape

type shape

TopoDS_Shape

rtype

TopoDS_Shape

property thisown¶: The membership flag

class BRepTools_ShapeSet(*args)¶

Bases: OCC.Core.TopTools.TopTools_ShapeSet

Builds an empty ShapeSet. Parameter <isWithTriangles> is added for XML Persistence

param isWithTriangles

default value is Standard_True

type isWithTriangles

bool

rtype

None* Builds an empty ShapeSet. Parameter <isWithTriangles> is added for XML Persistence

param B

type B

BRep_Builder

param isWithTriangles

default value is Standard_True

type isWithTriangles

bool

rtype

None

DumpGeometryToString(BRepTools_ShapeSet self) → std::string¶

DumpPolygon3DToString(BRepTools_ShapeSet self) → std::string¶

DumpPolygonOnTriangulationToString(BRepTools_ShapeSet self) → std::string¶

DumpTriangulationToString(BRepTools_ShapeSet self) → std::string¶

ReadGeometryFromString(BRepTools_ShapeSet self, std::string src)¶

ReadPolygon3DFromString(BRepTools_ShapeSet self, std::string src)¶

ReadPolygonOnTriangulationFromString(BRepTools_ShapeSet self, std::string src)¶

ReadTriangulationFromString(BRepTools_ShapeSet self, std::string src)¶

WriteGeometryToString(BRepTools_ShapeSet self) → std::string¶

WritePolygon3D()¶

Writes the 3d polygons on the stream <OS> in a format that can be read back by Read.

param OS

type OS

Standard_OStream

param Compact

default value is Standard_True

type Compact

bool

rtype

None

WritePolygonOnTriangulation()¶

Writes the polygons on triangulation on the stream <OS> in a format that can be read back by Read.

param OS

type OS

Standard_OStream

param Compact

default value is Standard_True

type Compact

bool

rtype

None

WriteTriangulation()¶

Writes the triangulation on the stream <OS> in a format that can be read back by Read.

param OS

type OS

Standard_OStream

param Compact

default value is Standard_True

type Compact

bool

rtype

None

property thisown¶: The membership flag

class BRepTools_Substitution(*args)¶

Bases: object

Return type: None

Build()¶

Build NewShape from <S> if its subshapes has modified. //! The methods <IsCopied> and <Copy> allows you to keep the resul of <Build>

param S

type S

TopoDS_Shape

rtype

None

Clear()¶

Reset all the fields.

rtype

None

Copy()¶

Returns the set of shapes substitued to <S> .

param S

type S

TopoDS_Shape

rtype

TopTools_ListOfShape

IsCopied()¶

Returns True if <S> has been replaced .

param S

type S

TopoDS_Shape

rtype

bool

Substitute()¶

<Oldshape> will be replaced by <NewShapes>. //! <NewShapes> can be empty , in this case <OldShape> will disparate from its ancestors. //! if an item of <NewShapes> is oriented FORWARD. it will be oriented as <OldShape> in its ancestors. else it will be reversed.

param OldShape

type OldShape

TopoDS_Shape

param NewShapes

type NewShapes

TopTools_ListOfShape

rtype

None

property thisown¶: The membership flag

class BRepTools_TrsfModification(*args)¶

Bases: OCC.Core.BRepTools.BRepTools_Modification

Parameters

T –

type T: gp_Trsf
rtype: None

static DownCast(t)¶

Trsf()¶

Provides access to the gp_Trsf associated with this modification. The transformation can be changed.

rtype

gp_Trsf

property thisown¶: The membership flag

class BRepTools_WireExplorer(*args)¶

Bases: object

Constructs an empty explorer (which can be initialized using Init)

rtype

None* IInitializes an exploration of the wire <W>.

param W

type W

TopoDS_Wire

rtype

None* Initializes an exploration of the wire <W>. F is used to select the edge connected to the previous in the parametric representation of <F>.

param W

type W

TopoDS_Wire

param F

type F

TopoDS_Face

rtype

None

Clear()¶

Clears the content of the explorer.

rtype

None

Current()¶

Returns the current edge.

rtype

TopoDS_Edge

CurrentVertex()¶

Returns the vertex connecting the current edge to the previous one.

rtype

TopoDS_Vertex

Init()¶

Initializes an exploration of the wire <W>.

param W

type W

TopoDS_Wire

rtype

None* Initializes an exploration of the wire <W>. F is used to select the edge connected to the previous in the parametric representation of <F>.

param W

type W

TopoDS_Wire

param F

type F

TopoDS_Face

rtype

None* Initializes an exploration of the wire <W>. F is used to select the edge connected to the previous in the parametric representation of <F>. <UMIn>, <UMax>, <VMin>, <VMax> - the UV bounds of the face <F>.

param W

type W

TopoDS_Wire

param F

type F

TopoDS_Face

param UMin

type UMin

float

param UMax

type UMax

float

param VMin

type VMin

float

param VMax

type VMax

float

rtype

None

More()¶

Returns True if there is a current edge.

rtype

bool

Next()¶

Proceeds to the next edge.

rtype

None

Orientation()¶

Returns an Orientation for the current edge.

rtype

TopAbs_Orientation

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

Bases: object

static AddUVBounds()¶

Adds to the box the bounding values in the parametric space of F.

param F

type F

TopoDS_Face

param B

type B

Bnd_Box2d

rtype

void* Adds to the box the bounding values of the wire in the parametric space of F.

param F

type F

TopoDS_Face

param W

type W

TopoDS_Wire

param B

type B

Bnd_Box2d

rtype

void* Adds to the box the bounding values of the edge in the parametric space of F.

param F

type F

TopoDS_Face

param E

type E

TopoDS_Edge

param B

type B

Bnd_Box2d

rtype

void

static Clean()¶

Removes all the triangulations of the faces of <S> and removes all polygons on triangulations of the edges.

param S

type S

TopoDS_Shape

rtype

void

static CleanGeometry()¶

Removes geometry (curves and surfaces) from all edges and faces of the shape

param theShape

type theShape

TopoDS_Shape

rtype

void

static Compare()¶

Returns True if the distance between the two vertices is lower than their tolerance.

param V1

type V1

TopoDS_Vertex

param V2

type V2

TopoDS_Vertex

rtype

bool* Returns True if the distance between the two edges is lower than their tolerance.

param E1

type E1

TopoDS_Edge

param E2

type E2

TopoDS_Edge

rtype

bool

static DetectClosedness()¶

Detect closedness of face in U and V directions

param theFace

type theFace

TopoDS_Face

param theUclosed

type theUclosed

bool

param theVclosed

type theVclosed

bool

rtype

void

static Dump()¶

Dumps the topological structure and the geometry of <Sh> on the stream <S>.

param Sh

type Sh

TopoDS_Shape

param S

type S

Standard_OStream

rtype

void

static EvalAndUpdateTol()¶

Evals real tolerance of edge <theE>. <theC3d>, <theC2d>, <theS>, <theF>, <theL> are correspondently 3d curve of edge, 2d curve on surface <theS> and rang of edge If calculated tolerance is more then current edge tolerance, edge is updated. Method returns actual tolerance of edge

param theE

type theE

TopoDS_Edge

param theC3d

type theC3d

Geom_Curve

param theC2d

type theC2d

Geom2d_Curve

param theS

type theS

Geom_Surface

param theF

type theF

float

param theL

type theL

float

rtype

float

static IsReallyClosed()¶

Verifies that the edge <E> is found two times on the face <F> before calling BRep_Tool::IsClosed.

param E

type E

TopoDS_Edge

param F

type F

TopoDS_Face

rtype

bool

static Map3DEdges()¶

Stores in the map <M> all the 3D topology edges of <S>.

param S

type S

TopoDS_Shape

param M

type M

TopTools_IndexedMapOfShape

rtype

void

static OuterWire()¶

Returns the outer most wire of <F>. Returns a Null wire if <F> has no wires.

param F

type F

TopoDS_Face

rtype

TopoDS_Wire

static Read()¶

Reads a Shape from <S> in returns it in <Sh>. is used to build the shape.

param Sh

type Sh

TopoDS_Shape

param S

type S

Standard_IStream

param B

type B

BRep_Builder

param PR

default value is NULL

type PR

Message_ProgressIndicator

rtype

void* Reads a Shape from <File>, returns it in <Sh>. is used to build the shape.

param Sh

type Sh

TopoDS_Shape

param File

type File

char *

param B

type B

BRep_Builder

param PR

default value is NULL

type PR

Message_ProgressIndicator

rtype

bool

static RemoveUnusedPCurves()¶

Removes all the pcurves of the edges of <S> that refer to surfaces not belonging to any face of <S>

param S

type S

TopoDS_Shape

rtype

void

static Triangulation()¶

verifies that each face from the shape <S> has got a triangulation with a deflection <= deflec and the edges a discretisation on this triangulation.

param S

type S

TopoDS_Shape

param deflec

type deflec

float

rtype

bool

static UVBounds()¶

Returns in UMin, UMax, VMin, VMax the bounding values in the parametric space of F.

param F

type F

TopoDS_Face

param UMin

type UMin

float

param UMax

type UMax

float

param VMin

type VMin

float

param VMax

type VMax

float

rtype

void* Returns in UMin, UMax, VMin, VMax the bounding values of the wire in the parametric space of F.

param F

type F

TopoDS_Face

param W

type W

TopoDS_Wire

param UMin

type UMin

float

param UMax

type UMax

float

param VMin

type VMin

float

param VMax

type VMax

float

rtype

void* Returns in UMin, UMax, VMin, VMax the bounding values of the edge in the parametric space of F.

param F

type F

TopoDS_Face

param E

type E

TopoDS_Edge

param UMin

type UMin

float

param UMax

type UMax

float

param VMin

type VMin

float

param VMax

type VMax

float

rtype

void

static Update()¶

Update a vertex (nothing is done)

param V

type V

TopoDS_Vertex

rtype

void* Update an edge, compute 2d bounding boxes.

param E

type E

TopoDS_Edge

rtype

void* Update a wire (nothing is done)

param W

type W

TopoDS_Wire

rtype

void* Update a Face, update UV points.

param F

type F

TopoDS_Face

rtype

void* Update a shell (nothing is done)

param S

type S

TopoDS_Shell

rtype

void* Update a solid (nothing is done)

param S

type S

TopoDS_Solid

rtype

void* Update a composite solid (nothing is done)

param C

type C

TopoDS_CompSolid

rtype

void* Update a compound (nothing is done)

param C

type C

TopoDS_Compound

rtype

void* Update a shape, call the corect update.

param S

type S

TopoDS_Shape

rtype

void

static UpdateFaceUVPoints()¶

For each edge of the face <F> reset the UV points to the bounding points of the parametric curve of the edge on the face.

param theF

type theF

TopoDS_Face

rtype

void

static Write()¶

Writes <Sh> on <S> in an ASCII format.

param Sh

type Sh

TopoDS_Shape

param S

type S

Standard_OStream

param PR

default value is NULL

type PR

Message_ProgressIndicator

rtype

void* Writes <Sh> in <File>.

param Sh

type Sh

TopoDS_Shape

param File

type File

char *

param PR

default value is NULL

type PR

Message_ProgressIndicator

rtype

bool

property thisown¶: The membership flag