API Docs for: 1.0.2
Show:

GIScene.Control.Compass Class

Extends GIScene.Control
Defined in: GIScene\Control\Compass.js:1
Module: GIScene

The Compass Control provides a graphical information on the current camera orientation, like a compass.

Constructor

GIScene.Control.Compass

(
  • camera
)

Defined in GIScene\Control\Compass.js:1

Parameters:

  • camera THREE.Camera

Methods

activate

()

Inherited from GIScene.Control but overwritten in GIScene\Control\Compass.js:85

Activates this Control

deactivate

()

Inherited from GIScene.Control but overwritten in GIScene\Control\Compass.js:107

Deactivates this Control

getCompassDegrees

() Number

Defined in GIScene\Control\Compass.js:69

Get Compass direction in degrees

Returns:

Number:

heading of compass in degrees

setScene

(
  • scene
)

Inherited from GIScene.Control: GIScene\Control.js:30

Sets the scene property. This is automatically called on scene.addControl()

Parameters:

  • scene Object

Properties

config

Object

Defined in GIScene\Control\Compass.js:20

The config which is used to initialize the Compass-Control. Merged from defaults and passed config Object.

isActive

Boolean

Inherited from GIScene.Control: GIScene\Control.js:17