Class OverlayItemPosition

Overlay Item Position class

This class should not be instantiated directly.

Hierarchy

GemAutoreleaseObject
- OverlayItemPosition

Index

Constructors

Accessors

distance overlayItem pointerId

Methods

registerAutoReleaseObject init

Constructors

`Protected`constructor

new OverlayItemPosition(pointerId: number): OverlayItemPosition
Internal
Parameters
- pointerId: number
Returns OverlayItemPosition
Overrides GemAutoreleaseObject.constructor
- Defined in core/overlays.ts:815

Accessors

distance

get distance(): number
Get the distance in meters from the reference point

Returns number
The distance in meters

Throws
An exception if it fails
- Defined in core/overlays.ts:848

overlayItem

get overlayItem(): OverlayItem
Get the overlay item

Returns OverlayItem
The overlay item

Throws
An exception if it fails
- Defined in core/overlays.ts:836

pointerId

get pointerId(): number
Returns number
- Defined in core/overlays.ts:826

Methods

`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

`Static`init

init(id: number): OverlayItemPosition
Internal
Parameters
- id: number
Returns OverlayItemPosition
- Defined in core/overlays.ts:822