Class OCCTEdge

Hierarchy

OCCTEdge

Index

Constructors

constructor

Methods

Constructors

constructor

new OCCTEdge(occWorkerManager: OCCTWorkerManager): OCCTEdge

- Defined in bitbybit-docs.d.ts:15751
Parameters
- occWorkerManager: OCCTWorkerManager
Returns OCCTEdge

Methods

arcFromCircleAndTwoAngles

arcFromCircleAndTwoAngles(inputs: ArcEdgeCircleTwoAnglesDto<TopoDSEdgePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15796
Creates an arc edge between two alpha angles on a circle

group

primitives

shortname

arc from circle and angles

drawable

true

Parameters
- inputs: ArcEdgeCircleTwoAnglesDto<TopoDSEdgePointer>
  
  two angles and circle edge
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

arcFromCircleAndTwoPoints

arcFromCircleAndTwoPoints(inputs: ArcEdgeCircleTwoPointsDto<TopoDSEdgePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15787
Creates an arc edge between two points on a circle

group

primitives

shortname

arc from circle and points

drawable

true

Parameters
- inputs: ArcEdgeCircleTwoPointsDto<TopoDSEdgePointer>
  
  two points and circle edge
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

arcFromCirclePointAndAngle

arcFromCirclePointAndAngle(inputs: ArcEdgeCirclePointAngleDto<TopoDSEdgePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15805
Creates an arc edge between the point on a circle and a given alpha angle

group

primitives

shortname

arc from circle point and angle

drawable

true

Parameters
- inputs: ArcEdgeCirclePointAngleDto<TopoDSEdgePointer>
  
  point, circle edge and alpha angle
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

arcThroughThreePoints

arcThroughThreePoints(inputs: ArcEdgeThreePointsDto): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15769
Creates arc edge between three points

group

primitives

shortname

arc 3 points

drawable

true

Parameters
- inputs: ArcEdgeThreePointsDto
  
  three points
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

arcThroughTwoPointsAndTangent

arcThroughTwoPointsAndTangent(inputs: ArcEdgeTwoPointsTangentDto): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15778
Creates arc edge between two points given the tangent direction vector on first point.

group

primitives

shortname

arc 2 points tangent

drawable

true

Parameters
- inputs: ArcEdgeTwoPointsTangentDto
  
  two points and tangent vector
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

constraintTanCirclesOnCircleAndPnt

constraintTanCirclesOnCircleAndPnt(inputs: ConstraintTanCirclesOnCircleAndPntDto<TopoDSEdgePointer>): Promise<TopoDSShapePointer[]>

- Defined in bitbybit-docs.d.ts:16093
Creates tangent circles between a point and a circle.

group

constraint

shortname

tan circles on circle and pnt

drawable

true

Parameters
- inputs: ConstraintTanCirclesOnCircleAndPntDto<TopoDSEdgePointer>
Returns Promise<TopoDSShapePointer[]>

circles

constraintTanCirclesOnTwoCircles

constraintTanCirclesOnTwoCircles(inputs: ConstraintTanCirclesOnTwoCirclesDto<TopoDSEdgePointer>): Promise<TopoDSShapePointer[]>

- Defined in bitbybit-docs.d.ts:16084
Creates tangent circles between two circles.

group

constraint

shortname

tan circles on two circles

drawable

true

Parameters
- inputs: ConstraintTanCirclesOnTwoCirclesDto<TopoDSEdgePointer>
Returns Promise<TopoDSShapePointer[]>

circles

constraintTanLinesFromPtToCircle

constraintTanLinesFromPtToCircle(inputs: ConstraintTanLinesFromPtToCircleDto<TopoDSEdgePointer>): Promise<TopoDSShapePointer[]>

- Defined in bitbybit-docs.d.ts:16066
Creates lines from a given point till circle tangent locations

group

constraint

shortname

tan lines from pt to circle

drawable

true

Parameters
- inputs: ConstraintTanLinesFromPtToCircleDto<TopoDSEdgePointer>
Returns Promise<TopoDSShapePointer[]>

lines

constraintTanLinesFromTwoPtsToCircle

constraintTanLinesFromTwoPtsToCircle(inputs: ConstraintTanLinesFromTwoPtsToCircleDto<TopoDSEdgePointer>): Promise<TopoDSShapePointer[]>

- Defined in bitbybit-docs.d.ts:16057
Creates lines from two given points till circle tangent locations

group

constraint

shortname

tan lines from 2 pts to circle

drawable

true

Parameters
- inputs: ConstraintTanLinesFromTwoPtsToCircleDto<TopoDSEdgePointer>
Returns Promise<TopoDSShapePointer[]>

lines

constraintTanLinesOnTwoCircles

constraintTanLinesOnTwoCircles(inputs: ConstraintTanLinesOnTwoCirclesDto<TopoDSEdgePointer>): Promise<TopoDSShapePointer[]>

- Defined in bitbybit-docs.d.ts:16075
Creates tangent lines between two circles.

group

constraint

shortname

tan lines on two circles

drawable

true

Parameters
- inputs: ConstraintTanLinesOnTwoCirclesDto<TopoDSEdgePointer>
Returns Promise<TopoDSShapePointer[]>

lines

createCircleEdge

createCircleEdge(inputs: CircleDto): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15814
Creates OpenCascade circle edge

group

primitives

shortname

circle

drawable

true

Parameters
- inputs: CircleDto
  
  Circle parameters
Returns Promise<TopoDSEdgePointer>

OpenCascade circle edge

createEllipseEdge

createEllipseEdge(inputs: EllipseDto): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15823
Creates OpenCascade ellipse edge

group

primitives

shortname

ellipse

drawable

true

Parameters
- inputs: EllipseDto
  
  Ellipse parameters
Returns Promise<TopoDSEdgePointer>

OpenCascade ellipse edge

divideEdgeByEqualDistanceToPoints

divideEdgeByEqualDistanceToPoints(inputs: DivideDto<TopoDSEdgePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:16048
Divides edge by length to points

group

extract

shortname

points by distance

drawable

true

Parameters
- inputs: DivideDto<TopoDSEdgePointer>
Returns Promise<Point3[]>

Points

divideEdgeByParamsToPoints

divideEdgeByParamsToPoints(inputs: DivideDto<TopoDSEdgePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:16039
Divides edge by params to points

group

extract

shortname

points by params

drawable

true

Parameters
- inputs: DivideDto<TopoDSEdgePointer>
Returns Promise<Point3[]>

Points

edgesToPoints

edgesToPoints(inputs: EdgesToPointsDto<TopoDSEdgePointer>): Promise<Point3[][]>

- Defined in bitbybit-docs.d.ts:15976
Gets the points of all edges from a shape in separate lists for each edge

group

extract

shortname

edges to points

drawable

false

Parameters
- inputs: EdgesToPointsDto<TopoDSEdgePointer>
  
  Shape
Returns Promise<Point3[][]>

OpenCascade points lists

endPointOnEdge

endPointOnEdge(inputs: ShapeDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:16030
Gets the end point on edge

group

extract

shortname

end point

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
Returns Promise<Point3>

End point

getCircularEdgeCenterPoint

getCircularEdgeCenterPoint(inputs: ShapeDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:15940
Gets the center point of the circular edge. If edge is not circular, point will not be returned.

group

get circular edge

shortname

get center of circular edge

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  edge
Returns Promise<Point3>

Point representing center of the circular edge

getCircularEdgePlaneDirection

getCircularEdgePlaneDirection(inputs: ShapeDto<TopoDSEdgePointer>): Promise<Vector3>

- Defined in bitbybit-docs.d.ts:15958
Gets the direction vector of the plane of the circular edge. If edge is not circular, direction vector will not be returned.

group

get circular edge

shortname

get plane direction of circular edge

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  edge
Returns Promise<Vector3>

Direction vector of the circular edge

getCircularEdgeRadius

getCircularEdgeRadius(inputs: ShapeDto<TopoDSEdgePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:15949
Gets the radius of the circular edge. If edge is not circular, radius will not be returned.

group

get circular edge

shortname

get radius of circular edge

drawable

false

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  edge
Returns Promise<number>

Radius of the circular edge

getCircularEdgesAlongWire

getCircularEdgesAlongWire(inputs: ShapeDto<TopoDSWirePointer>): Promise<TopoDSEdgePointer[]>

- Defined in bitbybit-docs.d.ts:15877
Gets circular edges of a wire ordered along the direction of the wire

group

get

shortname

get circular edges along wire

drawable

true

Parameters
- inputs: ShapeDto<TopoDSWirePointer>
  
  wire shape
Returns Promise<TopoDSEdgePointer[]>

OpenCascade edge list

getCornerPointsOfEdgesForShape

getCornerPointsOfEdgesForShape(inputs: ShapeDto<TopoDSShapePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:15895
Gets corner points of edges for a shape. There's no order guarantee here. All duplicates are removed, so when three edges form one corner, that will be represented by a single point in the list.

group

get

shortname

corners

drawable

true

Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  
  Shape that contains edges - wire, face, shell, solid
Returns Promise<Point3[]>

List of points

getEdge

getEdge(inputs: EdgeIndexDto<TopoDSShapePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15850
Gets the edge by providing an index from the shape

group

get

shortname

get edge

drawable

true

Parameters
- inputs: EdgeIndexDto<TopoDSShapePointer>
  
  Shape
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

getEdgeCenterOfMass

getEdgeCenterOfMass(inputs: ShapeDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:15922
Gets the center of mass for the edge

group

get

shortname

center of mass

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  edge
Returns Promise<Point3>

Point representing center of mass

getEdgeLength

getEdgeLength(inputs: ShapeDto<TopoDSEdgePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:15904
Gets the edge length

group

get

shortname

length

drawable

false

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  edge
Returns Promise<number>

Length

getEdges

getEdges(inputs: ShapeDto<TopoDSShapePointer>): Promise<TopoDSEdgePointer[]>

- Defined in bitbybit-docs.d.ts:15859
Gets the edges of a shape in a list

group

get

shortname

get edges

drawable

true

Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  
  Shape
Returns Promise<TopoDSEdgePointer[]>

OpenCascade edge list

getEdgesAlongWire

getEdgesAlongWire(inputs: ShapeDto<TopoDSWirePointer>): Promise<TopoDSEdgePointer[]>

- Defined in bitbybit-docs.d.ts:15868
Gets the edges of a wire ordered along the direction of the wire

group

get

shortname

get edges along wire

drawable

true

Parameters
- inputs: ShapeDto<TopoDSWirePointer>
  
  wire shape
Returns Promise<TopoDSEdgePointer[]>

OpenCascade edge list

getEdgesCentersOfMass

getEdgesCentersOfMass(inputs: ShapesDto<TopoDSEdgePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:15931
Gets the centers of mass for the edges

group

get

shortname

centers of mass

drawable

true

Parameters
- inputs: ShapesDto<TopoDSEdgePointer>
  
  edges
Returns Promise<Point3[]>

Points representing centers of mass

getEdgesLengths

getEdgesLengths(inputs: ShapesDto<TopoDSEdgePointer>): Promise<number[]>

- Defined in bitbybit-docs.d.ts:15913
Gets the lengths of the edges

group

get

shortname

lengths

drawable

false

Parameters
- inputs: ShapesDto<TopoDSEdgePointer>
  
  edges
Returns Promise<number[]>

Lengths

getLinearEdgesAlongWire

getLinearEdgesAlongWire(inputs: ShapeDto<TopoDSWirePointer>): Promise<TopoDSEdgePointer[]>

- Defined in bitbybit-docs.d.ts:15886
Gets linear edges of a wire ordered along the direction of the wire

group

get

shortname

get linear edges along wire

drawable

true

Parameters
- inputs: ShapeDto<TopoDSWirePointer>
  
  wire shape
Returns Promise<TopoDSEdgePointer[]>

OpenCascade edge list

line

line(inputs: LineDto): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15760
Creates linear edge between two points

group

primitives

shortname

line

drawable

true

Parameters
- inputs: LineDto
  
  Two points between which edge should be created
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

makeEdgeFromGeom2dCurveAndSurface

makeEdgeFromGeom2dCurveAndSurface(inputs: CurveAndSurfaceDto<Geom2dCurvePointer, GeomSurfacePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15841
Creates an edge from geom curve and geom surface

group

from

shortname

2d curve and surface

drawable

true

Parameters
- inputs: CurveAndSurfaceDto<Geom2dCurvePointer, GeomSurfacePointer>
  
  shapes are expected to contain 2 array elements - first is geom curve, second geom surface
Returns Promise<TopoDSEdgePointer>

OpenCascade TopoDS_Edge

pointOnEdgeAtLength

pointOnEdgeAtLength(inputs: DataOnGeometryAtLengthDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:16003
Gets the point on edge at length

group

extract

shortname

point at length

drawable

true

Parameters
- inputs: DataOnGeometryAtLengthDto<TopoDSEdgePointer>
Returns Promise<Point3>

Point on edge

pointOnEdgeAtParam

pointOnEdgeAtParam(inputs: DataOnGeometryAtParamDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:15967
Gets the point on edge at param

group

extract

shortname

point at param

drawable

true

Parameters
- inputs: DataOnGeometryAtParamDto<TopoDSEdgePointer>
Returns Promise<Point3>

Point on param

removeInternalEdges

removeInternalEdges(inputs: ShapeDto<TopoDSShapePointer>): Promise<TopoDSShapePointer>

- Defined in bitbybit-docs.d.ts:15832
Removes internal faces for the shape

group

shapes

shortname

remove internal

drawable

true

Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  
  Shape
Returns Promise<TopoDSShapePointer>

OpenCascade shape with no internal edges

reversedEdge

reversedEdge(inputs: ShapeDto<TopoDSEdgePointer>): Promise<TopoDSEdgePointer>

- Defined in bitbybit-docs.d.ts:15985
Computes reversed edge from input edge

group

get

shortname

reversed edge

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
  
  Shape
Returns Promise<TopoDSEdgePointer>

OpenCascade edge

startPointOnEdge

startPointOnEdge(inputs: ShapeDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:16021
Gets the start point on edge

group

extract

shortname

start point

drawable

true

Parameters
- inputs: ShapeDto<TopoDSEdgePointer>
Returns Promise<Point3>

Start point

tangentOnEdgeAtLength

tangentOnEdgeAtLength(inputs: DataOnGeometryAtLengthDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:16012
Gets the tangent vector on edge at length

group

extract

shortname

tangent at length

drawable

true

Parameters
- inputs: DataOnGeometryAtLengthDto<TopoDSEdgePointer>
Returns Promise<Point3>

Tangent vector on edge

tangentOnEdgeAtParam

tangentOnEdgeAtParam(inputs: DataOnGeometryAtParamDto<TopoDSEdgePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:15994
Gets the tangent vector on edge at param

group

extract

shortname

tangent at param

drawable

true

Parameters
- inputs: DataOnGeometryAtParamDto<TopoDSEdgePointer>
Returns Promise<Point3>

Tangent vector on param

Generated using TypeDoc