FORGE. BackgroundPyramidRenderer

new BackgroundPyramidRenderer(viewer, target, config)

FORGE.BackgroundPyramidRenderer BackgroundPyramidRenderer class.
Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference
target THREE.WebGLRenderTarget render target
config SceneMediaConfig media config
Source:

Extends

Members

(static) MAX_ALLOWED_TIME_SINCE_CREATION_MS :number

Max allowed time since a tile has been created before discarding it
Type:
  • number
Source:

(static) MAX_ALLOWED_TIME_SINCE_DISPLAY_MS :number

Max allowed time since a tile has been displayed before discarding it
Type:
  • number
Source:

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

cubeSize :number

Get cube size in world units.
Type:
  • number
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

displayObject :string

Get/Set background renderer displayObject.
Type:
  • string
Inherited From:
Source:

fovMin :number

Get fov min.
Type:
  • number
Source:

frustum :THREE.Frustum

Get camera frustum.
Type:
  • THREE.Frustum
Inherited From:
Source:

level :string

Get pyramid current level.
Type:
  • string
Source:

levelMax :string

Get pyramid max level.
Type:
  • string
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

pixelsAtCurrentLevel :number

Get number of pixels at current level.
Type:
  • number
Source:

pixelsAtCurrentLevelHumanReadable :string

Get number of pixels at current level presented as human readable string.
Type:
  • string
Source:

renderTarget :THREE.WebGLRenderTarget

Get background render target.
Type:
  • THREE.WebGLRenderTarget
Inherited From:
Source:

scene :THREE.Scene

Get background scene.
Type:
  • THREE.Scene
Inherited From:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

textureSize :FORGE.Size

Get texture size.
Type:
Inherited From:
Source:

textureStore :FORGE.MediaStore

Get texture store.
Type:
Source:

tilesOnAxisX :number

Get number of tiles on axis X for current level.
Type:
  • number
Source:

tilesOnAxisY :number

Get number of tiles on axis Y for current level.
Type:
  • number
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

addToRenderList(tile)

Add tile to render list
Parameters:
Name Type Description
tile FORGE.Tile tile
Source:

destroy()

Destroy sequence.
Overrides:
Source:

getParentTile(tile) → {FORGE.Tile}

Get parent tile reference and create it if does not exist
Parameters:
Name Type Description
tile FORGE.Tile tile
Source:
Returns:
parent tile or null if it has no parent (level 0)
Type
FORGE.Tile

getTile()

Get tile Lookup in cache first or create it if not already in cache
Source:

isObjectInFrustum(object)

Check if some 3D object is interesecting the rendering frustum.
Parameters:
Name Type Description
object THREE.Object3D 3D object
Inherited From:
Source:

isObjectInScene(object)

Check if some 3D object is in the scene
Parameters:
Name Type Description
object THREE.Object3D 3D object
Inherited From:
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

nbTiles()

Get number of tiles for a given level
Source:

nbTilesPerAxis(level, axis)

Get number of tiles per axis for a given level
Parameters:
Name Type Description
level number pyramid level
axis string axis ("x" or "y")
Source:

render(camera)

Render routine. Do preliminary job of specific background renderer, then summon superclass method
Parameters:
Name Type Description
camera THREE.PerspectiveCamera perspective camera
Overrides:
Source:

selectLevel(level)

Select current level for the pyramid
Parameters:
Name Type Description
level number pyramid level
Source:

setSize(size)

Update size (resolution)
Parameters:
Name Type Description
size FORGE.Size size [px]
Inherited From:
Source:

tileSize() → {FORGE.Size}

Get tile size at a given level (world units)
Source:
Returns:
size of a tile in world units
Type
FORGE.Size

update()

Update routine.
Inherited From:
Source:

updateAfterViewChange()

Update after view change
Overrides:
Source:

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
 The value you want to warn in the console.
Inherited From:
Source:

FORGE. BackgroundPyramidRenderer

Members
Methods