Edge
Hierarchy
_1DShape<TopoDS_Edge>↳
Edge
Constructors
constructor
• new Edge(ocShape)
Parameters
| Name | Type |
|---|---|
ocShape | TopoDS_Edge |
Inherited from
Defined in
Accessors
boundingBox
• get boundingBox(): BoundingBox
Returns
Inherited from
_1DShape.boundingBox
Defined in
curve
• get curve(): Curve
Returns
Inherited from
_1DShape.curve
Defined in
edges
• get edges(): Edge[]
Returns
Edge[]
Inherited from
_1DShape.edges
Defined in
endPoint
• get endPoint(): Vector
Returns
Inherited from
_1DShape.endPoint
Defined in
faces
• get faces(): Face[]
Returns
Face[]
Inherited from
_1DShape.faces
Defined in
geomType
• get geomType(): CurveType
Returns
Inherited from
_1DShape.geomType
Defined in
hashCode
• get hashCode(): number
Returns
number
Inherited from
_1DShape.hashCode
Defined in
isClosed
• get isClosed(): boolean
Returns
boolean
Inherited from
_1DShape.isClosed
Defined in
isNull
• get isNull(): boolean
Returns
boolean
Inherited from
_1DShape.isNull
Defined in
isPeriodic
• get isPeriodic(): boolean
Returns
boolean
Inherited from
_1DShape.isPeriodic
Defined in
length
• get length(): number
Returns
number
Inherited from
_1DShape.length
Defined in
orientation
• get orientation(): "forward" | "backward"
Returns
"forward" | "backward"
Inherited from
_1DShape.orientation
Defined in
period
• get period(): number
Returns
number
Inherited from
_1DShape.period
Defined in
repr
• get repr(): string
Returns
string
Inherited from
_1DShape.repr
Defined in
startPoint
• get startPoint(): Vector
Returns
Inherited from
_1DShape.startPoint
Defined in
wires
• get wires(): Wire[]
Returns
Wire[]
Inherited from
_1DShape.wires
Defined in
wrapped
• get wrapped(): Type
Returns
Type
Inherited from
_1DShape.wrapped
Defined in
• set wrapped(newWrapped): void
Parameters
| Name | Type |
|---|---|
newWrapped | Type |
Returns
void
Inherited from
_1DShape.wrapped
Defined in
Other Methods
clone
▸ clone(): Edge
Returns
Inherited from
Defined in
delete
▸ delete(): void
Returns
void
Inherited from
Defined in
isEqual
▸ isEqual(other): boolean
Parameters
| Name | Type |
|---|---|
other | AnyShape |
Returns
boolean
Inherited from
Defined in
isSame
▸ isSame(other): boolean
Parameters
| Name | Type |
|---|---|
other | AnyShape |
Returns
boolean
Inherited from
Defined in
pointAt
▸ pointAt(position?): Vector
Parameters
| Name | Type | Default value |
|---|---|---|
position | number | 0 |
Returns
Inherited from
Defined in
simplify
▸ simplify(): Edge
Simplifies the shape by removing unnecessary edges and faces
Returns
Inherited from
Defined in
tangentAt
▸ tangentAt(position?): Vector
Parameters
| Name | Type | Default value |
|---|---|---|
position | number | 0 |
Returns
Inherited from
Defined in
Shape Export Methods
blobSTEP
▸ blobSTEP(): Blob
Exports the current shape as a STEP file as a Blob
Returns
Blob
Inherited from
Defined in
blobSTL
▸ blobSTL(«destructured»?): Blob
Exports the current shape as a STL file as a Blob
In order to create a STL file, the shape needs to be meshed. The tolerances correspond to the values used to mesh the shape.
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› angularTolerance | undefined | number |
› binary | undefined | boolean |
› tolerance | undefined | number |
Returns
Blob
Inherited from
Defined in
mesh
▸ mesh(«destructured»?): ShapeMesh
Exports the current shape as a set of triangle. These can be used by threejs for instance to represent the the shape
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› angularTolerance | undefined | number |
› tolerance | undefined | number |
Returns
Inherited from
Defined in
meshEdges
▸ meshEdges(«destructured»?): Object
Exports the current shape as a set of lines. These can be used by threejs for instance to represent the edges of the shape
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› angularTolerance | undefined | number |
› tolerance | undefined | number |
Returns
Object
| Name | Type |
|---|---|
edgeGroups | { count: number ; edgeId: number ; start: number }[] |
lines | number[] |
Inherited from
Defined in
Shape Transformations Methods
mirror
▸ mirror(inputPlane?, origin?): Edge
Mirrors the shape through a plane
Parameters
| Name | Type |
|---|---|
inputPlane? | Point | Plane | PlaneName |
origin? | Point |
Returns
Inherited from
Defined in
rotate
▸ rotate(angle, position?, direction?): Edge
Rotates the shape
Parameters
| Name | Type |
|---|---|
angle | number |
position | Point |
direction | Point |
Returns
Inherited from
Defined in
scale
▸ scale(scale, center?): Edge
Returns a scaled version of the shape
Parameters
| Name | Type |
|---|---|
scale | number |
center | Point |
Returns
Inherited from
Defined in
translate
▸ translate(xDist, yDist, zDist): Edge
Translates the shape of an arbitrary vector
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
zDist | number |
Returns
Inherited from
Defined in
▸ translate(vector): Edge
Parameters
| Name | Type |
|---|---|
vector | Point |
Returns
Inherited from
Defined in
translateX
▸ translateX(distance): Edge
Translates the shape on the X axis
Parameters
| Name | Type |
|---|---|
distance | number |
Returns
Inherited from
Defined in
translateY
▸ translateY(distance): Edge
Translates the shape on the Y axis
Parameters
| Name | Type |
|---|---|
distance | number |
Returns
Inherited from
Defined in
translateZ
▸ translateZ(distance): Edge
Translates the shape on the Z axis
Parameters
| Name | Type |
|---|---|
distance | number |