Class SceneLightingController

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

The SceneLightingController provides control over the main 3D scene light.

Hierarchy

SceneLightingController

Implements

ISceneLightingController

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new SceneLightingController(webAssemblyContext: TSciChart3D, sceneWorld: SCRTSceneWorld, invalidateParentCallback: () => void, options?: ISceneLightingControllerOptions): SceneLightingController

- Defined in src/Charting3D/SceneLightingController.ts
Creates an instance of SceneLightingController.

Parameters
- webAssemblyContext: TSciChart3D
  
  The SciChart 3D WebAssembly Context
- sceneWorld: SCRTSceneWorld
  
  The native 3D scene world to update
- invalidateParentCallback: () => void
  
  Callback to redraw the parent chart
  - - (): void
    - Returns void
- Optional options: ISceneLightingControllerOptions
  
  Optional lighting options
Returns SceneLightingController

Accessors

ambientLight

get ambientLight(): number
set ambientLight(value: number): void

- Defined in src/Charting3D/SceneLightingController.ts
Gets or sets the ambient light intensity.

inheritdoc

Returns number
- Defined in src/Charting3D/SceneLightingController.ts
Gets or sets the ambient light intensity.

inheritdoc

Parameters
- value: number
Returns void

lightDirection

get lightDirection(): Vector3

- Defined in src/Charting3D/SceneLightingController.ts
Gets the configured main light direction in world space.

inheritdoc

Returns Vector3

lightMode

get lightMode(): EMainLightMode
set lightMode(value: EMainLightMode): void

- Defined in src/Charting3D/SceneLightingController.ts
Gets or sets how the main scene light direction is calculated.

inheritdoc

Returns EMainLightMode
- Defined in src/Charting3D/SceneLightingController.ts
Gets or sets how the main scene light direction is calculated.

inheritdoc

Parameters
- value: EMainLightMode
Returns void

Methods

applyOptions

applyOptions(options?: ISceneLightingControllerOptions): void

- Defined in src/Charting3D/SceneLightingController.ts
Applies lighting options.

Parameters
- Optional options: ISceneLightingControllerOptions
  
  Optional lighting options
Returns void

setLightDirection

setLightDirection(lightDirection: Vector3): void

Implementation of ISceneLightingController.setLightDirection
- Defined in src/Charting3D/SceneLightingController.ts
Sets the configured main light direction in world space.

Parameters
- lightDirection: Vector3
Returns void

toJSON

toJSON(): ISceneLightingControllerOptions

Implementation of ISceneLightingController.toJSON
- Defined in src/Charting3D/SceneLightingController.ts
Convert the object to a definition that can be serialized to JSON, or used directly with the builder api.

Returns ISceneLightingControllerOptions

Generated using TypeDoc