# OCC.BRepSweep module

class `BRepSweep_Builder`(*args)

  Bases: `object`

  - Creates a Builder.

  Parameters: | aBuilder (BRep_Builder &) –
  Return type: | None

  `Add`()
    - Adds the Shape 1 in the Shape 2, set to <Orient> orientation.

    Parameters: | aShape1 (TopoDS_Shape &) – aShape2 (TopoDS_Shape &) – Orient (TopAbs_Orientation) –
    Return type: | None

    - Adds the Shape 1 in the Shape 2.

    Parameters: | aShape1 (TopoDS_Shape &) – aShape2 (TopoDS_Shape &) –
    Return type: | None

  `Builder`()

    Return type: | BRep_Builder

  `MakeCompSolid`()
    - Returns an empty CompSolid.

    Parameters: | aCompSolid (TopoDS_Shape &) –
    Return type: | None

  `MakeCompound`()
    - Returns an empty Compound.

    Parameters: | aCompound (TopoDS_Shape &) –
    Return type: | None

  `MakeShell`()
    - Returns an empty Shell.

    Parameters: | aShell (TopoDS_Shape &) –
    Return type: | None

  `MakeSolid`()
    - Returns an empty Solid.

    Parameters: | aSolid (TopoDS_Shape &) –
    Return type: | None

  `MakeWire`()
    - Returns an empty Wire.

    Parameters: | aWire (TopoDS_Shape &) –
    Return type: | None

  `thisown`

    The membership flag

class `BRepSweep_Iterator`(*args)

  Bases: `object`

  Return type: | None

  `Init`()
    - Resest the Iterator on sub-shapes of <aShape>.

    Parameters: | aShape (TopoDS_Shape &) –
    Return type: | None

  `More`()
    - Returns True if there is a current sub-shape.

    Return type: | bool

  `Next`()
    - Moves to the next sub-shape.

    Return type: | None

  `Orientation`()
    - Returns the orientation of the current sub-shape.

    Return type: | TopAbs_Orientation

  `Value`()
    - Returns the current sub-shape.

    Return type: | TopoDS_Shape

  `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.

    Parameters: | aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | TopAbs_Orientation

  `FirstShape`()
    - Returns the resulting Shape indexed by the first Vertex of myDirWire and myGenShape.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

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

    Parameters: | aNewShape (TopoDS_Shape &) – aNewSubShape (TopoDS_Shape &) – aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) – aSubDirS (Sweep_NumShape &) –
    Return type: | bool

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

    Parameters: | aNewShape (TopoDS_Shape &) – aNewSubShape (TopoDS_Shape &) – aGenS (TopoDS_Shape &) – aSubGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | 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.

    Parameters: | aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | bool

  `LastShape`()
    - Returns the resulting Shape indexed by the last Vertex of myDirWire and myGenShape.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `MakeEmptyDirectingEdge`()
    - Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.

    Parameters: | aGenV (TopoDS_Shape &) – aDirE (Sweep_NumShape &) –
    Return type: | 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’.

    Parameters: | aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | TopoDS_Shape

  `MakeEmptyGeneratingEdge`()
    - Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.

    Parameters: | aGenE (TopoDS_Shape &) – aDirV (Sweep_NumShape &) –
    Return type: | TopoDS_Shape

  `MakeEmptyVertex`()
    - Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.

    Parameters: | aGenV (TopoDS_Shape &) – aDirV (Sweep_NumShape &) –
    Return type: | 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.

    Parameters: | aNewShape (TopoDS_Shape &) – aNewSubShape (TopoDS_Shape &) – aGenS (TopoDS_Shape &) – aSubGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | bool

  `SetContinuity`()
    - Called to propagate the continuity of every vertex between two edges of the generating wire aGenS on the generated edge and faces.

    Parameters: | aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | 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.

    Parameters: | aNewFace (TopoDS_Shape &) – aNewEdge (TopoDS_Shape &) – aGenE (TopoDS_Shape &) – aGenV (TopoDS_Shape &) – aDirE (Sweep_NumShape &) – orien (TopAbs_Orientation) –
    Return type: | 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.

    Parameters: | aNewEdge (TopoDS_Shape &) – aNewVertex (TopoDS_Shape &) – aGenV (TopoDS_Shape &) – aDirE (Sweep_NumShape &) – aDirV (Sweep_NumShape &) –
    Return type: | 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.

    Parameters: | aNewFace (TopoDS_Shape &) – aNewEdge (TopoDS_Shape &) – aGenE (TopoDS_Shape &) – aDirE (Sweep_NumShape &) – aDirV (Sweep_NumShape &) – orien (TopAbs_Orientation) –
    Return type: | 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 .

    Parameters: | aNewEdge (TopoDS_Shape &) – aNewVertex (TopoDS_Shape &) – aGenE (TopoDS_Shape &) – aGenV (TopoDS_Shape &) – aDirV (Sweep_NumShape &) –
    Return type: | 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.

    Parameters: | aNewFace (TopoDS_Shape &) – aNewEdge (TopoDS_Shape &) – aGenF (TopoDS_Shape &) – aGenE (TopoDS_Shape &) – aDirV (Sweep_NumShape &) – orien (TopAbs_Orientation) –
    Return type: | 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 .

    Parameters: | aNewFace (TopoDS_Shape &) – aNewVertex (TopoDS_Shape &) – aGenF (TopoDS_Shape &) – aGenV (TopoDS_Shape &) – aDirV (Sweep_NumShape &) –
    Return type: | void

  `Shape`()
    - Returns the resulting Shape indexed by aDirS and aGenS.

    Parameters: | aGenS (TopoDS_Shape &) – aDirS (Sweep_NumShape &) –
    Return type: | TopoDS_Shape

    - Returns the resulting Shape indexed by myDirWire and aGenS.

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

    - Returns the resulting Shape indexed by myDirWire and myGenShape.

    Return type: | 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.

    Parameters: | aNewShape (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `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

  Parameters: | S (TopoDS_Shape &) – V (gp_Vec) – Copy (bool) – default value is Standard_False Canonize (bool) – default value is Standard_True
  Return type: | 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

  Parameters: | S (TopoDS_Shape &) – D (gp_Dir) – Inf (bool) – default value is Standard_True Copy (bool) – default value is Standard_False Canonize (bool) – default value is Standard_True
  Return type: | None

  `FirstShape`()
    - Returns the TopoDS Shape of the bottom of the prism.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `LastShape`()
    - Returns the TopoDS Shape of the top of the prism.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `Shape`()
    - Returns the TopoDS Shape attached to the prism.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `Vec`()
    - Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.

    Return type: | gp_Vec

  `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.

  Parameters: | S (TopoDS_Shape &) – A (gp_Ax1) – D (Quantity_PlaneAngle) – C (bool) – default value is Standard_False
  Return type: | None

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

  Parameters: | S (TopoDS_Shape &) – A (gp_Ax1) – C (bool) – default value is Standard_False
  Return type: | None

  `Angle`()
    - returns the angle.

    Return type: | Quantity_PlaneAngle

  `Axe`()
    - returns the axis

    Return type: | gp_Ax1

  `FirstShape`()
    - Returns the first shape of the revol (coinciding with the generating shape).

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `LastShape`()
    - Returns the TopoDS Shape of the top of the prism.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `Shape`()
    - Returns the TopoDS Shape attached to the Revol.

    Return type: | TopoDS_Shape

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

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | TopoDS_Shape

  `thisown`

    The membership flag

class `BRepSweep_Rotation`(*args)

  Bases: `OCC.BRepSweep.BRepSweep_Trsf`

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

  Parameters: | S (TopoDS_Shape &) – N (Sweep_NumShape &) – L (TopLoc_Location &) – A (gp_Ax1) – D (Quantity_PlaneAngle) – C (bool) –
  Return type: | None

  `Angle`()
    - returns the angle.

    Return type: | Quantity_PlaneAngle

  `Axe`()
    - returns the axis

    Return type: | gp_Ax1

  `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.

  Parameters: | aShape (TopoDS_Shape &) –
  Return type: | None

  `Index`()
    - Returns the index of <aShape>.

    Parameters: | aShape (TopoDS_Shape &) –
    Return type: | int

  `NbShapes`()
    - Returns the number of subshapes in the shape.

    Return type: | int

  `Orientation`()
    - Returns the Orientation of <aShape>.

    Parameters: | aShape (TopoDS_Shape &) –
    Return type: | TopAbs_Orientation

  `SetOrientation`()
    - Set the Orientation of <aShape> with Or.

    Parameters: | aShape (TopoDS_Shape &) – Or (TopAbs_Orientation) –
    Return type: | None

  `Shape`()
    - Returns the Shape at Index anIdex.

    Parameters: | anIndex (int) –
    Return type: | TopoDS_Shape

  `Type`()
    - Returns the type of <aShape>.

    Parameters: | aShape (TopoDS_Shape &) –
    Return type: | TopAbs_ShapeEnum

  `thisown`

    The membership flag

class `BRepSweep_Translation`(*args)

  Bases: `OCC.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

  Parameters: | S (TopoDS_Shape &) – N (Sweep_NumShape &) – L (TopLoc_Location &) – V (gp_Vec) – C (bool) – Canonize (bool) – default value is Standard_True
  Return type: | None

  `Vec`()
    - Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.

    Return type: | gp_Vec

  `thisown`

    The membership flag

class `BRepSweep_Trsf`(*args, **kwargs)

  Bases: `OCC.BRepSweep.BRepSweep_NumLinearRegularSweep`

  `Init`()
    - ends the construction of the swept primitive calling the virtual geometric functions that can’t be called in the initialize.

    Return type: | None

  `IsInvariant`()
    - Returns true if the geometry of aGenS is not modified by the trsf of the BRepSweep Trsf.

    Parameters: | aGenS (TopoDS_Shape &) –
    Return type: | bool

  `Process`()
    - function called to analize the way of construction of the shapes generated by aGenS and aDirV.

    Parameters: | aGenS (TopoDS_Shape &) – aDirV (Sweep_NumShape &) –
    Return type: | bool

  `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