Class LightOptions

public shape of the accessors this class declares itself

Hierarchy (View Summary)

Accessors
BaseNative<any, LightOptionsOptions>
Accessors
Omit<Methods, "setSunPositionFromTime">
- LightOptions

Constructors

constructor

new LightOptions(options?: LightOptionsOptions, native?: any): LightOptions
Parameters
- Optionaloptions: LightOptionsOptions
- Optionalnative: any
Returns LightOptions
Inherited from BaseNative.constructor
- Defined in packages/ui-massifmaps/index.d.ts:18

Properties

ambientIntensity

ambientIntensity: number

duringInit

duringInit: boolean

native

native: any

options

options: LightOptionsOptions

shadowBias

shadowBias: number

shadowCascades

shadowCascades: number

shadowCasterMargin

shadowCasterMargin: number

shadowDistance

shadowDistance: number

shadowMapSize

shadowMapSize: number

shadowNormalOffset

shadowNormalOffset: number

shadowSoftness

shadowSoftness: number

shadowStrength

shadowStrength: number

sunAltitude

sunAltitude: number

sunAzimuth

sunAzimuth: number

sunColor

sunColor: string | Color

sunIntensity

sunIntensity: number

terrainLightingEnabled

terrainLightingEnabled: boolean

Methods

dispose

dispose(): any
Returns any
Inherited from BaseNative.dispose
- Defined in packages/ui-massifmaps/index.d.ts:21

getAmbientIntensity

getAmbientIntensity(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:6

getNative

getNative(): any
Returns any
Inherited from BaseNative.getNative
- Defined in packages/ui-massifmaps/index.d.ts:20

getShadowBias

getShadowBias(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:7

getShadowCascades

getShadowCascades(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:8

getShadowCasterMargin

getShadowCasterMargin(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:9

getShadowDistance

getShadowDistance(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:10

getShadowMapSize

getShadowMapSize(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:11

getShadowNormalOffset

getShadowNormalOffset(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:12

getShadowSoftness

getShadowSoftness(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:13

getShadowStrength

getShadowStrength(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:14

getSunAltitude

getSunAltitude(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:15

getSunAzimuth

getSunAzimuth(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:16

getSunColor

getSunColor(): Color
Returns Color
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:17

getSunIntensity

getSunIntensity(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:18

initNativeView

initNativeView(native: any, options: LightOptionsOptions): void
Parameters
- native: any
- options: LightOptionsOptions
Returns void
Inherited from BaseNative.initNativeView
- Defined in packages/ui-massifmaps/index.d.ts:19

isTerrainLightingEnabled

isTerrainLightingEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:19

setAmbientIntensity

setAmbientIntensity(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:20

setShadowBias

setShadowBias(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:21

setShadowCascades

setShadowCascades(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:22

setShadowCasterMargin

setShadowCasterMargin(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:23

setShadowDistance

setShadowDistance(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:24

setShadowMapSize

setShadowMapSize(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:25

setShadowNormalOffset

setShadowNormalOffset(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:26

setShadowSoftness

setShadowSoftness(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:27

setShadowStrength

setShadowStrength(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:28

setSunAltitude

setSunAltitude(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:29

setSunAzimuth

setSunAzimuth(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:30

setSunColor

setSunColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:31

setSunIntensity

setSunIntensity(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:32

setSunPositionFromTime

setSunPositionFromTime(
    year: number,
    month: number,
    day: number,
    hour: number,
    minute: number,
    latitude: number,
    longitude: number,
): void
month 1-12, day 1-31, hour 0-23 - drives sun altitude/azimuth and the shadows
Parameters
- year: number
- month: number
- day: number
- hour: number
- minute: number
- latitude: number
- longitude: number
Returns void
- Defined in packages/ui-massifmaps/components/index.d.ts:92

setTerrainLightingEnabled

setTerrainLightingEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/LightOptions.d.ts:34

Class LightOptions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LightOptions

Properties

ambientIntensity

duringInit

native

options

shadowBias

shadowCascades

shadowCasterMargin

shadowDistance

shadowMapSize

shadowNormalOffset

shadowSoftness

shadowStrength

sunAltitude

sunAzimuth

sunColor

sunIntensity

terrainLightingEnabled

Methods

dispose

Returns any

getAmbientIntensity

Returns number

getNative

Returns any

getShadowBias

Returns number

getShadowCascades

Returns number

getShadowCasterMargin

Returns number

getShadowDistance

Returns number

getShadowMapSize

Returns number

getShadowNormalOffset

Returns number

getShadowSoftness

Returns number

getShadowStrength

Returns number

getSunAltitude

Returns number

getSunAzimuth

Returns number

getSunColor

Returns Color

getSunIntensity

Returns number

initNativeView

Parameters

Returns void

isTerrainLightingEnabled

Returns boolean

setAmbientIntensity

Parameters

Returns void

setShadowBias

Parameters

Returns void

setShadowCascades

Parameters

Returns void

setShadowCasterMargin

Parameters

Returns void

setShadowDistance

Parameters

Returns void

setShadowMapSize