Appearance

@fibbojs / 3d / FLightProbe

Class: FLightProbe ​

A light probe in 3d space. Unlike other lights, light probes do not emit light. Instead they store information about light passing through 3D space. During rendering, the light that hits a 3D object is approximated by using the data from the light probe.

Extends ​

Accessors ​

color ​

get color(): Color

set color(color): void

Parameters ​

• color: ColorRepresentation

Returns ​

Color

Inherited from ​

FLight.color

Defined in ​

3d/src/lights/FLight.ts:115

intensity ​

get intensity(): number

set intensity(intensity): void

Parameters ​

• intensity: number

Returns ​

number

Inherited from ​

FLight.intensity

Defined in ​

3d/src/lights/FLight.ts:123

lookAt ​

get lookAt(): undefined | FVector3

set lookAt(lookAt): void

Parameters ​

• lookAt: FVector3

Returns ​

undefined | FVector3

Inherited from ​

FLight.lookAt

Defined in ​

3d/src/lights/FLight.ts:131

Constructors ​

new FLightProbe() ​

new FLightProbe(scene, options?): FLightProbe

Parameters ​

• scene: FScene

• options?: FLightProbeOptions

Returns ​

FLightProbe

Overrides ​

FLight.constructor

Defined in ​

3d/src/lights/FLightProbe.ts:18

Methods ​

__UPDATE_LOOK_AT__() ​

__UPDATE_LOOK_AT__(): void

Update the look at target of the light. This method should be called after updating the position, so the light can look at the target.

Returns ​

void

Inherited from ​

FLight.__UPDATE_LOOK_AT__

Defined in ​

3d/src/lights/FLight.ts:107

__UPDATE_POSITION__() ​

__UPDATE_POSITION__(): void

Update the position of the light according to the transform. This method should be called after updating the transform properties.

Returns ​

void

Inherited from ​

FLight.__UPDATE_POSITION__

Defined in ​

3d/src/lights/FLight.ts:82

__UPDATE_ROTATION__() ​

__UPDATE_ROTATION__(): void

Update the rotation of the light according to the transform. This method should be called after updating the transform properties.

Returns ​

void

Inherited from ​

FLight.__UPDATE_ROTATION__

Defined in ​

3d/src/lights/FLight.ts:91

__UPDATE_SCALE__() ​

__UPDATE_SCALE__(): void

Update the scale of the light according to the transform. This method should be called after updating the transform properties.

Returns ​

void

Inherited from ​

FLight.__UPDATE_SCALE__

Defined in ​

3d/src/lights/FLight.ts:99

emitOnLoaded() ​

emitOnLoaded(): void

Emit the onLoaded callbacks.

Returns ​

void

Inherited from ​

FLight.emitOnLoaded

Defined in ​

core/dist/index.d.ts:54

onLoaded() ​

onLoaded(callback): void

Add a callback to be called when the light is loaded.

Parameters ​

• callback

The callback function.

Returns ​

void

Inherited from ​

FLight.onLoaded

Defined in ​

core/dist/index.d.ts:50

Properties ​

__CALLBACKS_ON_COLLISION__ ​

__CALLBACKS_ON_COLLISION__: object = {}

Index Signature ​

[key: string]: () => void[]

Inherited from ​

FLight.__CALLBACKS_ON_COLLISION__

Defined in ​

3d/src/lights/FLight.ts:25

__CALLBACKS_ON_LOADED__ ​

__CALLBACKS_ON_LOADED__: () => void[]

Callbacks for when the light is loaded.

Inherited from ​

FLight.__CALLBACKS_ON_LOADED__

Defined in ​

core/dist/index.d.ts:40

__ID__ ​

__ID__: number

Inherited from ​

FLight.__ID__

Defined in ​

3d/src/lights/FLight.ts:24

__IS_2D__ ​

__IS_2D__: boolean = false

Inherited from ​

FLight.__IS_2D__

Defined in ​

3d/src/lights/FLight.ts:23

__IS_3D__ ​

__IS_3D__: boolean = true

Internal flags

Inherited from ​

FLight.__IS_3D__

Defined in ​

3d/src/lights/FLight.ts:22

__LIGHT__ ​

__LIGHT__: Light<undefined | LightShadow<Camera>>

The original light object from Three.js.

Inherited from ​

FLight.__LIGHT__

Defined in ​

3d/src/lights/FLight.ts:30

__LOOK_AT__ ​

__LOOK_AT__: undefined | FVector3

Look at target of the light.

Inherited from ​

FLight.__LOOK_AT__

Defined in ​

3d/src/lights/FLight.ts:45

scene ​

scene: FScene

Scene the light is in.

Inherited from ​

FLight.scene

Defined in ​

3d/src/lights/FLight.ts:35

transform ​

transform: FTransform

Transform of the light.

Inherited from ​

FLight.transform

Defined in ​

3d/src/lights/FLight.ts:40