LocOpe

OCCT package LocOpe: LocOpe, LocOpe_BuildShape, LocOpe_BuildWires, LocOpe_DPrism, and 15 more bound classes.

Provides tools to implement local topological operations on a shape.

Constructors(1)

constructor(): LocOpe

Static methods(4)

Closed(W: TopoDS_Wire, OnF: TopoDS_Face): boolean
Returns true when the wire <W> is closed on the face <OnF>.
Parameters (2)
- W
- OnF
Closed(E: TopoDS_Edge, OnF: TopoDS_Face): boolean
Returns true when the edge <E> is closed on the face <OnF>.
Parameters (2)
- E
- OnF
TgtFaces(E: TopoDS_Edge, F1: TopoDS_Face, F2: TopoDS_Face): boolean
Returns true when the faces are tangent.
Parameters (3)
- E
- F1
- F2
SampleEdges(S: TopoDS_Shape, Pt: NCollection_Sequence_gp_Pnt): void
Parameters (2)
- S
- Pt

LocOpe_BuildShape

Constructors(2)

constructor(): LocOpe_BuildShape
constructor(L: NCollection_List_TopoDS_Shape): LocOpe_BuildShape
Builds shape(s) from the list <L>. Uses only the faces of <L>.
Parameters (1)
- L

Instance methods(2)

Perform(L: NCollection_List_TopoDS_Shape): void
Builds shape(s) from the list <L>. Uses only the faces of <L>.
Parameters (1)
- L
Shape(): TopoDS_Shape

LocOpe_BuildWires

Constructors(2)

constructor(): LocOpe_BuildWires
constructor(Ledges: NCollection_List_TopoDS_Shape, PW: LocOpe_WiresOnShape): LocOpe_BuildWires
Parameters (2)
- Ledges
- PW

Instance methods(3)

Perform(Ledges: NCollection_List_TopoDS_Shape, PW: LocOpe_WiresOnShape): void
Parameters (2)
- Ledges
- PW
IsDone(): boolean
Result(): NCollection_List_TopoDS_Shape

LocOpe_DPrism

Defines a pipe (near from Pipe from BRepFill), with modifications provided for the Pipe feature.

Constructors(2)

constructor(Spine: TopoDS_Face, Height: number, Angle: number): LocOpe_DPrism
Parameters (3)
- Spine
- Height
- Angle
constructor(Spine: TopoDS_Face, Height1: number, Height2: number, Angle: number): LocOpe_DPrism
Parameters (4)
- Spine
- Height1
- Height2
- Angle

Instance methods(9)

IsDone(): boolean
Spine(): TopoDS_Shape
Profile(): TopoDS_Shape
FirstShape(): TopoDS_Shape
LastShape(): TopoDS_Shape
Shape(): TopoDS_Shape
Shapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Parameters (1)
- S
Curves(SCurves: NCollection_Sequence_handle_Geom_Curve): void
Parameters (1)
- SCurves
BarycCurve(): Geom_Curve

LocOpe_FindEdges

Constructors(2)

constructor(): LocOpe_FindEdges
constructor(FFrom: TopoDS_Shape, FTo: TopoDS_Shape): LocOpe_FindEdges
Parameters (2)
- FFrom
- FTo

Instance methods(6)

Set(FFrom: TopoDS_Shape, FTo: TopoDS_Shape): void
Parameters (2)
- FFrom
- FTo
InitIterator(): void
More(): boolean
EdgeFrom(): TopoDS_Edge
EdgeTo(): TopoDS_Edge
Next(): void

LocOpe_FindEdgesInFace

Constructors(2)

constructor(): LocOpe_FindEdgesInFace
constructor(S: TopoDS_Shape, F: TopoDS_Face): LocOpe_FindEdgesInFace
Parameters (2)
- S
- F

Instance methods(5)

Set(S: TopoDS_Shape, F: TopoDS_Face): void
Parameters (2)
- S
- F
Init(): void
More(): boolean
Edge(): TopoDS_Edge
Next(): void

LocOpe_GeneratedShape

Standard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(5)

GeneratingEdges(): NCollection_List_TopoDS_Shape
Generated(V: TopoDS_Vertex): TopoDS_Edge
Returns the edge created by the vertex <V>. If none, must return a null shape.
Parameters (1)
- V
Generated(E: TopoDS_Edge): TopoDS_Face
Returns the face created by the edge <E>. If none, must return a null shape.
Parameters (1)
- E
OrientedFaces(): NCollection_List_TopoDS_Shape
Returns the list of correctly oriented generated faces.
DynamicType(): Standard_Type

LocOpe_Generator

Constructors(2)

constructor(): LocOpe_Generator
Empty constructor.
constructor(S: TopoDS_Shape): LocOpe_Generator
Creates the algorithm on the shape .
Parameters (1)
- S

Instance methods(6)

Init(S: TopoDS_Shape): void
Initializes the algorithm on the shape .
Parameters (1)
- S
Perform(G: LocOpe_GeneratedShape): void
Parameters (1)
- G
IsDone(): boolean
ResultingShape(): TopoDS_Shape
Returns the new shape.
Shape(): TopoDS_Shape
Returns the initial shape.
DescendantFace(F: TopoDS_Face): NCollection_List_TopoDS_Shape
Returns the descendant face of <F>. <F> may belong to the original shape or to the "generated" shape. The returned face may be a null shape (when <F> disappears).
Parameters (1)
- F

Instance methods(7)

Init(S: TopoDS_Shape): void
Parameters (1)
- S
GlueOnFace(F: TopoDS_Face): void
Parameters (1)
- F
GeneratingEdges(): NCollection_List_TopoDS_Shape
Generated(V: TopoDS_Vertex): TopoDS_Edge
Returns the edge created by the vertex <V>. If none, must return a null shape.
Parameters (1)
- V
Generated(E: TopoDS_Edge): TopoDS_Face
Returns the face created by the edge <E>. If none, must return a null shape.
Parameters (1)
- E
OrientedFaces(): NCollection_List_TopoDS_Shape
Returns the list of correctly oriented generated faces.
DynamicType(): Standard_Type

LocOpe_Gluer

Constructors(2)

constructor(): LocOpe_Gluer
constructor(Sbase: TopoDS_Shape, Snew: TopoDS_Shape): LocOpe_Gluer
Parameters (2)
- Sbase
- Snew

Instance methods(12)

Init(Sbase: TopoDS_Shape, Snew: TopoDS_Shape): void
Parameters (2)
- Sbase
- Snew
Bind(Fnew: TopoDS_Face, Fbase: TopoDS_Face): void
Parameters (2)
- Fnew
- Fbase
Bind(Enew: TopoDS_Edge, Ebase: TopoDS_Edge): void
Parameters (2)
- Enew
- Ebase
OpeType(): LocOpe_Operation
Perform(): void
IsDone(): boolean
ResultingShape(): TopoDS_Shape
DescendantFaces(F: TopoDS_Face): NCollection_List_TopoDS_Shape
Parameters (1)
- F
BasisShape(): TopoDS_Shape
GluedShape(): TopoDS_Shape
Edges(): NCollection_List_TopoDS_Shape
TgtEdges(): NCollection_List_TopoDS_Shape

LocOpe_LinearForm

Defines a linear form (using Prism from BRepSweep) with modifications provided for the LinearForm feature.

Constructors(3)

constructor(): LocOpe_LinearForm
constructor(Base: TopoDS_Shape, V: gp_Vec, Pnt1: gp_Pnt, Pnt2: gp_Pnt): LocOpe_LinearForm
Parameters (4)
- Base
- V
- Pnt1
- Pnt2
constructor(Base: TopoDS_Shape, V: gp_Vec, Vectra: gp_Vec, Pnt1: gp_Pnt, Pnt2: gp_Pnt): LocOpe_LinearForm
Parameters (5)
- Base
- V
- Vectra
- Pnt1
- Pnt2

Instance methods(6)

Perform(Base: TopoDS_Shape, V: gp_Vec, Pnt1: gp_Pnt, Pnt2: gp_Pnt): void
Parameters (4)
- Base
- V
- Pnt1
- Pnt2
Perform(Base: TopoDS_Shape, V: gp_Vec, Vectra: gp_Vec, Pnt1: gp_Pnt, Pnt2: gp_Pnt): void
Parameters (5)
- Base
- V
- Vectra
- Pnt1
- Pnt2
FirstShape(): TopoDS_Shape
LastShape(): TopoDS_Shape
Shape(): TopoDS_Shape
Shapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Parameters (1)
- S

LocOpe_Operation

Properties(3)

LocOpe_FUSE:'LocOpe_FUSE'readonly
LocOpe_CUT:'LocOpe_CUT'readonly
LocOpe_INVALID:'LocOpe_INVALID'readonly

LocOpe_Pipe

Defines a pipe (near from Pipe from BRepFill), with modifications provided for the Pipe feature.

Constructors(1)

constructor(Spine: TopoDS_Wire, Profile: TopoDS_Shape): LocOpe_Pipe
Parameters (2)
- Spine
- Profile

Instance methods(8)

Spine(): TopoDS_Shape
Profile(): TopoDS_Shape
FirstShape(): TopoDS_Shape
LastShape(): TopoDS_Shape
Shape(): TopoDS_Shape
Shapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Parameters (1)
- S
Curves(Spt: NCollection_Sequence_gp_Pnt): NCollection_Sequence_handle_Geom_Curve
Parameters (1)
- Spt
BarycCurve(): Geom_Curve

LocOpe_PntFace

Constructors(2)

constructor(): LocOpe_PntFace
Empty constructor. Useful only for the list.
constructor(P: gp_Pnt, F: TopoDS_Face, Or: TopAbs_Orientation, Param: number, UPar: number, VPar: number): LocOpe_PntFace
Parameters (6)
- P
- F
- Or
- Param
- UPar
- VPar

Instance methods(7)

LocOpe_Prism

Defines a prism (using Prism from BRepSweep) with modifications provided for the Prism feature.

Constructors(3)

constructor(): LocOpe_Prism
constructor(Base: TopoDS_Shape, V: gp_Vec): LocOpe_Prism
Parameters (2)
- Base
- V
constructor(Base: TopoDS_Shape, V: gp_Vec, Vectra: gp_Vec): LocOpe_Prism
Parameters (3)
- Base
- V
- Vectra

Instance methods(8)

Perform(Base: TopoDS_Shape, V: gp_Vec): void
Parameters (2)
- Base
- V
Perform(Base: TopoDS_Shape, V: gp_Vec, Vtra: gp_Vec): void
Parameters (3)
- Base
- V
- Vtra
FirstShape(): TopoDS_Shape
LastShape(): TopoDS_Shape
Shape(): TopoDS_Shape
Shapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Parameters (1)
- S
Curves(SCurves: NCollection_Sequence_handle_Geom_Curve): void
Parameters (1)
- SCurves
BarycCurve(): Geom_Curve

LocOpe_SplitDrafts

This class provides a tool to realize the following operations on a shape:

split a face of the shape with a wire,
put draft angle on both side of the wire. For each side, the draft angle may be different.

Constructors(2)

constructor(): LocOpe_SplitDrafts
Empty constructor.
constructor(S: TopoDS_Shape): LocOpe_SplitDrafts
Creates the algorithm on the shape .
Parameters (1)
- S

Instance methods(7)

Init(S: TopoDS_Shape): void
Initializes the algorithm with the shape .
Parameters (1)
- S
Perform(F: TopoDS_Face, W: TopoDS_Wire, Extractg: gp_Dir, NPlg: gp_Pln, Angleg: number, Extractd: gp_Dir, NPld: gp_Pln, Angled: number, ModifyLeft: boolean, ModifyRight: boolean): void
Splits the face <F> of the former given shape with the wire <W>. The wire is assumed to lie on the face.
Puts a draft angle on both parts of the wire. <Extractg>, <Nplg>, <Angleg> define the arguments for the left part of the wire. <Extractd>, <Npld>, <Angled> define the arguments for the right part of the wire.
The draft angle is measured with the direction <Extract>. <Npl> defines the neutral plane (points belonging to the neutral plane are not modified). <Angle> is the value of the draft angle. If <ModifyLeft> is set to <false>, no draft angle is applied to the left part of the wire. If <ModifyRight> is set to <false>,no draft angle is applied to the right part of the wire.
Parameters (10)
- F
- W
- Extractg
- NPlg
- Angleg
- Extractd
- NPld
- Angled
- ModifyLeft
- ModifyRight
Perform(F: TopoDS_Face, W: TopoDS_Wire, Extract: gp_Dir, NPl: gp_Pln, Angle: number): void
Splits the face <F> of the former given shape with the wire <W>. The wire is assumed to lie on the face. Puts a draft angle on the left part of the wire. The draft angle is measured with the direction <Extract>. <Npl> defines the neutral plane (points belonging to the neutral plane are not modified). <Angle> is the value of the draft angle.
Parameters (5)
- F
- W
- Extract
- NPl
- Angle
IsDone(): boolean
Returns <true> if the modification has been successfully performed.
OriginalShape(): TopoDS_Shape
Shape(): TopoDS_Shape
Returns the modified shape.
ShapesFromShape(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Manages the descendant shapes.
Parameters (1)
- S

LocOpe_Spliter

Constructors(2)

constructor(): LocOpe_Spliter
Empty constructor.
constructor(S: TopoDS_Shape): LocOpe_Spliter
Creates the algorithm on the shape .
Parameters (1)
- S

Instance methods(8)

Init(S: TopoDS_Shape): void
Initializes the algorithm on the shape .
Parameters (1)
- S
Perform(PW: LocOpe_WiresOnShape): void
Parameters (1)
- PW
IsDone(): boolean
ResultingShape(): TopoDS_Shape
Returns the new shape.
Shape(): TopoDS_Shape
Returns the initial shape.
DirectLeft(): NCollection_List_TopoDS_Shape
Returns the faces which are the left of the projected wires and which are.
Left(): NCollection_List_TopoDS_Shape
Returns the faces of the "left" part on the shape. (It is build from DirectLeft, with the faces connected to this set, and so on...).
DescendantShapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Returns the list of descendant shapes of .
Parameters (1)
- S

LocOpe_SplitShape

Provides a tool to cut:

edges with a vertices,
faces with wires, and rebuilds the shape containing the edges and the faces.

Constructors(2)

constructor(): LocOpe_SplitShape
Empty constructor.
constructor(S: TopoDS_Shape): LocOpe_SplitShape
Creates the process with the shape .
Parameters (1)
- S

Instance methods(8)

Init(S: TopoDS_Shape): void
Initializes the process on the shape .
Parameters (1)
- S
CanSplit(E: TopoDS_Edge): boolean
Tests if it is possible to split the edge <E>.
Parameters (1)
- E
Add(W: TopoDS_Wire, F: TopoDS_Face): boolean
Adds the wire <W> on the face <F>.
Parameters (2)
- W
- F
Add(Lwires: NCollection_List_TopoDS_Shape, F: TopoDS_Face): boolean
Adds the list of wires <Lwires> on the face <F>.
Parameters (2)
- Lwires
- F
Add(V: TopoDS_Vertex, P: number, E: TopoDS_Edge): void
Adds the vertex <V> on the edge <E>, at parameter.
.
Parameters (3)
- V
- P
- E
Shape(): TopoDS_Shape
Returns the "original" shape.
DescendantShapes(S: TopoDS_Shape): NCollection_List_TopoDS_Shape
Returns the list of descendant shapes of .
Parameters (1)
- S
LeftOf(W: TopoDS_Wire, F: TopoDS_Face): NCollection_List_TopoDS_Shape
Returns the "left" part defined by the wire <W> on the face <F>. The returned list of shape is in fact a list of faces. The face <F> is considered with its topological orientation in the original shape. <W> is considered with its orientation.
Parameters (2)
- W
- F

LocOpe_WiresOnShape

Standard_Transient

Constructors(1)

constructor(S: TopoDS_Shape): LocOpe_WiresOnShape
Parameters (1)
- S

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(20)

Init(S: TopoDS_Shape): void
Parameters (1)
- S
Add(theEdges: NCollection_Sequence_TopoDS_Shape): boolean
Add splitting edges or wires for whole initial shape without additional specification edge->face, edge->edge This method puts edge on the corresponding faces from initial shape.
Parameters (1)
- theEdges
SetCheckInterior(ToCheckInterior: boolean): void
Set the flag of check internal intersections default value is True (to check).
Parameters (1)
- ToCheckInterior
Bind(W: TopoDS_Wire, F: TopoDS_Face): void
Parameters (2)
- W
- F
Bind(Comp: TopoDS_Compound, F: TopoDS_Face): void
Parameters (2)
- Comp
- F
Bind(E: TopoDS_Edge, F: TopoDS_Face): void
Parameters (2)
- E
- F
Bind(EfromW: TopoDS_Edge, EonFace: TopoDS_Edge): void
Parameters (2)
- EfromW
- EonFace
BindAll(): void
IsDone(): boolean
InitEdgeIterator(): void
MoreEdge(): boolean
Edge(): TopoDS_Edge
OnFace(): TopoDS_Face
Returns the face of the shape on which the current edge is projected.
OnEdge(E: TopoDS_Edge): boolean
If the current edge is projected on an edge, returns <true> and sets the value of <E>. Otherwise, returns <false>.
Parameters (1)
- E —
  Mutated in place; read the updated value from this argument after the call.
OnEdge(V: TopoDS_Vertex, E: TopoDS_Edge, P: number): { returnValue: boolean; P: number }
If the vertex <V> lies on an edge of the original shape, returns <true> and sets the concerned edge in <E>, and the parameter on the edge in.
. Else returns <false>.
Parameters (3)
- V
- E —
  Mutated in place; read the updated value from this argument after the call.
- P
Returns
A result object with fields:
- returnValue: the C++ return value
- P: updated value from the call.
OnEdge(V: TopoDS_Vertex, EdgeFrom: TopoDS_Edge, E: TopoDS_Edge, P: number): { returnValue: boolean; P: number }
If the vertex <V> lies on an edge of the original shape, returns <true> and sets the concerned edge in <E>, and the parameter on the edge in.
. Else returns <false>.
Parameters (4)
- V
- EdgeFrom
- E —
  Mutated in place; read the updated value from this argument after the call.
- P
Returns
A result object with fields:
- returnValue: the C++ return value
- P: updated value from the call.
NextEdge(): void
OnVertex(Vwire: TopoDS_Vertex, Vshape: TopoDS_Vertex): boolean
Parameters (2)
- Vwire
- Vshape
IsFaceWithSection(aFace: TopoDS_Shape): boolean
tells is the face to be split by section or not
Parameters (1)
- aFace
DynamicType(): Standard_Type