PavePave
Home
Guide
API
Sandbox
  • English
  • 日本語
GitHub
Home
Guide
API
Sandbox
  • English
  • 日本語
GitHub
  • Line

@baku89/pave v0.7.2


@baku89/pave / Line

Line

A collection of functions to handle a line represented with SegmentL.

Variables

curvature

const curvature: 0 = 0

Defined in: Line.ts:50

Functions

bounds()

bounds(line): Rect

Defined in: Line.ts:24

Parameters

ParameterType
lineBareSegmentL

Returns

Rect


derivative()

derivative(line): vec2

Defined in: Line.ts:34

Parameters

ParameterType
lineBareSegmentL

Returns

vec2


divideAtTimes()

divideAtTimes(line, times): VertexL[]

Defined in: Line.ts:73

Parameters

ParameterType
lineBareSegmentL
timesIterable<number>

Returns

VertexL[]


isZero()

isZero(line): boolean

Defined in: Line.ts:85

Returns true if the length of line segment is zero.

Parameters

ParameterType
lineBareSegmentL

Returns

boolean


length()

length(line): number

Defined in: Line.ts:38

Parameters

ParameterType
lineBareSegmentL

Returns

number


normal()

normal(line): vec2

Defined in: Line.ts:46

Parameters

ParameterType
lineBareSegmentL

Returns

vec2


of()

of(start, point): SegmentL

Defined in: Line.ts:20

Parameters

ParameterType
startvec2
pointvec2

Returns

SegmentL


offset()

offset(line, distance): PathL

Defined in: Line.ts:89

Parameters

ParameterType
lineBareSegmentL
distancenumber

Returns

PathL


orientation()

orientation(line, loc): mat2d

Defined in: Line.ts:52

Parameters

ParameterType
lineBareSegmentL
locSegmentLocation

Returns

mat2d


point()

point(line, loc): vec2

Defined in: Line.ts:29

Parameters

ParameterType
lineBareSegmentL
locSegmentLocation

Returns

vec2


tangent()

tangent(line): vec2

Defined in: Line.ts:42

Parameters

ParameterType
lineBareSegmentL

Returns

vec2


toTime()

toTime(line, loc): number

Defined in: Line.ts:102

Converts a signed location to a time between 0 and 1.

Parameters

ParameterTypeDescription
lineBareSegmentL
locSegmentLocation

Returns

number


trim()

trim(line, start, end): SegmentL

Defined in: Line.ts:59

Parameters

ParameterType
lineBareSegmentL
startSegmentLocation
endSegmentLocation

Returns

SegmentL

Edit this page