BRepClass — OpenCascade.js

OCCT package BRepClass: BRepClass_Edge, BRepClass_FaceClassifier, BRepClass_FacePassiveClassifier, BRepClass_FClass2dOfFClassifier, and 2 more bound classes.

BRepClass_Edge

This class is used to send the description of an Edge to the classifier. It contains an Edge and a Face. So the PCurve of the Edge can be found.

Constructors(2)

constructor(): BRepClass_Edge
constructor(E: TopoDS_Edge, F: TopoDS_Face): BRepClass_Edge
Parameters (2)
- E
- F

Instance methods(8)

Edge(): TopoDS_Edge
Returns the current Edge.
Face(): TopoDS_Face
Returns the Face for the current Edge.
NextEdge(): TopoDS_Edge
Returns the next Edge.
SetNextEdge(theMapVE: NCollection_IndexedDataMap_TopoDS_Shape_NCollection_List_TopoDS_Shape_TopTools_ShapeMapHasher): void
Finds and sets the next Edge for the current.
Parameters (1)
- theMapVE
MaxTolerance(): number
Returns the maximum tolerance.
SetMaxTolerance(theValue: number): void
Sets the maximum tolerance at which to start checking in the intersector.
Parameters (1)
- theValue
UseBndBox(): boolean
Returns true if we are using boxes in the intersector.
SetUseBndBox(theValue: boolean): void
Sets the status of whether we are using boxes or not.
Parameters (1)
- theValue

BRepClass_FaceClassifier

BRepClass_FClassifier

Provides Constructors with a Face.

Constructors(3)

constructor(): BRepClass_FaceClassifier
Empty constructor, undefined algorithm.
constructor(theF: TopoDS_Face, theP: gp_Pnt2d, theTol: number, theUseBndBox?: boolean, theGapCheckTol?: number): BRepClass_FaceClassifier
Creates an algorithm to classify the Point P with Tolerance <T> on the face <F>. Recommended to use Bnd_Box if the number of edges > 10 and the geometry is mostly spline.
Parameters (5)
- theF
- theP
- theTol
- theUseBndBox
- theGapCheckTol
constructor(theF: TopoDS_Face, theP: gp_Pnt, theTol: number, theUseBndBox?: boolean, theGapCheckTol?: number): BRepClass_FaceClassifier
Creates an algorithm to classify the Point P with Tolerance <T> on the face <F>. Recommended to use Bnd_Box if the number of edges > 10 and the geometry is mostly spline.
Parameters (5)
- theF
- theP
- theTol
- theUseBndBox
- theGapCheckTol

Instance methods(2)

Perform(theF: TopoDS_Face, theP: gp_Pnt, theTol: number, theUseBndBox: boolean, theGapCheckTol: number): void
Classify the Point P with Tolerance <T> on the face described by <F>. Recommended to use Bnd_Box if the number of edges > 10 and the geometry is mostly spline.
Parameters (5)
- theF
- theP
- theTol
- theUseBndBox
- theGapCheckTol
Perform(F: unknown, P: gp_Pnt2d, Tol: number): void
Classify the Point P with Tolerance <T> on the face described by <F>. Recommended to use Bnd_Box if the number of edges > 10 and the geometry is mostly spline.
Parameters (3)
- F
- P
- Tol

BRepClass_FacePassiveClassifier

Constructors(1)

constructor(): BRepClass_FacePassiveClassifier
Creates an undefined classifier.

Instance methods(7)

Reset(L: gp_Lin2d, P: number, Tol: number): void
Starts a classification process. The point to classify is the origin of the line <L>.
is the original length of the segment on <L> used to compute intersections. <Tol> is the tolerance attached to the line segment in intersections.
Parameters (3)
- L
- P
- Tol
Compare(E: BRepClass_Edge, Or: TopAbs_Orientation): void
Updates the classification process with the edge <E> from the boundary.
Parameters (2)
- E
- Or
Parameter(): number
Returns the current value of the parameter.
Intersector(): BRepClass_Intersector
Returns the intersecting algorithm.
ClosestIntersection(): number
Returns 0 if the last compared edge had no relevant intersection. Else returns the index of this intersection in the last intersection algorithm.
State(): TopAbs_State
Returns the current state of the point.
IsHeadOrEnd(): boolean
Returns the true if the closest intersection point represents head or end of the edge. Returns false otherwise.

BRepClass_FClass2dOfFClassifier

Constructors(1)

constructor(): BRepClass_FClass2dOfFClassifier
Creates an undefined classifier.

Instance methods(7)

Reset(L: gp_Lin2d, P: number, Tol: number): void
Starts a classification process. The point to classify is the origin of the line <L>.
is the original length of the segment on <L> used to compute intersections. <Tol> is the tolerance attached to the line segment in intersections.
Parameters (3)
- L
- P
- Tol
Compare(E: BRepClass_Edge, Or: TopAbs_Orientation): void
Updates the classification process with the edge <E> from the boundary.
Parameters (2)
- E
- Or
Parameter(): number
Returns the current value of the parameter.
Intersector(): BRepClass_Intersector
Returns the intersecting algorithm.
ClosestIntersection(): number
Returns 0 if the last compared edge had no relevant intersection. Else returns the index of this intersection in the last intersection algorithm.
State(): TopAbs_State
Returns the current state of the point.
IsHeadOrEnd(): boolean
Returns the true if the closest intersection point represents head or end of the edge. Returns false otherwise.

BRepClass_FClassifier

Constructors(1)

constructor(): BRepClass_FClassifier
Empty constructor, undefined algorithm.

Instance methods(5)

Rejected(): boolean
Returns True when the state was computed by a rejection. The state is OUT.
NoWires(): boolean
Returns True if the face contains no wire. The state is IN.
Edge(): BRepClass_Edge
Returns the Edge used to determine the classification. When the State is ON this is the Edge containing the point.
EdgeParameter(): number
Returns the parameter on Edge() used to determine the classification.
Position(): IntRes2d_Position
Returns the position of the point on the edge returned by Edge.

BRepClass_Intersector

Geom2dInt_IntConicCurveOfGInterIntRes2d_Intersection

Intersect an Edge with a segment. Implement the Intersector2d required by the classifier.

Constructors(1)

constructor(): BRepClass_Intersector

Instance methods(7)

Perform(L: gp_Lin2d, P: number, Tol: number, E: BRepClass_Edge): void
Intersect the line segment and the edge.
Parameters (4)
- L
- P
- Tol
- E
Perform(L: gp_Lin2d, D1: IntRes2d_Domain, PCurve: Adaptor2d_Curve2d, D2: IntRes2d_Domain, TolConf: number, Tol: number): void
Intersect the line segment and the edge.
Parameters (6)
- L
- D1
- PCurve
- D2
- TolConf
- Tol
Perform(C: gp_Circ2d, D1: IntRes2d_Domain, PCurve: Adaptor2d_Curve2d, D2: IntRes2d_Domain, TolConf: number, Tol: number): void
Intersect the line segment and the edge.
Parameters (6)
- C
- D1
- PCurve
- D2
- TolConf
- Tol
Perform(E: gp_Elips2d, D1: IntRes2d_Domain, PCurve: Adaptor2d_Curve2d, D2: IntRes2d_Domain, TolConf: number, Tol: number): void
Intersect the line segment and the edge.
Parameters (6)
- E
- D1
- PCurve
- D2
- TolConf
- Tol
Perform(Prb: gp_Parab2d, D1: IntRes2d_Domain, PCurve: Adaptor2d_Curve2d, D2: IntRes2d_Domain, TolConf: number, Tol: number): void
Intersect the line segment and the edge.
Parameters (6)
- Prb
- D1
- PCurve
- D2
- TolConf
- Tol
Perform(H: gp_Hypr2d, D1: IntRes2d_Domain, PCurve: Adaptor2d_Curve2d, D2: IntRes2d_Domain, TolConf: number, Tol: number): void
Intersect the line segment and the edge.
Parameters (6)
- H
- D1
- PCurve
- D2
- TolConf
- Tol
LocalGeometry(E: BRepClass_Edge, U: number, T: gp_Dir2d, N: gp_Dir2d, C: number): { C: number }
Returns in <T>, <N> and the tangent, normal and curvature of the edge <E> at parameter value .
Parameters (5)
- E
- U
- T —
  Mutated in place; read the updated value from this argument after the call.
- N —
  Mutated in place; read the updated value from this argument after the call.
- C
Returns
A result object with fields:
- C: updated value from the call.