OCC.Core.BRepSweep module

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

class BRepSweep_Builder(*args)

Bases: object

• Creates a Builder.

  param aBuilder

  type aBuilder

  BRep_Builder

  rtype

  None

Add()

• Adds the Shape 1 in the Shape 2, set to <Orient> orientation.

  param aShape1

  type aShape1

  TopoDS_Shape

  param aShape2

  type aShape2

  TopoDS_Shape

  param Orient

  type Orient

  TopAbs_Orientation

  rtype

  None* Adds the Shape 1 in the Shape 2.

  param aShape1

  type aShape1

  TopoDS_Shape

  param aShape2

  type aShape2

  TopoDS_Shape

  rtype

  None

Builder()

Return type

BRep_Builder

MakeCompSolid()

• Returns an empty CompSolid.

  param aCompSolid

  type aCompSolid

  TopoDS_Shape

  rtype

  None

MakeCompound()

• Returns an empty Compound.

  param aCompound

  type aCompound

  TopoDS_Shape

  rtype

  None

MakeShell()

• Returns an empty Shell.

  param aShell

  type aShell

  TopoDS_Shape

  rtype

  None

MakeSolid()

• Returns an empty Solid.

  param aSolid

  type aSolid

  TopoDS_Shape

  rtype

  None

MakeWire()

• Returns an empty Wire.

  param aWire

  type aWire

  TopoDS_Shape

  rtype

  None

property thisown

The membership flag

class BRepSweep_Iterator(*args)

Bases: object

Return type

None

Init()

• Resest the Iterator on sub-shapes of <aShape>.

  param aShape

  type aShape

  TopoDS_Shape

  rtype

  None

More()

• Returns True if there is a current sub-shape.

  rtype

  bool

Next()

• Moves to the next sub-shape.

  rtype

  None

Orientation()

• Returns the orientation of the current sub-shape.

  rtype

  TopAbs_Orientation

Value()

• Returns the current sub-shape.

  rtype

  TopoDS_Shape

property thisown

The membership flag

class BRepSweep_NumLinearRegularSweep(*args, **kwargs)

Bases: object

Closed()

Return type

bool

DirectSolid()

• Returns the Orientation of the shell in the solid generated by the face aGenS with the edge aDirS. It is REVERSED if the surface is swept in the direction of the normal.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  TopAbs_Orientation

FirstShape()

• Returns the resulting Shape indexed by the first Vertex of myDirWire and myGenShape.

  rtype

  TopoDS_Shape* Returns the resulting Shape indexed by the first Vertex of myDirWire and aGenS.

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

GDDShapeIsToAdd()

• Returns true if aNewSubShape (addressed by aGenS and aSubDirS) must be added in aNewShape (addressed by aGenS and aDirS).

  param aNewShape

  type aNewShape

  TopoDS_Shape

  param aNewSubShape

  type aNewSubShape

  TopoDS_Shape

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  param aSubDirS

  type aSubDirS

  Sweep_NumShape

  rtype

  bool

GGDShapeIsToAdd()

• Returns true if aNewSubShape (addressed by aSubGenS and aDirS) must be added in aNewShape (addressed by aGenS and aDirS).

  param aNewShape

  type aNewShape

  TopoDS_Shape

  param aNewSubShape

  type aNewSubShape

  TopoDS_Shape

  param aGenS

  type aGenS

  TopoDS_Shape

  param aSubGenS

  type aSubGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  bool

GenIsUsed()

• Returns true if the shape, generated from theS is used in result shape

  param theS

  type theS

  TopoDS_Shape

  rtype

  bool

HasShape()

• Returns true if aDirS and aGenS addresses a resulting Shape. In some specific cases the shape can be geometrically inexsistant, then this function returns false.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  bool

IsInvariant()

• Returns true if aGenS cannot be transformed.

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  bool

IsUsed()

• Returns true if the initial shape aGenS is used in result shape

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  bool

LastShape()

• Returns the resulting Shape indexed by the last Vertex of myDirWire and myGenShape.

  rtype

  TopoDS_Shape* Returns the resulting Shape indexed by the last Vertex of myDirWire and aGenS.

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

MakeEmptyDirectingEdge()

• Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirE

  type aDirE

  Sweep_NumShape

  rtype

  TopoDS_Shape

MakeEmptyFace()

• Builds the face addressed by [aGenS,aDirS], with its geometric part, but without subcomponents. The couple aGenS, aDirS can be a ‘generating face and a directing vertex’ or ‘a generating edge and a directing edge’.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  TopoDS_Shape

MakeEmptyGeneratingEdge()

• Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.

  param aGenE

  type aGenE

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  TopoDS_Shape

MakeEmptyVertex()

• Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  TopoDS_Shape

SeparatedWires()

• In some particular cases the topology of a generated face must be composed of independant closed wires, in this case this function returns true.

  param aNewShape

  type aNewShape

  TopoDS_Shape

  param aNewSubShape

  type aNewSubShape

  TopoDS_Shape

  param aGenS

  type aGenS

  TopoDS_Shape

  param aSubGenS

  type aSubGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  bool

SetContinuity()

• Called to propagate the continuity of every vertex between two edges of the generating wire aGenS on the generated edge and faces.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  void

SetDirectingPCurve()

• Sets the PCurve for a new edge on a new face. The new edge and the new face were generated using aGenE, aDirE and aGenV.

  param aNewFace

  type aNewFace

  TopoDS_Shape

  param aNewEdge

  type aNewEdge

  TopoDS_Shape

  param aGenE

  type aGenE

  TopoDS_Shape

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirE

  type aDirE

  Sweep_NumShape

  param orien

  type orien

  TopAbs_Orientation

  rtype

  void

SetDirectingParameter()

• Sets the parameter of the new vertex on the new edge. The new edge and new vertex where generated from aGenV aDirE, and aDirV.

  param aNewEdge

  type aNewEdge

  TopoDS_Shape

  param aNewVertex

  type aNewVertex

  TopoDS_Shape

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirE

  type aDirE

  Sweep_NumShape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  void

SetGeneratingPCurve()

• Sets the PCurve for a new edge on a new face. The new edge and the new face were generated using aGenE, aDirE and aDirV.

  param aNewFace

  type aNewFace

  TopoDS_Shape

  param aNewEdge

  type aNewEdge

  TopoDS_Shape

  param aGenE

  type aGenE

  TopoDS_Shape

  param aDirE

  type aDirE

  Sweep_NumShape

  param aDirV

  type aDirV

  Sweep_NumShape

  param orien

  type orien

  TopAbs_Orientation

  rtype

  void

SetGeneratingParameter()

• Sets the parameter of the new vertex on the new edge. The new edge and new vertex where generated from aGenE, aGenV and aDirV .

  param aNewEdge

  type aNewEdge

  TopoDS_Shape

  param aNewVertex

  type aNewVertex

  TopoDS_Shape

  param aGenE

  type aGenE

  TopoDS_Shape

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  void

SetPCurve()

• Sets the PCurve for a new edge on a new face. The new edge and the new face were generated using aGenF, aGenE and aDirV.

  param aNewFace

  type aNewFace

  TopoDS_Shape

  param aNewEdge

  type aNewEdge

  TopoDS_Shape

  param aGenF

  type aGenF

  TopoDS_Shape

  param aGenE

  type aGenE

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  param orien

  type orien

  TopAbs_Orientation

  rtype

  void

SetParameters()

• Sets the parameters of the new vertex on the new face. The new face and new vertex where generated from aGenF, aGenV and aDirV .

  param aNewFace

  type aNewFace

  TopoDS_Shape

  param aNewVertex

  type aNewVertex

  TopoDS_Shape

  param aGenF

  type aGenF

  TopoDS_Shape

  param aGenV

  type aGenV

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  void

Shape()

• Returns the resulting Shape indexed by aDirS and aGenS.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirS

  type aDirS

  Sweep_NumShape

  rtype

  TopoDS_Shape* Returns the resulting Shape indexed by myDirWire and aGenS.

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape* Returns the resulting Shape indexed by myDirWire and myGenShape.

  rtype

  TopoDS_Shape

SplitShell()

• In some particular cases the topology of a generated Shell must be composed of independant closed Shells, in this case this function returns a Compound of independant Shells.

  param aNewShape

  type aNewShape

  TopoDS_Shape

  rtype

  TopoDS_Shape

property thisown

The membership flag

class BRepSweep_Prism(*args)

Bases: object

• Builds the prism of base S and vector V. If C is true, S is copied. If Canonize is true then generated surfaces are attempted to be canonized in simple types

  param S

  type S

  TopoDS_Shape

  param V

  type V

  gp_Vec

  param Copy

  default value is Standard_False

  type Copy

  bool

  param Canonize

  default value is Standard_True

  type Canonize

  bool

  rtype

  None* Builds a semi-infinite or an infinite prism of base S. If Copy is true S is copied. If Inf is true the prism is infinite, if Inf is false the prism is infinite in the direction D. If Canonize is true then generated surfaces are attempted to be canonized in simple types

  param S

  type S

  TopoDS_Shape

  param D

  type D

  gp_Dir

  param Inf

  default value is Standard_True

  type Inf

  bool

  param Copy

  default value is Standard_False

  type Copy

  bool

  param Canonize

  default value is Standard_True

  type Canonize

  bool

  rtype

  None

FirstShape()

• Returns the TopoDS Shape of the bottom of the prism.

  rtype

  TopoDS_Shape* Returns the TopoDS Shape of the bottom of the prism. generated with aGenS (subShape of the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

GenIsUsed()

• Returns true if the shape, generated from theS is used in result shape

  param theS

  type theS

  TopoDS_Shape

  rtype

  bool

IsUsed()

• Returns true if the aGenS is used in resulting shape

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  bool

LastShape()

• Returns the TopoDS Shape of the top of the prism.

  rtype

  TopoDS_Shape* Returns the TopoDS Shape of the top of the prism. generated with aGenS (subShape of the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

Shape()

• Returns the TopoDS Shape attached to the prism.

  rtype

  TopoDS_Shape* Returns the TopoDS Shape generated with aGenS (subShape of the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

Vec()

• Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.

  rtype

  gp_Vec

property thisown

The membership flag

class BRepSweep_Revol(*args)

Bases: object

• Builds the Revol of meridian S axis A and angle D. If C is true S is copied.

  param S

  type S

  TopoDS_Shape

  param A

  type A

  gp_Ax1

  param D

  type D

  float

  param C

  default value is Standard_False

  type C

  bool

  rtype

  None* Builds the Revol of meridian S axis A and angle 2*Pi. If C is true S is copied.

  param S

  type S

  TopoDS_Shape

  param A

  type A

  gp_Ax1

  param C

  default value is Standard_False

  type C

  bool

  rtype

  None

Angle()

• returns the angle.

  rtype

  float

Axe()

• returns the axis

  rtype

  gp_Ax1

FirstShape()

• Returns the first shape of the revol (coinciding with the generating shape).

  rtype

  TopoDS_Shape* Returns the first shape of the revol (coinciding with the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

IsUsed()

• Returns true if the aGenS is used in resulting Shape

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  bool

LastShape()

• Returns the TopoDS Shape of the top of the prism.

  rtype

  TopoDS_Shape* Returns the TopoDS Shape of the top of the prism. generated with aGenS (subShape of the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

Shape()

• Returns the TopoDS Shape attached to the Revol.

  rtype

  TopoDS_Shape* Returns the TopoDS Shape generated with aGenS (subShape of the generating shape).

  param aGenS

  type aGenS

  TopoDS_Shape

  rtype

  TopoDS_Shape

property thisown

The membership flag

class BRepSweep_Rotation(*args)

Bases: OCC.Core.BRepSweep.BRepSweep_Trsf

• Creates a topology by rotating <S> around A with the angle D.

  param S

  type S

  TopoDS_Shape

  param N

  type N

  Sweep_NumShape

  param L

  type L

  TopLoc_Location

  param A

  type A

  gp_Ax1

  param D

  type D

  float

  param C

  type C

  bool

  rtype

  None

Angle()

• returns the angle.

  rtype

  float

Axe()

• returns the axis

  rtype

  gp_Ax1

property thisown

The membership flag

class BRepSweep_Tool(*args)

Bases: object

• Initialize the tool with <aShape>. The IndexTool must prepare an indexation for all the subshapes of this shape.

  param aShape

  type aShape

  TopoDS_Shape

  rtype

  None

Index()

• Returns the index of <aShape>.

  param aShape

  type aShape

  TopoDS_Shape

  rtype

  int

NbShapes()

• Returns the number of subshapes in the shape.

  rtype

  int

Orientation()

• Returns the Orientation of <aShape>.

  param aShape

  type aShape

  TopoDS_Shape

  rtype

  TopAbs_Orientation

SetOrientation()

• Set the Orientation of <aShape> with Or.

  param aShape

  type aShape

  TopoDS_Shape

  param Or

  type Or

  TopAbs_Orientation

  rtype

  None

Shape()

• Returns the Shape at Index anIdex.

  param anIndex

  type anIndex

  int

  rtype

  TopoDS_Shape

Type()

• Returns the type of <aShape>.

  param aShape

  type aShape

  TopoDS_Shape

  rtype

  TopAbs_ShapeEnum

property thisown

The membership flag

class BRepSweep_Translation(*args)

Bases: OCC.Core.BRepSweep.BRepSweep_Trsf

• Creates a topology by translating <S> with the vector <V>. If C is true S Sucomponents are copied. If Canonize is true then generated surfaces are attempted to be canonized in simple types

  param S

  type S

  TopoDS_Shape

  param N

  type N

  Sweep_NumShape

  param L

  type L

  TopLoc_Location

  param V

  type V

  gp_Vec

  param C

  type C

  bool

  param Canonize

  default value is Standard_True

  type Canonize

  bool

  rtype

  None

Vec()

• Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.

  rtype

  gp_Vec

property thisown

The membership flag

class BRepSweep_Trsf(*args, **kwargs)

Bases: OCC.Core.BRepSweep.BRepSweep_NumLinearRegularSweep

Init()

• ends the construction of the swept primitive calling the virtual geometric functions that can’t be called in the initialize.

  rtype

  None

Process()

• function called to analize the way of construction of the shapes generated by aGenS and aDirV.

  param aGenS

  type aGenS

  TopoDS_Shape

  param aDirV

  type aDirV

  Sweep_NumShape

  rtype

  bool

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()