Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tile3D

A Tile3DHeader represents a tile as Tileset3D. When a tile is first created, its content is not loaded; the content is loaded on-demand when needed based on the view. Do not construct this directly, instead access tiles through {@link Tileset3D#tileVisible}.

Hierarchy

  • Tile3D

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • constructs

    Create a TileHeader instance

    Parameters

    • tileset: Tileset3D

      Tileset3D instance

    • header: TilesetJSONNode

      tile header - JSON loaded from a dataset

    • Optional parent: Tile3D

      parent TileHeader instance

    Returns Tile3D

Properties

boundingVolume

boundingVolume: TileOrientedBoundingBox

Optional cacheNode

cacheNode?: TileCacheNode<Tile3D>

centerZDepth

centerZDepth: number

children

children: Tile3D[]

computedTransform

computedTransform: Matrix4

Optional content

content?: TileContent

contentState

contentState: "UNLOADED" | "LOADING" | "PROCESSING" | "READY" | "FAILED"

depth

depth: number

distanceToCamera

distanceToCamera: number

frameNumber

frameNumber: number

header

header: TilesetJSONNode

Optional parent

parent?: Tile3D

requestedFrameNumber

requestedFrameNumber: number

screenSpaceError

screenSpaceError: number

selectedFrameNumber

selectedFrameNumber: number

selectionDepth

selectionDepth: number

shouldRefine

shouldRefine: boolean

tileset

tileset: Tileset3D

touchedFrameNumber

touchedFrameNumber: number

transform

transform: Matrix4

visibilityPlaneMask

visibilityPlaneMask: number

visible

visible: boolean

Accessors

contentAvailable

  • get contentAvailable(): boolean

  • Determines if the tile has available content to render. true if the tile's content is ready or if it has expired content this renders while new content loads; otherwise,

    Returns boolean

contentFailed

  • get contentFailed(): boolean

  • Returns boolean

contentReady

  • get contentReady(): boolean

  • Determines if the tile's content is ready. This is automatically true for tiles with empty content.

    Returns boolean

contentUnloaded

  • get contentUnloaded(): boolean

  • Determines if the tile's content has not be requested. true if tile's content has not be requested; otherwise, false.

    Returns boolean

contentUrl

  • get contentUrl(): string

  • Returns string

hasChildren

  • get hasChildren(): boolean

  • Returns true if tile has children

    Returns boolean

hasEmptyContent

  • get hasEmptyContent(): boolean

  • Returns boolean

hasRenderContent

  • get hasRenderContent(): boolean

  • Returns true if tile is not an empty tile and not an external tileset

    Returns boolean

hasUnloadedContent

  • get hasUnloadedContent(): boolean

  • Returns true if tile has renderable content but it's unloaded

    Returns boolean

id

  • get id(): string

  • Returns string

lodMetricType

  • get lodMetricType(): "geometricError"

  • Returns "geometricError"

lodMetricValue

  • get lodMetricValue(): number

  • Returns number

refine

  • get refine(): "REPLACE" | "ADD"

  • Returns "REPLACE" | "ADD"

selected

  • get selected(): boolean

  • Returns boolean

siblingIndex

  • get siblingIndex(): number

  • Returns number

type

  • get type(): "EMPTY" | "SCENEGRAPH" | "MESH"

  • Returns "EMPTY" | "SCENEGRAPH" | "MESH"

Methods

getScreenSpaceError

  • getScreenSpaceError(frameState: TileFrameState, useParentLodMetric: boolean): number

  • Get the tile's screen space error.

    Parameters

    Returns number

loadContent

  • loadContent(): Promise<boolean>

  • Requests the tile's content. The request may not be made if the Request Scheduler can't prioritize it.

    Returns Promise<boolean>

unloadContent

  • unloadContent(): void

  • Returns void

updateVisibility

  • Update the tile's visibility

    Parameters

    Returns void