Small World Engine API Reference - v0.46.1
    Preparing search index...

    Class SpotLight

    Spotlight that emits light in a cone shape.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    angle behaviors bounds castShadow children color decay direction distance frustumCulled geometry inFrustum intensity isPickable isStatic isVisible localMatrix material name onPointerClick? onPointerDown? onPointerEnter? onPointerLeave? onPointerMove? onPointerUp? parent penumbra position receiveShadow rotation scale shadowBias shadowCamera shadowNormalBias shadowResolution type uuid worldMatrix

    Methods

    add addBehavior applyTo computeBounds lookAt remove removeBehavior setPosition setRotation setScale translate updateMatrixWorld updateShadowCamera

    Constructors

    Properties

    angle: number

    The angle of the light cone in radians.

    behaviors: Behavior[] = []
    bounds: BoundingVolume | undefined = undefined
    castShadow: boolean

    Whether the light casts shadows.

    children: Object3D[] = []
    color: Color

    The color of the light.

    decay: number

    The decay factor of the light.

    direction: Vector3D

    The direction of the light.

    distance: number

    The maximum distance of the light.

    frustumCulled: boolean = true
    geometry: GeometryDataInterface | undefined = undefined
    inFrustum: boolean = true
    intensity: number

    The intensity of the light.

    isPickable: boolean = false
    isStatic: boolean = false
    isVisible: boolean = true
    localMatrix: Matrix4 = ...
    material: AbstractMaterial | undefined = undefined
    name: string = ""
    onPointerClick?: () => void
    onPointerDown?: (ray: Ray, intersectionPoint: Vector3D) => void
    onPointerEnter?: () => void
    onPointerLeave?: () => void
    onPointerMove?: (ray: Ray) => void
    onPointerUp?: () => void
    parent: Object3D | undefined = undefined
    penumbra: number

    The penumbra factor (0-1).

    position: Vector3D = ...
    receiveShadow: boolean = false
    rotation: Vector3D = ...
    scale: Vector3D = ...
    shadowBias: number

    A small offset to prevent shadow acne.

    shadowCamera: Camera | undefined

    The camera used to render the shadow map for this light.

    shadowNormalBias: number

    An offset along the surface normal to prevent shadow acne.

    shadowResolution: number

    The resolution of the shadow map for this light.

    type: LightType = LightType.SPOT

    The type of the light.

    uuid: string = ...
    worldMatrix: Matrix4 = ...

    Methods

    • Updates the shadow camera's matrices based on the spotlight's properties.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods