Interface PanoramaTileSetStructure

Describes the tileset structure of a panorama

Since

2020.1

Hierarchy

  • PanoramaTileSetStructure

Properties

imageDataFractionX imageDataFractionY level0Columns level0Rows levelCount

Methods

getTileColumnCount getTileHeight getTileRowCount getTileWidth

Properties

imageDataFractionX

imageDataFractionX: number

A number indicating what fraction of a level contains image data in the x direction. Some data sets contain levels and tiles where the image data does not span the entire range. The default value is 1, meaning all pixels contain image data and no tiles are left out.

imageDataFractionY

imageDataFractionY: number

A number indicating what fraction of a level contains image data in the y direction. Some data sets contain levels and tiles where the image data does not span the entire range. The default value is 1, meaning all pixels contain image data and no tiles are left out.

level0Columns

level0Columns: number

The number of tile columns at the coarsest level. The default value is 1.

level0Rows

level0Rows: number

The number of tile rows at the coarsest level, the default value is 1.

levelCount

levelCount: number

The number of tile levels contained in this tileset

Methods

getTileColumnCount

  • Returns the number of columns in the panorama tile grid at the given level. Each level should have twice the number of rows of the previous one.

    Parameters

    • level: number

      the level to be queried

    Returns null | number

    the number of tile columns on the specified level. Null if level falls outside of the valid range of levels ([0, levelCount[) for this tileset.

getTileHeight

  • The height of each individual tile in pixels, at a given level. Within a single level, all tiles have the same width and height.

    Parameters

    • level: number

      The level for which to determine the tile height in pixels.

    Returns null | number

    the number of tile rows on the specified level. Null if level falls outside of the valid range of levels ([0, levelCount[) for this tileset.

getTileRowCount

  • Returns the number of rows in the panorama tile grid at the given level.

    Each level should have twice the number of rows of the previous one.

    Parameters

    • level: number

      the level to be queried

    Returns null | number

    the number of tile rows on the specified level. Null if level falls outside of the valid range of levels ([0, levelCount[) for this tileset.

getTileWidth

  • The width of each individual tile in pixels, at a given level. Within a single level, all tiles have the same width and height.

    Parameters

    • level: number

    Returns null | number

    the width of tile rows on the specified level. Null if level falls outside of the valid range of levels ([0, levelCount[) for this tileset.

Settings

Member Visibility

Theme