Interface LightformerOptions

Lightformer component options

Export

LightformerOptions

Date

2024.1.28

Author

yisky

interface LightformerOptions {
    color?: ColorRepresentation;
    form?:
        | BufferGeometry<NormalBufferAttributes>
        | "Circle"
        | "Ring"
        | "Rect";
    intensity?: number;
    lookAt?: Vector3;
    map?: Texture;
    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);
    position?: Vector3;
    quaternion?: Quaternion;
    queryMask?: QueryMask;
    renderOrder?: RenderOrder;
    rotation?: Euler;
    scale?: Vector3;
    userData?: {
        [key: string]: any;
    };
}

Hierarchy

  • RendererOptions
    • LightformerOptions

Properties

color? form? intensity? lookAt? map? onAfterRender? onBeforeRender? position? quaternion? queryMask? renderOrder? rotation? scale? userData?

Properties

Optionalcolor

color?: ColorRepresentation

Color

Memberof

LightformerOptions

Optionalform

form?:
    | BufferGeometry<NormalBufferAttributes>
    | "Circle"
    | "Ring"
    | "Rect"

Form

Memberof

LightformerOptions

Optionalintensity

intensity?: number

Intensity

Memberof

LightformerOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

Optionalmap

map?: Texture

Map

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

Optionalposition

position?: Vector3

Local Position

Memberof

LightformerOptions

Optionalquaternion

quaternion?: Quaternion

Local quaternion

Memberof

RendererOptions

OptionalqueryMask

queryMask?: QueryMask

Query mask

Memberof

RendererOptions

OptionalrenderOrder

renderOrder?: RenderOrder

Render order

Memberof

RendererOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

OptionaluserData

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

The component user data, default is {}

Memberof

ComponentOptions

Settings

Member Visibility

On This Page

Properties