CLASSES
TagsA - Z

LensFlareSystem

Description

class LensFlareSystem

Create a lens Flare system

Constructor

new LensFlareSystem(name, emitter, scene)

The lens Flare system

Parameters

Name Type Description
name string The name of the lens flare system
emitter any The Emitter of the lens flare system : it can be a camera, a light or a mesh.
scene Scene Scene where the lens flare system is.

Members

name : string

The name of the lens Flare system

lensFlares : LensFlare[]

Lens flares array containing all lens flares

borderLimit : number

Lens flare system border limit.

viewportBorder : number

meshesSelectionPredicate : Mesh) => boolean

Verify that a mesh can receive lens flares.

layerMask : number

id : string

isEnabled : boolean

Lens flare system is enabled

Methods

getScene() Scene

Get the scene where the lens flare system is.

getEmitter() any

Get the emitter

setEmitter(newEmitter) void

Parameters

Name Type Description
newEmitter any

getEmitterPosition() Vector3

Get the emitter position. Returns its absolute position if the emitter has an absolute position.

computeEffectivePosition(globalViewport) boolean

Compute the effective position

Parameters

Name Type Description
globalViewport Viewport The global viewport

render() boolean

Render the lens flare system

dispose() void

static Parse(parsedLensFlareSystem, scene, rootUrl) LensFlareSystem

Parameters

Name Type Description
parsedLensFlareSystem any
scene Scene Scene where the lens flare system is.
rootUrl string

serialize() any