FORGE. Tile

new Tile(parentnullable, renderer, x, y, level, face, creator)

Tile class.
Parameters:
Name Type Attributes Description
parent FORGE.Tile <nullable>
 parent tile reference
renderer FORGE.BackgroundPyramidRenderer renderer reference
x number x coordinate (column)
y number y coordinate (row)
level number pyramid level
face string cube face
creator string string describing what created the tile
Source:

Extends

  • THREE.Mesh

Members

(static) FACE_NEXT :CubeFaceObject

Table describing next cube face
Type:
  • CubeFaceObject
Source:

(static) FACE_PREVIOUS :CubeFaceObject

Table describing previous cube face
Type:
  • CubeFaceObject
Source:

(static) FACES :Array

Cube faces table
Type:
  • Array
Source:

(static) OPACITY_DECREMENT :number

Opacity decrement [unit per render cycle]
Type:
  • number
Source:

(static) OPACITY_INCREMENT :number

Opacity increment [unit per render cycle]
Type:
  • number
Source:

(static) PREVIEW :number

Preview tile
Type:
  • number
Source:

(static) TEXTURE_LOADING_PREDELAY_MS :number

Texture load predelay (time between creation and display)
Type:
  • number
Source:

_creator :string

String describing what created the tile
Type:
  • string
Source:

createTS :number

Create timestamp.
Type:
  • number
Source:

displayTS :number

Last display timestamp.
Type:
  • number
Source:

face :string

Get face.
Type:
  • string
Source:

level :string

Get level.
Type:
  • string
Source:

neighbours :Array.<FORGE.Tile>

Neighbour tiles.
Type:
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher.
Type:
Source:

opacity :number

Get opacity.
Type:
  • number
Source:

textureIsSet :boolean

Is the texture set
Type:
  • boolean
Source:

x :number

Get x coordinate.
Type:
  • number
Source:

y :number

Get y coordinate.
Type:
  • number
Source:

Methods

_onChildTileDestroyed()

Child tile destroy event handler
Source:

_onNeighbourTileDestroyed()

Neighbour tile destroy event handler
Source:

_onParentTileDestroyed()

Parent tile destroy event handler
Source:

createName(face, level, x, y)

Create tile name
Parameters:
Name Type Description
face string | number cube face
level number pyramid level
x number x coordinate (column)
y number y coordinate (row)
Source:

destroy()

Destroy sequence
Source:

getParentName() → (nullable) {string}

Get name of the parent tile
Source:
Returns:
parent tile name
Type
string

getParentTileCoordinates(tile) → {THREE.Vector2}

Get the coordinates of the parent tile
Parameters:
Name Type Description
tile FORGE.Tile tile
Source:
Returns:
parent tile x,y coordinates
Type
THREE.Vector2

refreshDisplayTS()

Refresh display timestamp with current date
Source:

FORGE. Tile

Members
Methods