API Docs for: 1.0.2
Show:

GIScene.Scene Class

Extends THREE.EventDispatcher
Defined in: GIScene\Scene.js:1
Module: GIScene

The Scene Object

Constructor

GIScene.Scene

(
  • containerDivId
  • [config]
)

Defined in GIScene\Scene.js:1

Parameters:

  • containerDivId String

    The id of an HTMLDivElement which will be used as container for the webgl canvas.

  • [config] Object optional

    Allowed values for config are:

    cameratype: 'perspective'|'ortho'

    near: {Number} far: {Numver} fov: {Number}

    width: {Integer} height: {Integer}

    animate:{Boolean}

    center: {THREE.Vector3} positionFromCenter: {THREE.Vector3} projection: {String} units: {String} offset: {GIScene.Coordinate3} skyColor: {THREE.Color} fog: {THREE.Fog}

Methods

addControl

()

Defined in GIScene\Scene.js:502

Adds a control to the scene

addEventListener

(
  • eventType
  • listener
)

Defined in GIScene\Scene.js:1347

inherited from THREE.EventDispatcher

Parameters:

  • eventType String
  • listener Function

    function, to be called when the event is dispatched

addLayer

()

Defined in GIScene\Scene.js:531

Adds a layer to the scene

dispatchEvent

(
  • event
)

Defined in GIScene\Scene.js:1374

inherited from THREE.EventDispatcher

Parameters:

  • event Object

Example:

this.dispatchEvent( { type: 'beforeRender', content: anythingToBePassedToTheListeners } );

disposeLayer

(
  • layer
)

Defined in GIScene\Scene.js:571

Deletes all layer objects and the layer from memory

Parameters:

getLayerById

(
  • id
)
GIScene.Layer

Defined in GIScene\Scene.js:1205

Parameters:

  • id String

Returns:

GIScene.Layer:

result returns the layer found by id or null

getLayerDescendants

(
  • filter
)

Defined in GIScene\Scene.js:1177

get all descendants of the layers. Optionally the layers can be filtered by an array filter function.

Parameters:

  • filter Function

    An array filter function that is applied to each layer object of the scene. Should return true or false.

Example:

//get only descendants of layers that are not Helper Layers
scene.getLayerDescendants(function(e,i,a){
    return !(e instanceof GIScene.Layer.Helper);
    }
);

getObjectsBy

(
  • callback
)
Array

Defined in GIScene\Scene.js:1336

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

Parameters:

  • callback Function

Returns:

Array:

matches

hasEventListener

(
  • eventType
  • listener
)

Defined in GIScene\Scene.js:1356

inherited from THREE.EventDispatcher

Parameters:

  • eventType String
  • listener Function

    function, to be removed from the event

removeControl

()

Defined in GIScene\Scene.js:514

Removes a control from the scene

removeEventListener

(
  • eventType
  • listener
)

Defined in GIScene\Scene.js:1365

inherited from THREE.EventDispatcher

Parameters:

  • eventType String
  • listener Function

    function, to be removed from the event

removeLayer

()

Defined in GIScene\Scene.js:546

Removes a layer from the scene

setCenter

(
  • vector
  • positionFromCenter
  • duration
)

Defined in GIScene\Scene.js:363

Jump to another place in the scene.

Parameters:

  • vector THREE.Vector3

    vector in scene coordinates

  • positionFromCenter THREE.Vector3

    vector to place the camera at some distance from the point of interest (vector)

  • duration Number

    duration in milliseconds. if undefined or > 0 an animation is perforemed from the current to the specified new center. Set this to 0 to jump immediately to the new location.

setFaceCulling

(
  • faceCullingMode
)

Defined in GIScene\Scene.js:828

Sets the face culling mode for the whole scene

Parameters:

  • faceCullingMode THREE.FrontSide | | THREE.BackSide | | THREE.DoubleSide | | 'default'

setShading

(
  • shadingMode
)

Defined in GIScene\Scene.js:1061

Sets the shading mode for the whole scene

Parameters:

  • shadingMode THREE.FlatShading | | THREE.SmoothShading | | 'default'

setTexturing

(
  • texturingMode
)

Defined in GIScene\Scene.js:753

Sets texturing of on or off for the whole scene

Parameters:

  • texturingMode Mixed

    can be: {String} 'default' | {boolean} true | {boolean} false

setVertexColors

(
  • vertexColorMode
)

Defined in GIScene\Scene.js:911

Sets the vertex color mode for the whole scene

Parameters:

  • vertexColorMode THREE.NoColors | | THREE.FaceColors | | THREE.VertexColors | | 'default'

setWireframe

(
  • wireframeMode
)

Defined in GIScene\Scene.js:684

Set the wireframe property for the whole scene

Parameters:

  • wireframeMode Mixed

    can be {String} 'default' | {boolean} true | {boolean} false

startAnimation

()

Defined in GIScene\Scene.js:268

Start animation frame and render loop

stopAnimation

()

Defined in GIScene\Scene.js:312

Stop animation frame and render loop

viewFrom

(
  • relativePosition
)

Defined in GIScene\Scene.js:467

Function to move camera to predefined relative positions from Scene.center

Parameters:

  • relativePosition String

    allowed values are 'left','right','front','back','top','bottom'

Properties

camera

THREE.CombinedCamera

Defined in GIScene\Scene.js:104

The active camera. {THREE.CombinedCamera} can be switched from perspective to orthographic and vice versa

config

Object

Defined in GIScene\Scene.js:72

The config which is used to initialize the Scene. Merged from defaults and passed config Object.

defaults

Object private

Defined in GIScene\Scene.js:33

The default config which is used when no config object is provided.

root

THREE.Scene

Defined in GIScene\Scene.js:98

The scenegraph root node. Add {THREE.Object3D}-objects to this node. See THREE.js docs for further information

Events

addlayer

Defined in GIScene\Scene.js:540

beforeRender

Defined in GIScene\Scene.js:281

beforeRender Event will be executed directly before the render call in the render loop

beforeRender

Defined in GIScene\Scene.js:288

beforeRender2 Event will be executed directly before the render call in the render loop

cameraChange

Defined in GIScene\Scene.js:177

Fires whenever camera position changes

center

Defined in GIScene\Scene.js:412

Fires after setCenter() completed

center

Defined in GIScene\Scene.js:438

Fires after setCenter() completed

removelayer

Defined in GIScene\Scene.js:552

removelayer

Defined in GIScene\Scene.js:565