4.8 KiB
description |
---|
Reference documentation of the WWTControl class. |
The WWTControl object holds the state of the WWT WebGL engine in a given webpage. It is a singleton that can be obtained with:
var wwt_ctl = wwtlib.WWTControl.singleton;
However, operations on the control are unlikely to succeed until it is initialized by waiting for the ready event to be fired from the control’s paired singleton instance of the ScriptInterface class after calling the initControlParam function.
Note that the code examples below will not run on their own; more scaffolding is needed. Live samples are collected on the WebGL Engine Examples page and cross-linked below.
| Native Property | Type | Description | | :-- | | constellation | string | TBC. | | fader | BlendState | TBC. | | layers | TBC. | TBC. | | renderType | int | Enumeration? | | sandboxMode | bool | TBC. | | tour | TBC. | TBC. | | tourEdit | TBC. | TBC. | | uiController | TBC. |
| Get/Set Property | Type | Description | | :-- | | renderNeeded | bool | TBC. |
| Static Function | Description | | :-- | | go | TBC | | initControl | TBC | | initControlParam | TBC | | setBackgroundImageName | TBC | | setForegroundImageName | TBC | | showExplorerUI | TBC | | showFolderUI | TBC | | showLayers | TBC | | useUserLocation | TBC |
constellation Property
Not documented :-(
fader Property
Not documented :-(
layers Property
Not documented :-(
renderType Property
Not documented :-(
sandboxMode Property
Not documented :-(
tour Property
Not documented :-(
tourEdit Property
Not documented :-(
uiController Property
Not documented :-(
renderNeeded Property
Not documented :-( Note: get/set style.
go function
Not documented :-(
initControl function
Not documented :-(
initControlParam function
Not documented :-(
setBackgroundImageName function
Not documented :-(
setForegroundImageName function
Not documented :-(
showExplorerUI function
Not documented :-(
showFolderUI function
Not documented :-(
showLayers function
Not documented :-(
useUserLocation function
Not documented :-(