Class: G3XBacklightManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/G3XBacklightManager.ts:16
A manager for G3X Touch backlight levels. The manager calculates backlight levels for a single GDU based on the
user-selected backlight mode and publishes the values to a standard G3X backlight level SimVar
(L:WTG3X_Screen_Backlight:[index]
where [index]
is the GDU index).
Constructors
Constructor
new G3XBacklightManager(
gduIndex
,bus
,settingManager
,config
):G3XBacklightManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/G3XBacklightManager.ts:44
Creates a new instance of G3XBacklightManager. The manager is initialized as asleep.
Parameters
Parameter | Type | Description |
---|---|---|
gduIndex | number | The index of this manager's parent GDU. |
bus | EventBus | The event bus. |
settingManager | UserSettingManager <BacklightUserSettingTypes > | A manager for backlight user settings. |
config | BacklightConfig | The backlight configuration object. |
Returns
G3XBacklightManager
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/G3XBacklightManager.ts:175
Destroys this manager. Once this manager is destroyed, it will no longer publish backlight levels, and cannot be awakened or put to sleep.
Returns
void
sleep()
sleep():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/G3XBacklightManager.ts:109
Puts this manager to sleep. When this manager is asleep, it stops publishing backlight levels.
Returns
void
Throws
Error if this manager has been destroyed.
wake()
wake():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/G3XBacklightManager.ts:89
Wakes this manager. When this manager is awake, it publishes backlight levels for its GDU to the appropriate
SimVar (L:WTG3X_Screen_Backlight:[index]
where [index]
is the GDU index).
Returns
void
Throws
Error if this manager has been destroyed.