API Docs for: 1.0.2
Show:

GIScene.Layer.Grid Class

Extends GIScene.Layer
Defined in: GIScene\Layer\Grid.js:1
Module: GIScene

Constructor

GIScene.Layer.Grid

(
  • name
  • [config]
)

Defined in GIScene\Layer\Grid.js:1

Parameters:

  • name String

    the layer name for display purposes

  • [config] Object optional

    the layer configuration object

Methods

addStyle

(
  • style
)

Inherited from GIScene.Layer: GIScene\Layer.js:180

add a style to the layers styles list

Parameters:

disposeStyle

(
  • style
)

Inherited from GIScene.Layer: GIScene\Layer.js:211

remove style, its material and textures from memory

Parameters:

getAttributeNames

() Array(String)

Inherited from GIScene.Layer: GIScene\Layer.js:515

Returns:

Array(String): attributeNames

getNewTilesFromQuadtree

() Array of GIScene.Grid.Index

Defined in GIScene\Layer\Grid.js:363

computes the visible tiles of the current camera view

Returns:

Array of GIScene.Grid.Index:

newTiles

getObjectsBy

(
  • callback
)
Array

Inherited from GIScene.Layer: GIScene\Layer.js:307

get Objects by a evaluation function which recursively tries to match the objects of the layer

Parameters:

  • callback Function

Returns:

Array: matches

getOutlineTiles

(
  • polygon
)
private

Defined in GIScene\Layer\Grid.js:743

Parameters:

  • polygon Array of THREE.Vector3

loadTile

(
  • gridIndex
)

Defined in GIScene\Layer\Grid.js:125

Loads a tile by specifiying a GIScene.Grid.Index

Parameters:

loadTiles

(
  • tileArray
)

Defined in GIScene\Layer\Grid.js:301

loads several tiles by specifying an array of GIScene.Grid.Index objects

Parameters:

  • tileArray Array of GIScene.Grid.Index

removeStyle

(
  • style
)

Inherited from GIScene.Layer: GIScene\Layer.js:193

remove an existing style from the layers style list

Parameters:

removeTile

(
  • gridIndex
)

Defined in GIScene\Layer\Grid.js:313

Removes a tile or aborts its loading by specifiying a GIScene.Grid.Index

Parameters:

removeTiles

(
  • tileArray
)

Defined in GIScene\Layer\Grid.js:351

removes or aborts the loading of several tiles by specifying an array of GIScene.Grid.Index objects

Parameters:

  • tileArray Array of GIScene.Grid.Index

selectByAttributes

(
  • attributeName
  • operator
  • value
  • selectMode
)

Inherited from GIScene.Layer: GIScene\Layer.js:318

set or modify the current layer selection by attribute query

Parameters:

  • attributeName String
    must be available in object.userData.gisceneAttributes
  • operator String
    defines how to compare the given values with the object attributes
  • value Mixed
    the values for the selection criteria
  • selectMode String
    can be new,add,sub,intersect

Example:

{
    "attributeName" : "attr_id",
    "operator"      : "IN", //"==","!=" .... TODO
    "value"         : [2393,1234],
    "selectMode"    : "new"
}

setActiveStyle

(
  • style
)

Inherited from GIScene.Layer: GIScene\Layer.js:543

apply a style to the layer

Parameters:

setMaxExtent

(
  • maxExtent2
)

Defined in GIScene\Layer\Grid.js:1350

set the max extent of the layer to restrict loading of tiles to a rectangle/bounding box

Parameters:

  • maxExtent2 GIScene.Extent2

    a 2D bounding box in coordinate reference system (CRS) units

setOpacity

(
  • opacity
)

Inherited from GIScene.Layer: GIScene\Layer.js:126

Sets the opacity value for the whole layer

Parameters:

  • opacity Number

setTerrainHeight

(
  • height
)

Defined in GIScene\Layer\Grid.js:1339

set an approximate terrain height at which the view frustrum will be cut horizontally to determine the visible tiles to be loaded

Parameters:

  • height Number

    the terrain height in coordinate reference system (CRS) units (e.g. meters)

setVisibility

(
  • visibility
)

Defined in GIScene\Layer\Grid.js:1372

switches the visibility of the layer on or off

Parameters:

  • visibility Boolean

startUpdate

()

Defined in GIScene\Layer\Grid.js:95

Starts the automatic loading and removing of tiles dependant on the camera perspective

stopUpdate

()

Defined in GIScene\Layer\Grid.js:102

Stops the automatic loading and removing of tiles dependent on the camera perspective

update

()

Defined in GIScene\Layer\Grid.js:1151

updates the current tiles, loads new tiles and removes old ones

Events

addStyle

Inherited from GIScene.Layer: GIScene\Layer.js:187

afterSetOverrideMaterial

Inherited from GIScene.Layer: GIScene\Layer.js:473

beforeSetOverrideMaterial

Inherited from GIScene.Layer: GIScene\Layer.js:424

changedvisibility listener function will get the following event object as argument

Inherited from GIScene.Layer: GIScene\Layer.js:497

Example:

eventObject = {
                        content:{
                            layer:{GIScene.Layer}, 
                            visibility:{Boolean}
                        }
                    }

removeStyle

Inherited from GIScene.Layer: GIScene\Layer.js:203

setActiveStyle

Inherited from GIScene.Layer: GIScene\Layer.js:587

setScene

Inherited from GIScene.Layer: GIScene\Layer.js:116

tileadd

Defined in GIScene\Layer\Grid.js:187

Fires after a tile is added to the scene. A reference to the tile can be found at event.content.tile

tileload

Defined in GIScene\Layer\Grid.js:240

Fires after a tile is loaded. A reference to the tile can be found at event.content.tile

tileremove

Defined in GIScene\Layer\Grid.js:340

Fires after a tile is removed from the scene. A reference to the tile can be found at event.content.tile