Skip to main content

Interface: PathPattern

Defined in: src/sdk/graphics/path/PatternPathStream.ts:9

A pattern which can be drawn along a path.

Properties

anchor

readonly anchor: number

Defined in: src/sdk/graphics/path/PatternPathStream.ts:17

The anchor point of each repeating unit of this pattern along its length, as a fraction of the total length. The orientation of each pattern unit is determined by the direction of the path at its anchor point.


length

readonly length: number

Defined in: src/sdk/graphics/path/PatternPathStream.ts:11

The along-path length of each repeating unit of this pattern.

Methods

draw()

draw(stream): void

Defined in: src/sdk/graphics/path/PatternPathStream.ts:25

Draws a single unit of this pattern to a path stream. The coordinate system of the path stream is set such that the anchor point of the pattern unit is located at the origin (0, 0), and the positive x-axis points in the direction of the path on which the pattern unit is placed.

Parameters

ParameterTypeDescription
streamPathStreamThe path stream to which to draw this pattern.

Returns

void