API / geotoolkit3d / scene / compass / Compass / Compass
A 3D compass.<br> <br> This class adds a canvas in the given HTML element that will be used to render a 3D compass shape.<br> <br> The compass will rotate the camera to look at the compass shape in the same direction that the parent plot is looking.<br> The compass shape itself can be static.<br>
Constructors
- [new Compass(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.compass.compass.compass.md#new compass(options))
Methods
▸ getClassName(): string
string
▸ getCompassObject(): Object3D<Object3DEventMap>
Return the compass shape
Object3D<Object3DEventMap>
The compass shape
▸ setCompassObject(newObject): Compass
Sets the compass shape
| Name | Type | Description |
|---|---|---|
newObject | Object3D<Object3DEventMap> | The new compass shape |
this
▸ Static getClassName(): string
string