Class FollowPositionPreferences

Follow position preferences class

Hierarchy

GemAutoreleaseObject
- FollowPositionPreferences

Accessors

accuracyCircleVisibility

get accuracyCircleVisibility(): boolean
Check if accuracy circle is visible.

Returns boolean
- Defined in core/mapviewpreferences.ts:380

cameraFocus

get cameraFocus(): Point
Get the follow position camera focus in viewport coordinates

Returns Point
- Defined in core/mapviewpreferences.ts:267

isTrackObjectFollowingMapRotation

get isTrackObjectFollowingMapRotation(): boolean
Check if position tracking object rotation follows map rotation.

Returns boolean
- Defined in core/mapviewpreferences.ts:391

mapId

get mapId(): number
Returns number
- Defined in core/mapviewpreferences.ts:262

perspective

get perspective(): MapViewPerspective
Get the map view perspective in follow position mode.

Returns MapViewPerspective
- Defined in core/mapviewpreferences.ts:278

pointerId

get pointerId(): number
Returns number
- Defined in core/mapviewpreferences.ts:259

timeBeforeTurnPresentation

get timeBeforeTurnPresentation(): number
Get the time interval before starting a turn presentation.

Returns number
- Defined in core/mapviewpreferences.ts:289
set timeBeforeTurnPresentation(val: number): void
Set the time interval before starting a turn presentation.
Parameters
- val: number
Returns void
- Defined in core/mapviewpreferences.ts:447

touchHandlerExitAllow

get touchHandlerExitAllow(): boolean
Check whether manually exiting follow position via touch handler events is enabled.

Returns boolean
- Defined in core/mapviewpreferences.ts:300
set touchHandlerExitAllow(allowExit: boolean): void
Set whether to allow manually exiting follow position via touch handler events.
Parameters
- allowExit: boolean
Returns void
- Defined in core/mapviewpreferences.ts:457

touchHandlerModifyDistanceLimits

get touchHandlerModifyDistanceLimits(): Pair<number, number>
Get touch handler distance to object adjust limits.

Returns Pair<number, number>
- Defined in core/mapviewpreferences.ts:346
set touchHandlerModifyDistanceLimits(angles: Pair<number, number>): void
Set touch handler distance to object adjust limits.
Parameters
- angles: Pair<number, number>
Returns void
- Defined in core/mapviewpreferences.ts:497

touchHandlerModifyHorizontalAngleLimits

get touchHandlerModifyHorizontalAngleLimits(): Pair<number, number>
Get touch handler horizontal angle adjust limits.

Returns Pair<number, number>
- Defined in core/mapviewpreferences.ts:322
set touchHandlerModifyHorizontalAngleLimits(angles: Pair<number, number>): void
Set touch handler horizontal angle adjust limits.
Parameters
- angles: Pair<number, number>
Returns void
- Defined in core/mapviewpreferences.ts:477

touchHandlerModifyPersistent

get touchHandlerModifyPersistent(): boolean
Test whether manually adjusted follow position changes are persistent.

Returns boolean
- Defined in core/mapviewpreferences.ts:311
set touchHandlerModifyPersistent(isPersistent: boolean): void
Set manually adjusted follow position changes persistent.
Parameters
- isPersistent: boolean
Returns void
- Defined in core/mapviewpreferences.ts:467

touchHandlerModifyVerticalAngleLimits

get touchHandlerModifyVerticalAngleLimits(): Pair<number, number>
Get touch handler vertical angle adjust limits.

Returns Pair<number, number>
- Defined in core/mapviewpreferences.ts:334

viewAngle

get viewAngle(): number
Get the vertical angle.

Returns number
- Defined in core/mapviewpreferences.ts:358

zoomLevel

get zoomLevel(): number
Get a zoom level in follow position mode.

Returns number
- Defined in core/mapviewpreferences.ts:369

Methods

dispose

dispose(): void
Returns void
- Defined in core/mapviewpreferences.ts:529

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

setAccuracyCircleVisibility

setAccuracyCircleVisibility(isVisible: boolean): GemError
Set accuracy circle visibility.
Parameters
- isVisible: boolean
Returns GemError
- Defined in core/mapviewpreferences.ts:402

setCameraFocus

setCameraFocus(pos: Point): GemError
Set the follow position camera focus in viewport coordinates
Parameters
- pos: Point
Returns GemError
- Defined in core/mapviewpreferences.ts:414

setMapRotationMode

setMapRotationMode(
    mode: FollowPositionMapRotationMode,
    angle?: number,
    objectFollowMap?: boolean,
): void
Set map rotation mode in follow position.
Parameters
- mode: FollowPositionMapRotationMode
- Optionalangle: number
- OptionalobjectFollowMap: boolean
Returns void
- Defined in core/mapviewpreferences.ts:426

setPerspective

setPerspective(perspective: MapViewPerspective, animation?: GemAnimation): void
Set the map view perspective in follow position mode.
Parameters
- perspective: MapViewPerspective
- Optionalanimation: GemAnimation
Returns void
- Defined in core/mapviewpreferences.ts:439

setTouchHandlerModifyVerticalAngleLimits

setTouchHandlerModifyVerticalAngleLimits(angles: Pair<number, number>): void
Set touch handler vertical angle adjust limits.
Parameters
- angles: Pair<number, number>
Returns void
- Defined in core/mapviewpreferences.ts:487

setViewAngle

setViewAngle(viewAngle: number, animated?: boolean): void
Set vertical angle in follow position mode.
Parameters
- viewAngle: number
- animated: boolean = false
Returns void
- Defined in core/mapviewpreferences.ts:507

setZoomLevel

setZoomLevel(zoomLevel: number, duration?: number): number
Set a zoom level in follow position mode.
Parameters
- zoomLevel: number
- Optionalduration: number
Returns number
- Defined in core/mapviewpreferences.ts:515

`Static`init

init(id: number, mapId: number): FollowPositionPreferences
Parameters
- id: number
- mapId: number
Returns FollowPositionPreferences
- Defined in core/mapviewpreferences.ts:251