Interface SpotLightRendererOptions

SpotLightRenderer options

Export

SpotLightRendererOptions

Date

2024.2.26

Author

yisky

interface SpotLightRendererOptions {
    anglePower?: number;
    attenuation?: number;
    distance?: number;
    lookAt?: Vector3;
    onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    opacity?: number;
    position?: Vector3;
    quaternion?: Quaternion;
    queryMask?: QueryMask;
    radiusBottom?: number;
    radiusTop?: number;
    renderOrder?: RenderOrder;
    rotation?: Euler;
    scale?: Vector3;
    soft?: boolean;
    softFarFade?: number;
    softNearFade?: number;
    userData?: {
        [key: string]: any;
    };
}

Hierarchy

  • RendererOptions
    • SpotLightRendererOptions

Properties

anglePower? attenuation? distance? lookAt? onAfterRender? onBeforeRender? opacity? position? quaternion? queryMask? radiusBottom? radiusTop? renderOrder? rotation? scale? soft? softFarFade? softNearFade? userData?

Properties

OptionalanglePower

anglePower?: number

Angle power, 5.0

Memberof

SpotLightRendererOptions

Optionalattenuation

attenuation?: number

Attenuation, 5.0

Memberof

SpotLightRendererOptions

Optionaldistance

distance?: number

Distance, 5.0

Memberof

SpotLightRendererOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

OptionalonAfterRender

onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

After render callback

Memberof

RendererOptions

OptionalonBeforeRender

onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Before render callback

Memberof

RendererOptions

Optionalopacity

opacity?: number

Opacity, 1.0

Memberof

SpotLightRendererOptions

Optionalposition

position?: Vector3

Local Position

Memberof

LightformerOptions

Optionalquaternion

quaternion?: Quaternion

Local quaternion

Memberof

RendererOptions

OptionalqueryMask

queryMask?: QueryMask

Query mask

Memberof

RendererOptions

OptionalradiusBottom

radiusBottom?: number

Bottom radius, 1.05

Memberof

SpotLightRendererOptions

OptionalradiusTop

radiusTop?: number

Top radius, 0.1

Memberof

SpotLightRendererOptions

OptionalrenderOrder

renderOrder?: RenderOrder

Render order

Memberof

RendererOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

Optionalsoft

soft?: boolean

Whether enable soft, false.

Memberof

SpotLightRendererOptions

OptionalsoftFarFade

softFarFade?: number

Soft far fade distance, 1.0.

Memberof

SpotLightRendererOptions

OptionalsoftNearFade

softNearFade?: number

Soft near fade distance, 0.0.

Memberof

SpotLightRendererOptions

OptionaluserData

userData?: {
    [key: string]: any;
}

The component user data, default is {}

Memberof

ComponentOptions

Settings

Member Visibility

On This Page

Properties