Skip to main content

Class: MapDragPanController

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Controllers/MapDragPanController.ts:17

Controls the pointer of a map.

Extends​

Constructors​

Constructor​

new MapDragPanController(context): MapDragPanController

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:30

Constructor.

Parameters​

ParameterTypeDescription
contextMapSystemContext<MapDragPanControllerModules, any, any, any>This controller's map context.

Returns​

MapDragPanController

Inherited from​

MapSystemController<MapDragPanControllerModules>.constructor

Properties​

context​

protected readonly context: MapSystemContext<MapDragPanControllerModules, any, any, any>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Inherited from​

MapSystemController.context

Accessors​

isAlive​

Get Signature​

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns​

boolean

Inherited from​

MapSystemController.isAlive

Methods​

destroy()​

destroy(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:106

Destroys this controller.

Returns​

void

Inherited from​

MapSystemController.destroy


drag()​

drag(dx, dy): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Controllers/MapDragPanController.ts:53

Executes a drag action.

Parameters​

ParameterTypeDescription
dxnumberThe horizontal displacement of the drag motion, in pixels.
dynumberThe vertical dispacement of the drag motion, in pixels.

Returns​

void


onAfterMapRender()​

onAfterMapRender(ref): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:39

This method is called after this controller' map is rendered.

Parameters​

ParameterTypeDescription
refMapSystemComponentA reference to the rendered map.

Returns​

void

Inherited from​

MapSystemController.onAfterMapRender


onAfterUpdated()​

onAfterUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:78

This method is called immediately after this controller's map updates its layers.

Parameters​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns​

void

Inherited from​

MapSystemController.onAfterUpdated


onBeforeUpdated()​

onBeforeUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:68

This method is called immediately before this controller's map updates its layers.

Parameters​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns​

void

Inherited from​

MapSystemController.onBeforeUpdated


onDeadZoneChanged()​

onDeadZoneChanged(deadZone): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:48

This method is called when the dead zone of this controller's map changes.

Parameters​

ParameterTypeDescription
deadZoneReadonlyFloat64ArrayThe map's new dead zone.

Returns​

void

Inherited from​

MapSystemController.onDeadZoneChanged


onMapDestroyed()​

onMapDestroyed(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:99

This method is called when this controller's map is destroyed.

Returns​

void

Inherited from​

MapSystemController.onMapDestroyed


onMapProjectionChanged()​

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58

This method is called when the projection of this controller's map changes.

Parameters​

ParameterTypeDescription
mapProjectionMapProjectionThe map projection.
changeFlagsnumberBit flags describing the type of change.

Returns​

void

Inherited from​

MapSystemController.onMapProjectionChanged


onSleep()​

onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:92

This method is called when this controller's map is put to sleep.

Returns​

void

Inherited from​

MapSystemController.onSleep


onWake()​

onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:85

This method is called when this controller's map is awakened.

Returns​

void

Inherited from​

MapSystemController.onWake


setDragPanActive()​

setDragPanActive(isActive): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Controllers/MapDragPanController.ts:24

Activates or deactivates the map pointer.

Parameters​

ParameterTypeDescription
isActivebooleanWhether to activate the map pointer.

Returns​

void


toggleDragPanActive()​

toggleDragPanActive(): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Controllers/MapDragPanController.ts:40

Toggles activation of the map pointer.

Returns​

boolean

Whether the map pointer is active after the toggle operation.