Hide menu
Loading...
Searching...
No Matches
Edge

Defines an edge.

An edge is a topological part of a 3D curve bounded by two vertices.

Extends

Constructors

Constructor

new Edge(startVertex, endVertex): Edge

Creates an edge bounded by the provided vertices.

Parameters

startVertex

Vertex

Start vertex of the curve.

endVertex

Vertex

End vertex of the curve.

Returns

Edge

Overrides

Shape.constructor

Constructor

new Edge(curve, startVertex, endVertex): Edge

Creates an edge bounded by the provided vertices and represented by the specified curve.

Parameters

curve

Curve

3D curve of the edge.

startVertex

Vertex

Start vertex of the curve.

endVertex

Vertex

End vertex of the curve.

Returns

Edge

Overrides

Shape.constructor

Properties

triangulation

triangulation: EdgeTriangulation | null = null

Polygonal representation of the edge.

The default value is null.

Accessors

curve

Get Signature

get curve(): Curve | null

3D curve of the edge.

The value is null for an edge for which Edge.isDegenerated returns true.

Returns

Curve | null

Set Signature

set curve(curve): void

Sets 3D curve of the edge.

The curve must go from the start vertex to the end vertex in the direction of increasing curve parameter.

The vertices must lie on the curve and within the curve definition range unless the curve is periodic.

If curve is null, removes the 3D curve from the edge.

For degenerated edges (e.g. sphere pole or cone apex) this method should not be called.

Parameters

curve

Curve | null

Curve of the edge.

Returns

void


endVertex

Get Signature

get endVertex(): Vertex

End vertex of the edge.

The end vertex corresponds to the point on the curve with the greater parameter.

Returns

Vertex


id

Get Signature

get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

Shape.id


name

Get Signature

get name(): string | null

Name of the shape.

The default value is null.

Returns

string | null

Set Signature

set name(name): void

Sets the name of the shape.

Parameters

name

string | null

Shape name.

Returns

void

Inherited from

Shape.name


startVertex

Get Signature

get startVertex(): Vertex

Start vertex of the edge.

The start vertex corresponds to the point on the curve with the smaller parameter.

Returns

Vertex


type

Get Signature

get type(): ShapeType

Type of the shape.

Returns

ShapeType

Inherited from

Shape.type

Methods

isDegenerated()

isDegenerated(): boolean

Returns whether the edge has no 3D curve.

Returns

boolean