API Docs for: 1.0.2
Show:

GIScene.Layer.Helper Class

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

A Helper Layer has a property isTangible = false. This helps to determine objects which shouldn't be reflected in ray intersections, e.g. during visibility analysis.

Constructor

GIScene.Layer.Helper

(
  • name
  • [config]
)

Defined in GIScene\Layer\Helper.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

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

removeStyle

(
  • style
)

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

remove an existing style from the layers style list

Parameters:

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:

setOpacity

(
  • opacity
)

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

Sets the opacity value for the whole layer

Parameters:

  • opacity Number

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