Class: GeoCylindricalClippedPathStream
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:51
A path stream which performs clipping of geographical spherical coordinates to a cylindrical area defined by minimum and maximum longitudes and latitudes before sending the clipped path (still in spherical coordinates) to another stream.
Extends
Constructors
Constructor
new GeoCylindricalClippedPathStream(
consumer,bounds):GeoCylindricalClippedPathStream
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:108
Creates a new instance of GeoCylindricalClippedPathStream.
Parameters
| Parameter | Type | Description |
|---|---|---|
consumer | PathStream | The path stream that consumes this stream's transformed output. |
bounds | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>> | A subscribable which provides the clipping bounds for this stream, as [minLongitude, minLatitude, maxLongitude, maxLatitude], in degrees. Longitude values will be normalized to the range [-180, 180) and latitude values will be clamped to the range [-90, 90]. Whenever the clipping bounds change, the state of this stream will be reset, as if beginPath() were called. |
Returns
GeoCylindricalClippedPathStream
Overrides
AbstractTransformingPathStream.constructor
Properties
consumer
protectedconsumer: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(
lon,lat,radius,startAngle,endAngle,counterClockwise?):void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:222
Paths a small-circle arc.
Parameters
| Parameter | Type | Description |
|---|---|---|
lon | number | The longitude of the center of the circle containing the arc, in degrees. |
lat | number | The latitude of the center of the circle containing the arc, in degrees. |
radius | number | The radius of the arc, in great-arc radians. |
startAngle | number | If the center of the circle containing the arc is not one of the poles, the true bearing, in degrees, from the center of the circle to the start of the arc; otherwise the longitude, in degrees, of the start of the arc. |
endAngle | number | If the center of the circle containing the arc is not one of the poles, the true bearing, in degrees, from the center of the circle to the end of the arc; otherwise the longitude, in degrees, of the end of the arc. |
counterClockwise? | boolean | Whether the arc should be drawn counterclockwise (when viewed from above the center of the circle containing the arc). Defaults to false. |
Returns
void
Overrides
AbstractTransformingPathStream.arc
beginPath()
beginPath():
void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:115
Begins a path. Erases all previous path state.
Returns
void
Overrides
AbstractTransformingPathStream.beginPath
bezierCurveTo()
bezierCurveTo():
void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:196
Not supported by this path stream.
Returns
void
Throws
Error when called.
Overrides
AbstractTransformingPathStream.bezierCurveTo
closePath()
closePath():
void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:294
Paths a line from the current point to the first point defined by the current path.
Returns
void
Overrides
AbstractTransformingPathStream.closePath
destroy()
destroy():
void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:741
Destroys this stream.
Returns
void
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
The path stream that is consuming this stream's transformed output.
Inherited from
AbstractTransformingPathStream.getConsumer
lineTo()
lineTo(
lon,lat):void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:152
Paths a great-circle arc from the current point to a specified point.
Parameters
| Parameter | Type | Description |
|---|---|---|
lon | number | The longitude of the end point, in degrees. |
lat | number | The latitude of the end point, in degrees. |
Returns
void
Throws
Error if the specified point is antipodal to the last pathed point.
Overrides
AbstractTransformingPathStream.lineTo
moveTo()
moveTo(
lon,lat):void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:125
Moves to a specified point.
Parameters
| Parameter | Type | Description |
|---|---|---|
lon | number | The longitude of the point to which to move, in degrees. |
lat | number | The latitude of the point to which to move, in degrees. |
Returns
void
Overrides
AbstractTransformingPathStream.moveTo
quadraticCurveTo()
quadraticCurveTo():
void
Defined in: src/sdk/graphics/path/GeoCylindricalClippedPathStream.ts:204
Not supported by this path stream.
Returns
void
Throws
Error when called.
Overrides
AbstractTransformingPathStream.quadraticCurveTo
setConsumer()
setConsumer(
consumer):void
Defined in: src/sdk/graphics/path/PathStream.ts:153
Sets the path stream that consumes this stream's transformed output.
Parameters
| Parameter | Type | Description |
|---|---|---|
consumer | PathStream | The new consuming path stream. |
Returns
void