Class ClippingPolygonObject

baseclass for all Objects

Hierarchy (View Summary)

VcsObject
- ClippingPolygonObject

Accessors

active

get active(): boolean
Whether the clipping polygon object is active or not

Returns boolean
- Defined in src/util/clipping/clippingPolygonObject.ts:105

className

get className(): string
Returns string
Inherited from VcsObject.className
- Defined in src/vcsObject.ts:53

clippingPolygon

get clippingPolygon(): ClippingPolygon | undefined
Returns ClippingPolygon | undefined
- Defined in src/util/clipping/clippingPolygonObject.ts:126

coordinates

get coordinates(): readonly (readonly number[])[]
Returns readonly (readonly number[])[]
- Defined in src/util/clipping/clippingPolygonObject.ts:130

layerNames

get layerNames(): string[] | "all"
Returns string[] | "all"
- Defined in src/util/clipping/clippingPolygonObject.ts:109

terrain

get terrain(): boolean
Returns boolean
- Defined in src/util/clipping/clippingPolygonObject.ts:113
set terrain(terrain: boolean): void
Parameters
- terrain: boolean
Returns void
- Defined in src/util/clipping/clippingPolygonObject.ts:117

`Static`className

get className(): string
Returns string
Overrides VcsObject.className
- Defined in src/util/clipping/clippingPolygonObject.ts:30

Constructors

constructor

new ClippingPolygonObject(
options: ClippingPolygonObjectOptions,
): ClippingPolygonObject
Parameters
- options: ClippingPolygonObjectOptions
Returns ClippingPolygonObject
Overrides VcsObject.constructor
- Defined in src/util/clipping/clippingPolygonObject.ts:84

Methods

activate

activate(): void
Returns void
- Defined in src/util/clipping/clippingPolygonObject.ts:179

deactivate

deactivate(): void
Returns void
- Defined in src/util/clipping/clippingPolygonObject.ts:186

destroy

destroy(): void
Returns void
Overrides VcsObject.destroy
- Defined in src/util/clipping/clippingPolygonObject.ts:216

getLogger

getLogger(): Logger
Returns Logger
Inherited from VcsObject.getLogger
- Defined in src/vcsObject.ts:57

setCoordinates

setCoordinates(coordinates: Coordinate[]): void
Set polygon coordinates from an array of geographic wgs84 coordinates
Parameters
- coordinates: Coordinate[]
Returns void
- Defined in src/util/clipping/clippingPolygonObject.ts:138

setLayerNames

setLayerNames(layerNames: string[] | "all"): void
Parameters
- layerNames: string[] | "all"
Returns void
- Defined in src/util/clipping/clippingPolygonObject.ts:166

toJSON

toJSON(
defaultOptions?: ClippingPolygonObjectOptions,
): ClippingPolygonObjectOptions
Parameters
- defaultOptions: ClippingPolygonObjectOptions = ...
Returns ClippingPolygonObjectOptions
Overrides VcsObject.toJSON
- Defined in src/util/clipping/clippingPolygonObject.ts:193

`Static`fromFeature

fromFeature(feature: Feature<Polygon>): ClippingPolygonObject | null
Parameters
- feature: Feature<Polygon>
Returns ClippingPolygonObject | null
- Defined in src/util/clipping/clippingPolygonObject.ts:43

`Static`fromGeometry

fromGeometry(geometry: Polygon): ClippingPolygonObject
Parameters
- geometry: Polygon
Returns ClippingPolygonObject
- Defined in src/util/clipping/clippingPolygonObject.ts:51

`Static`getDefaultOptions

getDefaultOptions(): ClippingPolygonObjectOptions
Returns ClippingPolygonObjectOptions
Overrides VcsObject.getDefaultOptions
- Defined in src/util/clipping/clippingPolygonObject.ts:34

Properties

`Optional`[moduleIdSymbol]

"[moduleIdSymbol]"?: string

activeOnStartup

activeOnStartup: boolean

clippingPolygonChanged

clippingPolygonChanged: VcsEvent<
{ newValue: ClippingPolygon; oldValue: ClippingPolygon
| undefined },
> = ...

isDestroyed

isDestroyed: boolean

layersChanged

layersChanged: VcsEvent<
{ newValue: string[]
| "all"; oldValue: string[] | "all" },
> = ...

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>

stateChanged

stateChanged: VcsEvent<ClippingPolygonObjectState> = ...

terrainChanged

terrainChanged: VcsEvent<boolean> = ...