Skip to main content

Class: GeoProjectionPathStreamStack

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:12

A stack of TransformingPathStreams which transforms an input in spherical geographic coordinates to planar projected coordinates. The stack contains two sub-stacks: a pre-projected stack which transforms the path before it is projected, and a post-projected stack which transforms the projected path before it is sent to the consumer. Transforming streams can be added to the top and bottom of each sub-stack. The input will be passed through each stream in the pre-projected stack from top to bottom, then projected, then passed through each stream in the post- projected stack from top to bottom, and the final transformed output will be passed to the consumer.

Extends

Constructors

Constructor

new GeoProjectionPathStreamStack(consumer, projection, minDistance, dpTolerance, maxDepth): GeoProjectionPathStreamStack

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:28

Constructor.

Parameters

ParameterTypeDescription
consumerPathStreamThe path stream that consumes this stream's transformed output.
projectionGeoProjectionThe projection this stream uses.
minDistancenumberThe minimum great-circle distance this stream's resampler enforces between two adjacent resampled points, in great-arc radians.
dpTolerancenumberThe Douglas-Peucker tolerance this stream's resampler uses when deciding whether to discard a resampled point during the line simplification process.
maxDepthnumberThe maximum depth of the resampling algorithm used by this stream's resampler. The number of resampled points is bounded from above by 2^[maxDepth] - 1.

Returns

GeoProjectionPathStreamStack

Overrides

AbstractTransformingPathStream.constructor

Constructor

new GeoProjectionPathStreamStack(consumer, projection, resampler): GeoProjectionPathStreamStack

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:35

Constructor.

Parameters

ParameterTypeDescription
consumerPathStreamThe path stream that consumes this stream's transformed output.
projectionGeoProjectionThe projection this stream uses.
resamplerGeoCircleResamplerThe geo circle resampler this stream uses.

Returns

GeoProjectionPathStreamStack

Overrides

AbstractTransformingPathStream.constructor

Properties

consumer

protected consumer: PathStream

Defined in: src/sdk/graphics/path/PathStream.ts:144

The path stream that consumes this stream's transformed output.

Inherited from

AbstractTransformingPathStream.consumer

Methods

arc()

arc(x, y, radius, startAngle, endAngle, counterClockwise?): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:168

Paths an arc.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the center of the circle containing the arc.
ynumberThe y-coordinate of the center of the circle containing the arc.
radiusnumberThe radius of the arc.
startAnglenumberThe angle of the start of the arc, in radians.
endAnglenumberThe angle of the end of the arc, in radians.
counterClockwise?booleanWhether the arc should be drawn counterclockwise. False by default.

Returns

void

Overrides

AbstractTransformingPathStream.arc


beginPath()

beginPath(): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:143

Begins a path. Erases all previous path state.

Returns

void

Overrides

AbstractTransformingPathStream.beginPath


bezierCurveTo()

bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:158

Paths a cubic Bezier curve from the current point to a specified point.

Parameters

ParameterTypeDescription
cp1xnumberThe x-coordinate of the first control point.
cp1ynumberThe y-coordinate of the first control point.
cp2xnumberThe x-coordinate of the second control point.
cp2ynumberThe y-coordinate of the second control point.
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Overrides

AbstractTransformingPathStream.bezierCurveTo


closePath()

closePath(): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:173

Paths a line from the current point to the first point defined by the current path.

Returns

void

Overrides

AbstractTransformingPathStream.closePath


getConsumer()

getConsumer(): PathStream

Defined in: src/sdk/graphics/path/PathStream.ts:148

Gets the path stream that is consuming this stream's transformed output.

Returns

PathStream

The path stream that is consuming this stream's transformed output.

Inherited from

AbstractTransformingPathStream.getConsumer


getProjection()

getProjection(): GeoProjection

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:55

Gets the projection used by this stream.

Returns

GeoProjection

The projection used by this stream.


lineTo()

lineTo(x, y): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:153

Paths a straight line from the current point to a specified point.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Overrides

AbstractTransformingPathStream.lineTo


moveTo()

moveTo(x, y): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:148

Moves to a specified point.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the point to which to move.
ynumberThe y-coordinate of the point to which to move.

Returns

void

Overrides

AbstractTransformingPathStream.moveTo


popPostProjected()

popPostProjected(): undefined | TransformingPathStream

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:114

Removes the top-most path stream from the post-projected stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.

Returns

undefined | TransformingPathStream

The removed path stream, or undefined if this stack was empty.


popPreProjected()

popPreProjected(): undefined | TransformingPathStream

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:80

Removes the top-most path stream from the pre-projected stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.

Returns

undefined | TransformingPathStream

The removed path stream, or undefined if this stack was empty.


pushPostProjected()

pushPostProjected(stream): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:105

Adds a transforming path stream to the top of the post-projected stack.

Parameters

ParameterTypeDescription
streamTransformingPathStreamA transforming path stream.

Returns

void


pushPreProjected()

pushPreProjected(stream): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:71

Adds a transforming path stream to the top of the pre-projected stack.

Parameters

ParameterTypeDescription
streamTransformingPathStreamA transforming path stream.

Returns

void


quadraticCurveTo()

quadraticCurveTo(cpx, cpy, x, y): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:163

Paths a quadrative Bezier curve from the current point to a specified point.

Parameters

ParameterTypeDescription
cpxnumberThe x-coordinate of the control point.
cpynumberThe y-coordinate of the control point.
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Overrides

AbstractTransformingPathStream.quadraticCurveTo


setConsumer()

setConsumer(consumer): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:136

Sets the path stream that consumes this stream's transformed output.

Parameters

ParameterTypeDescription
consumerPathStreamThe new consuming path stream.

Returns

void

Overrides

AbstractTransformingPathStream.setConsumer


setProjection()

setProjection(projection): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:63

Sets the projection used by this stream.

Parameters

ParameterTypeDescription
projectionGeoProjectionA projection.

Returns

void


shiftPostProjected()

shiftPostProjected(): undefined | TransformingPathStream

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:131

Removes the bottom-most path stream from the post-projected stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.

Returns

undefined | TransformingPathStream

The removed path stream, or undefined if this stack was empty.


shiftPreProjected()

shiftPreProjected(): undefined | TransformingPathStream

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:97

Removes the bottom-most path stream from the pre-projected stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.

Returns

undefined | TransformingPathStream

The removed path stream, or undefined if this stack was empty.


unshiftPostProjected()

unshiftPostProjected(stream): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:122

Adds a transforming path stream to the bottom of the post-projected stack.

Parameters

ParameterTypeDescription
streamTransformingPathStreamA transforming path stream.

Returns

void


unshiftPreProjected()

unshiftPreProjected(stream): void

Defined in: src/sdk/components/map/GeoProjectionPathStreamStack.ts:88

Adds a transforming path stream to the bottom of the pre-projected stack.

Parameters

ParameterTypeDescription
streamTransformingPathStreamA transforming path stream.

Returns

void