Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapData

Hierarchy

  • AbstractTreeNodeData
    • MapData

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new MapData(image: ArrayBuffer | HTMLImageElement, properties?: { asData?: boolean; blob?: Blob; center?: vec2; color?: Color; data?: number[]; flipY?: boolean; magFilter?: TEXTURE_FILTERING; minFilter?: TEXTURE_FILTERING; offset?: vec2; repeat?: vec2; rotation?: number; texCoord?: number; wrapS?: TEXTURE_WRAPPING; wrapT?: TEXTURE_WRAPPING }, id?: string, version?: string): MapData

  • Parameters

    • image: ArrayBuffer | HTMLImageElement
    • Optional properties: { asData?: boolean; blob?: Blob; center?: vec2; color?: Color; data?: number[]; flipY?: boolean; magFilter?: TEXTURE_FILTERING; minFilter?: TEXTURE_FILTERING; offset?: vec2; repeat?: vec2; rotation?: number; texCoord?: number; wrapS?: TEXTURE_WRAPPING; wrapT?: TEXTURE_WRAPPING }
      • Optional asData?: boolean
      • Optional blob?: Blob
      • Optional center?: vec2
      • Optional color?: Color
      • Optional data?: number[]
      • Optional flipY?: boolean
      • Optional magFilter?: TEXTURE_FILTERING
      • Optional minFilter?: TEXTURE_FILTERING
      • Optional offset?: vec2
      • Optional repeat?: vec2
      • Optional rotation?: number
      • Optional texCoord?: number
      • Optional wrapS?: TEXTURE_WRAPPING
      • Optional wrapT?: TEXTURE_WRAPPING
    • Optional id: string
    • Optional version: string

    Returns MapData

Accessors

asData

  • get asData(): boolean
  • set asData(value: boolean): void

blob

  • get blob(): undefined | Blob
  • set blob(value: undefined | Blob): void

  • Returns undefined | Blob

  • Parameters

    • value: undefined | Blob

    Returns void

center

  • get center(): vec2
  • set center(value: vec2): void

color

  • get color(): undefined | Color
  • set color(value: undefined | Color): void

  • Returns undefined | Color

  • Parameters

    • value: undefined | Color

    Returns void

convertedObject

  • get convertedObject(): {}
  • set convertedObject(value: {}): void

  • The converted object of the tree node.

    Returns {}

    • [key: string]: unknown

  • The converted object of the tree node.

    Parameters

    • value: {}
      • [key: string]: unknown

    Returns void

data

  • get data(): undefined | number[]
  • set data(value: undefined | number[]): void

  • Returns undefined | number[]

  • Parameters

    • value: undefined | number[]

    Returns void

flipY

  • get flipY(): boolean
  • set flipY(value: boolean): void

id

  • get id(): string

  • The ID of the tree node data.

    Returns string

image

  • get image(): ArrayBuffer | HTMLImageElement
  • set image(value: ArrayBuffer | HTMLImageElement): void

  • Returns ArrayBuffer | HTMLImageElement

  • Parameters

    • value: ArrayBuffer | HTMLImageElement

    Returns void

magFilter

minFilter

offset

  • get offset(): vec2
  • set offset(value: vec2): void

repeat

  • get repeat(): vec2
  • set repeat(value: vec2): void

rotation

  • get rotation(): number
  • set rotation(value: number): void

texCoord

  • get texCoord(): undefined | number
  • set texCoord(value: undefined | number): void

updateCallback

  • get updateCallback(): null | ((newVersion: string, oldVersion: string) => void)
  • set updateCallback(value: null | ((newVersion: string, oldVersion: string) => void)): void

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Returns null | ((newVersion: string, oldVersion: string) => void)

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Parameters

    • value: null | ((newVersion: string, oldVersion: string) => void)

    Returns void

updateCallbackConvertedObject

  • get updateCallbackConvertedObject(): null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)
  • set updateCallbackConvertedObject(value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)): void

  • The update callback for the converted object of the tree node.

    Returns null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

  • The update callback for the converted object of the tree node.

    Parameters

    • value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

    Returns void

version

  • get version(): string

  • The version of the tree node data. If the version changes, the node data will be marked for an update. A version change can be triggered via updateVersion.

    Returns string

wrapS

wrapT

Methods

clone

  • Clones this node tree data.

    Returns IMapData

updateVersion

  • updateVersion(): void

  • Update the version

    Returns void