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

    Class SpotLight

    Spotlight that emits light in a cone shape.

    Hierarchy (View Summary)

    Index
    constructor
    angle behaviors bounds castShadow children color decay direction distance frustumCulled geometry inFrustum intensity isCollidable isPickable isStatic isVisible localMatrix material name onPointerClick? onPointerDown? onPointerEnter? onPointerLeave? onPointerMove? onPointerUp? parent penumbra position receiveShadow rigidBody? rotation scale shadowBias shadowCamera shadowNormalBias shadowResolution tag? type uuid worldMatrix
    add addBehavior applyTo computeBounds getObjectByName getWorldPosition lookAt remove removeBehavior setPosition setRotation setScale translate updateMatrixWorld updateShadowCamera
    angle: number

    The angle of the light cone in radians.

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

    The physical bounding volume of the object.

    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.

    isCollidable: boolean = true

    Whether this object should generate bounds and participate in physics/raycasting. Defaults to true.

    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
    rigidBody?: RigidBody
    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.

    tag?: string

    Optional app-defined category tag, for typed identification instead of matching on name.

    type: LightType = LightType.SPOT

    The type of the light.

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

    • Reads this object's position in world space, i.e. after resolving the full parent chain -- unlike position, which is always local to its immediate parent. Requires worldMatrix to be current (see updateMatrixWorld()).

      Parameters

      • out: Vector3D = ...

        Optional vector to write into, to avoid allocating one per call.

      Returns Vector3D

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

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods