BRepSweep — OpenCascade.js

OCCT package BRepSweep: BRepSweep_Builder, BRepSweep_Iterator, BRepSweep_NumLinearRegularSweep, BRepSweep_Prism, and 5 more bound classes.

BRepSweep_Builder

implements the abstract Builder with the BRep Builder

Constructors(1)

constructor(aBuilder: BRep_Builder): BRepSweep_Builder
Creates a Builder.
Parameters (1)
- aBuilder

Instance methods(8)

Builder(): BRep_Builder
MakeCompound(aCompound: TopoDS_Shape): void
Returns an empty Compound.
Parameters (1)
- aCompound —
  Mutated in place; read the updated value from this argument after the call.
MakeCompSolid(aCompSolid: TopoDS_Shape): void
Returns an empty CompSolid.
Parameters (1)
- aCompSolid —
  Mutated in place; read the updated value from this argument after the call.
MakeSolid(aSolid: TopoDS_Shape): void
Returns an empty Solid.
Parameters (1)
- aSolid —
  Mutated in place; read the updated value from this argument after the call.
MakeShell(aShell: TopoDS_Shape): void
Returns an empty Shell.
Parameters (1)
- aShell —
  Mutated in place; read the updated value from this argument after the call.
MakeWire(aWire: TopoDS_Shape): void
Returns an empty Wire.
Parameters (1)
- aWire —
  Mutated in place; read the updated value from this argument after the call.
Add(aShape1: TopoDS_Shape, aShape2: TopoDS_Shape, Orient: TopAbs_Orientation): void
Adds the Shape 1 in the Shape 2, set to <Orient> orientation.
Parameters (3)
- aShape1 —
  Mutated in place; read the updated value from this argument after the call.
- aShape2
- Orient
Add(aShape1: TopoDS_Shape, aShape2: TopoDS_Shape): void
Adds the Shape 1 in the Shape 2.
Parameters (2)
- aShape1 —
  Mutated in place; read the updated value from this argument after the call.
- aShape2

BRepSweep_Iterator

This class provides iteration services required by the Generating Line (TopoDS Shape) of a BRepSweep. This tool is used to iterate on the direct sub-shapes of a Shape.

Constructors(1)

constructor(): BRepSweep_Iterator

Instance methods(5)

Init(aShape: TopoDS_Shape): void
Reset the Iterator on sub-shapes of <aShape>.
Parameters (1)
- aShape
More(): boolean
Returns True if there is a current sub-shape.
Next(): void
Moves to the next sub-shape.
Value(): TopoDS_Shape
Returns the current sub-shape.
Orientation(): TopAbs_Orientation
Returns the orientation of the current sub-shape.

BRepSweep_NumLinearRegularSweep

This a generic class is used to build Sweept primitives with a generating "shape" and a directing "line".
The indexation and type analysis services required for the generatrix are given by <Tool from BRepSweep>.
The indexation and type analysis services required for the directrix are given by <NumShapeTool from Sweep>.
The iteration services required for the generatrix are given by <Iterator from BRepSweep>.
The iteration services required for the directrix are given by <NumShapeIterator from Sweep>.
The topology is like a grid of shapes. Each shape of the grid must be addressable without confusion by one or two objects from the generating or directing shapes. Here are examples of correct associations to address:

a vertex : GenVertex - DirVertex
an edge : GenVertex - DirEdge
: GenEdge - DirVertex
a face : GenEdge - DirEdge GenFace - DirVertex ...
"GenObject" is used to identify an object from the Generating Shape, and "DirObject" from the Directing Shape. So may they be from different types.
The method Has... is given because in some special cases, a vertex, an edge or a face may be geometricaly nonexistent or not useful.

Instance methods(28)

MakeEmptyVertex(aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirV
MakeEmptyDirectingEdge(aGenV: TopoDS_Shape, aDirE: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirE
MakeEmptyGeneratingEdge(aGenE: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenE
- aDirV
SetParameters(aNewFace: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenF: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewFace
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenV
- aDirV
SetDirectingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenV
- aDirE
- aDirV
SetGeneratingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirV
MakeEmptyFace(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopoDS_Shape
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 (2)
- aGenS
- aDirS
SetPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenF: TopoDS_Shape, aGenE: TopoDS_Shape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenE
- aDirV
- orien
SetGeneratingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aDirE
- aDirV
- orien
SetDirectingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirE
- orien
DirectSolid(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopAbs_Orientation
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 (2)
- aGenS
- aDirS
GGDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aSubGenS and aDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
GDDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aDirS: Sweep_NumShape, aSubDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aGenS and aSubDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aDirS
- aSubDirS
SeparatedWires(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
In some particular cases the topology of a generated face must be composed of independent closed wires, in this case this function returns true.
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
SplitShell(aNewShape: TopoDS_Shape): TopoDS_Shape
In some particular cases the topology of a generated Shell must be composed of independent closed Shells, in this case this function returns a Compound of independent Shells.
Parameters (1)
- aNewShape
SetContinuity(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): void
Called to propagate the continuity of every vertex between two edges of the generating wire aGenS on the generated edge and faces.
Parameters (2)
- aGenS
- aDirS
HasShape(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
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 (2)
- aGenS
- aDirS
IsInvariant(aGenS: TopoDS_Shape): boolean
Returns true if aGenS cannot be transformed.
Parameters (1)
- aGenS
Shape(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopoDS_Shape
Returns the resulting Shape indexed by aDirS and aGenS.
Parameters (2)
- aGenS
- aDirS
Shape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the resulting Shape indexed by myDirWire and aGenS.
Parameters (1)
- aGenS
Shape(): TopoDS_Shape
Returns the resulting Shape indexed by myDirWire and myGenShape.
IsUsed(aGenS: TopoDS_Shape): boolean
Returns true if the initial shape aGenS is used in result shape.
Parameters (1)
- aGenS
GenIsUsed(theS: TopoDS_Shape): boolean
Returns true if the shape, generated from theS is used in result shape.
Parameters (1)
- theS
FirstShape(): TopoDS_Shape
Returns the resulting Shape indexed by the first Vertex of myDirWire and myGenShape.
FirstShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the resulting Shape indexed by the first Vertex of myDirWire and aGenS.
Parameters (1)
- aGenS
LastShape(): TopoDS_Shape
Returns the resulting Shape indexed by the last Vertex of myDirWire and myGenShape.
LastShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the resulting Shape indexed by the last Vertex of myDirWire and aGenS.
Parameters (1)
- aGenS
Closed(): boolean

BRepSweep_Prism

Provides natural constructors to build BRepSweep translated swept Primitives.

Constructors(2)

constructor(S: TopoDS_Shape, V: gp_Vec, Copy?: boolean, Canonize?: boolean): BRepSweep_Prism
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 (4)
- S
- V
- Copy
- Canonize
constructor(S: TopoDS_Shape, D: gp_Dir, Inf?: boolean, Copy?: boolean, Canonize?: boolean): BRepSweep_Prism
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 (5)
- S
- D
- Inf
- Copy
- Canonize

Instance methods(9)

Shape(): TopoDS_Shape
Returns the TopoDS Shape attached to the prism.
Shape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the TopoDS Shape generated with aGenS (subShape of the generating shape).
Parameters (1)
- aGenS
FirstShape(): TopoDS_Shape
Returns the TopoDS Shape of the bottom of the prism.
FirstShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the TopoDS Shape of the bottom of the prism. generated with aGenS (subShape of the generating shape).
Parameters (1)
- aGenS
LastShape(): TopoDS_Shape
Returns the TopoDS Shape of the top of the prism.
LastShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the TopoDS Shape of the top of the prism. generated with aGenS (subShape of the generating shape).
Parameters (1)
- aGenS
Vec(): gp_Vec
Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.
IsUsed(aGenS: TopoDS_Shape): boolean
Returns true if the aGenS is used in resulting shape.
Parameters (1)
- aGenS
GenIsUsed(theS: TopoDS_Shape): boolean
Returns true if the shape, generated from theS is used in result shape.
Parameters (1)
- theS

BRepSweep_Revol

Provides natural constructors to build BRepSweep rotated swept Primitives.

Constructors(2)

constructor(S: TopoDS_Shape, A: gp_Ax1, C?: boolean): BRepSweep_Revol
Builds the Revol of meridian S axis A and angle 2*Pi. If C is true S is copied.
Parameters (3)
- S
- A
- C
constructor(S: TopoDS_Shape, A: gp_Ax1, D: number, C?: boolean): BRepSweep_Revol
Builds the Revol of meridian S axis A and angle D. If C is true S is copied.
Parameters (4)
- S
- A
- D
- C

Instance methods(9)

Shape(): TopoDS_Shape
Returns the TopoDS Shape attached to the Revol.
Shape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the TopoDS Shape generated with aGenS (subShape of the generating shape).
Parameters (1)
- aGenS
FirstShape(): TopoDS_Shape
Returns the first shape of the revol (coinciding with the generating shape).
FirstShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the first shape of the revol (coinciding with the generating shape).
Parameters (1)
- aGenS
LastShape(): TopoDS_Shape
Returns the TopoDS Shape of the top of the prism.
LastShape(aGenS: TopoDS_Shape): TopoDS_Shape
Returns the TopoDS Shape of the top of the prism. generated with aGenS (subShape of the generating shape).
Parameters (1)
- aGenS
Axe(): gp_Ax1
returns the axis
Angle(): number
returns the angle.
IsUsed(aGenS: TopoDS_Shape): boolean
Returns true if the aGenS is used in resulting Shape.
Parameters (1)
- aGenS

BRepSweep_Rotation

BRepSweep_TrsfBRepSweep_NumLinearRegularSweep

Provides an algorithm to build object by Rotation sweep.

Constructors(1)

constructor(S: TopoDS_Shape, N: Sweep_NumShape, L: TopLoc_Location, A: gp_Ax1, D: number, C: boolean): BRepSweep_Rotation
Creates a topology by rotating around A with the angle D.
Parameters (6)
- S
- N
- L
- A
- D
- C

Instance methods(19)

MakeEmptyVertex(aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirV
MakeEmptyDirectingEdge(aGenV: TopoDS_Shape, aDirE: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirE
MakeEmptyGeneratingEdge(aGenE: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenE
- aDirV
SetParameters(aNewFace: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenF: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewFace
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenV
- aDirV
SetDirectingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenV
- aDirE
- aDirV
SetGeneratingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirV
MakeEmptyFace(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopoDS_Shape
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 (2)
- aGenS
- aDirS
SetPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenF: TopoDS_Shape, aGenE: TopoDS_Shape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenE
- aDirV
- orien
SetGeneratingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aDirE
- aDirV
- orien
SetDirectingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirE
- orien
DirectSolid(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopAbs_Orientation
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 (2)
- aGenS
- aDirS
GGDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aSubGenS and aDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
GDDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aDirS: Sweep_NumShape, aSubDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aGenS and aSubDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aDirS
- aSubDirS
SeparatedWires(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
In some particular cases the topology of a generated face must be composed of independent closed wires, in this case this function returns true. The only case in which the function may return true is a planar face in a closed revol.
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
SplitShell(aNewShape: TopoDS_Shape): TopoDS_Shape
In some particular cases the topology of a generated Shell must be composed of independent closed Shells, in this case this function returns a Compound of independent Shells.
Parameters (1)
- aNewShape
HasShape(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
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 (2)
- aGenS
- aDirS
IsInvariant(aGenS: TopoDS_Shape): boolean
Returns true when the geometry of aGenS is not modified by the rotation.
Parameters (1)
- aGenS
Axe(): gp_Ax1
returns the axis
Angle(): number
returns the angle.

BRepSweep_Tool

Provides the indexation and type analysis services required by the TopoDS generating Shape of BRepSweep.

Constructors(1)

constructor(aShape: TopoDS_Shape): BRepSweep_Tool
Initialize the tool with <aShape>. The IndexTool must prepare an indexation for all the subshapes of this shape.
Parameters (1)
- aShape

Instance methods(6)

NbShapes(): number
Returns the number of subshapes in the shape.
Index(aShape: TopoDS_Shape): number
Returns the index of <aShape>.
Parameters (1)
- aShape
Shape(anIndex: number): TopoDS_Shape
Returns the Shape at Index anIdex.
Parameters (1)
- anIndex
Type(aShape: TopoDS_Shape): TopAbs_ShapeEnum
Returns the type of <aShape>.
Parameters (1)
- aShape
Orientation(aShape: TopoDS_Shape): TopAbs_Orientation
Returns the Orientation of <aShape>.
Parameters (1)
- aShape
SetOrientation(aShape: TopoDS_Shape, Or: TopAbs_Orientation): void
Set the Orientation of <aShape> with Or.
Parameters (2)
- aShape —
  Mutated in place; read the updated value from this argument after the call.
- Or

BRepSweep_Translation

BRepSweep_TrsfBRepSweep_NumLinearRegularSweep

Provides an algorithm to build object by translation sweep.

Constructors(1)

constructor(S: TopoDS_Shape, N: Sweep_NumShape, L: TopLoc_Location, V: gp_Vec, C: boolean, Canonize?: boolean): BRepSweep_Translation
Creates a topology by translating 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 (6)
- S
- N
- L
- V
- C
- Canonize

Instance methods(17)

MakeEmptyVertex(aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirV
MakeEmptyDirectingEdge(aGenV: TopoDS_Shape, aDirE: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirE
MakeEmptyGeneratingEdge(aGenE: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenE
- aDirV
SetParameters(aNewFace: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenF: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewFace
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenV
- aDirV
SetDirectingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenV
- aDirE
- aDirV
SetGeneratingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirV
MakeEmptyFace(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopoDS_Shape
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 (2)
- aGenS
- aDirS
SetPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenF: TopoDS_Shape, aGenE: TopoDS_Shape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenE
- aDirV
- orien
SetGeneratingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aDirE
- aDirV
- orien
SetDirectingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirE
- orien
DirectSolid(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopAbs_Orientation
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 (2)
- aGenS
- aDirS
GGDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aSubGenS and aDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
GDDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aDirS: Sweep_NumShape, aSubDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aGenS and aSubDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aDirS
- aSubDirS
SeparatedWires(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
In some particular cases the topology of a generated face must be composed of independent closed wires, in this case this function returns true. Here it always returns false.
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
HasShape(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
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 (2)
- aGenS
- aDirS
IsInvariant(aGenS: TopoDS_Shape): boolean
Returns always false because here the transformation is a translation.
Parameters (1)
- aGenS
Vec(): gp_Vec
Returns the Vector of the Prism, if it is an infinite prism the Vec is unitar.

BRepSweep_Trsf

BRepSweep_NumLinearRegularSweep

This class is inherited from NumLinearRegularSweep to implement the simple swept primitives built moving a Shape with a Trsf. It often is possible to build the constructed subshapes by a simple move of the generating subshapes (shared topology and geometry). So two ways of construction are proposed:

sharing basis elements (the generatrice can be modified, for example PCurves can be added on faces);
copying everything.

Instance methods(18)

Init(): void
ends the construction of the swept primitive calling the virtual geometric functions that can't be called in the initialize.
Process(aGenS: TopoDS_Shape, aDirV: Sweep_NumShape): boolean
function called to analyze the way of construction of the shapes generated by aGenS and aDirV.
Parameters (2)
- aGenS
- aDirV
MakeEmptyVertex(aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the vertex addressed by [aGenV,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirV
MakeEmptyDirectingEdge(aGenV: TopoDS_Shape, aDirE: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenV,aDirE], with its geometric part, but without subcomponents.
Parameters (2)
- aGenV
- aDirE
MakeEmptyGeneratingEdge(aGenE: TopoDS_Shape, aDirV: Sweep_NumShape): TopoDS_Shape
Builds the edge addressed by [aGenE,aDirV], with its geometric part, but without subcomponents.
Parameters (2)
- aGenE
- aDirV
SetParameters(aNewFace: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenF: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewFace
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenV
- aDirV
SetDirectingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenV
- aDirE
- aDirV
SetGeneratingParameter(aNewEdge: TopoDS_Shape, aNewVertex: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirV: Sweep_NumShape): void
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 (5)
- aNewEdge
- aNewVertex —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirV
MakeEmptyFace(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): TopoDS_Shape
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 (2)
- aGenS
- aDirS
SetPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenF: TopoDS_Shape, aGenE: TopoDS_Shape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenF
- aGenE
- aDirV
- orien
SetGeneratingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aDirE: Sweep_NumShape, aDirV: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aDirE
- aDirV
- orien
SetDirectingPCurve(aNewFace: TopoDS_Shape, aNewEdge: TopoDS_Shape, aGenE: TopoDS_Shape, aGenV: TopoDS_Shape, aDirE: Sweep_NumShape, orien: TopAbs_Orientation): void
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 (6)
- aNewFace
- aNewEdge —
  Mutated in place; read the updated value from this argument after the call.
- aGenE
- aGenV
- aDirE
- orien
GGDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aSubGenS and aDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
GDDShapeIsToAdd(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aDirS: Sweep_NumShape, aSubDirS: Sweep_NumShape): boolean
Returns true if aNewSubShape (addressed by aGenS and aSubDirS) must be added in aNewShape (addressed by aGenS and aDirS).
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aDirS
- aSubDirS
SeparatedWires(aNewShape: TopoDS_Shape, aNewSubShape: TopoDS_Shape, aGenS: TopoDS_Shape, aSubGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
In some particular cases the topology of a generated face must be composed of independent closed wires, in this case this function returns true.
Parameters (5)
- aNewShape
- aNewSubShape
- aGenS
- aSubGenS
- aDirS
HasShape(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): boolean
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 (2)
- aGenS
- aDirS
IsInvariant(aGenS: TopoDS_Shape): boolean
Returns true if the geometry of aGenS is not modified by the trsf of the BRepSweep Trsf.
Parameters (1)
- aGenS
SetContinuity(aGenS: TopoDS_Shape, aDirS: Sweep_NumShape): void
Called to propagate the continuity of every vertex between two edges of the generating wire aGenS on the generated edge and faces.
Parameters (2)
- aGenS
- aDirS