@magiclane/maps-sdk
    Preparing search index...

    Class ImgBaseAbstract

    Base class for images

    Represents the image in an abstract way, providing metadata and access to the RenderableImg.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _pointerId

    Accessors

    imageType isValid pointerId uid

    Methods

    getRenderableImage getRenderableImageBytes registerAutoReleaseObject

    Constructors

    • Parameters

      • pointerId: number = -1

      Returns ImgBase

    Properties

    Protected_pointerId

    _pointerId: number

    Accessors

    • get isValid(): boolean

      Check if the image is valid

      Returns boolean

      True if the image is valid, false otherwise

    • get pointerId(): number

      Returns number

    • get uid(): number

      Get the image unique ID

      Returns number

      The image ID

    Methods

    • Get the image as a RenderableImg

      Parameters

      • Optionalsize: { height: number; width: number }

        The optional size as { width, height }

      • Optionalformat: ImageFileFormat

        The image format (default: png)

      Returns RenderableImg | undefined

      The renderable image or undefined if not valid

    • Get the image data as a Uint8Array

      Parameters

      • Optionalsize: { height: number; width: number }

        The optional size as { width, height }

      • format: ImageFileFormat = ImageFileFormat.png

        The image format (default: png)

      Returns Uint8Array<ArrayBufferLike> | undefined

      The image data or undefined if not valid

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods