Class SpotLightRenderer

constructor

• new SpotLightRenderer(entity, options?): SpotLightRenderer

• Parameters

  • entity: Entity
  • options: SpotLightRendererOptions = {}

  Returns SpotLightRenderer

Readonlyentity

ReadonlyisRenderer

queryMask

userData

anglePower

• get anglePower(): number

• Get anglePower

  Returns number

  Memberof

  SpotLightRenderer

• set anglePower(value): void

• Set anglePower

  Parameters

  • value: number

  Returns void

  Memberof

  SpotLightRenderer

attenuation

• get attenuation(): number

• Get attenuation

  Returns number

  Memberof

  SpotLightRenderer

• set attenuation(value): void

• Set attenuation

  Parameters

  • value: number

  Returns void

  Memberof

  SpotLightRenderer

enabled

• get enabled(): boolean

• Indicates whether the component is enabled.

  Returns boolean

  Memberof

  Component

• set enabled(value): void

• Set whether the component is enabled.

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

object3D

• get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

• Get three.js native object3D

  Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  Memberof

  Renderer

opacity

• get opacity(): number

• Get opacity

  Returns number

  Memberof

  SpotLightRenderer

• set opacity(value): void

• Set opacity

  Parameters

  • value: number

  Returns void

  Memberof

  SpotLightRenderer

position

• get position(): Vector3

• Get local position

  Returns Vector3

  Memberof

  Renderer

• set position(position): void

• Set local position

  Parameters

  • position: Vector3

  Returns void

  Memberof

  Renderer

quaternion

• get quaternion(): Quaternion

• Get local quaternion

  Returns Quaternion

  Memberof

  Renderer

• set quaternion(quaternion): void

• Set local quaternion

  Parameters

  • quaternion: Quaternion

  Returns void

  Memberof

  Renderer

renderOrder

• get renderOrder(): RenderOrder

• Get render order

  Returns RenderOrder

  Memberof

  Renderer

• set renderOrder(value): void

• Set render order

  Parameters

  • value: RenderOrder

  Returns void

  Memberof

  Renderer

rotation

• get rotation(): Euler

• Get local rotation

  Returns Euler

  Memberof

  Renderer

• set rotation(rotation): void

• Set local rotation

  Parameters

  • rotation: Euler

  Returns void

  Memberof

  Renderer

scale

• get scale(): Vector3

• Get local scale

  Returns Vector3

  Memberof

  Renderer

• set scale(scale): void

• Set local scale

  Parameters

  • scale: Vector3

  Returns void

  Memberof

  Renderer

scene

• get scene(): Scene

• Scene own the component

  Returns Scene

  Memberof

  Component

soft

• get soft(): boolean

• Get whether enable soft

  Returns boolean

  Memberof

  SpotLightRenderer

• set soft(value): void

• Set whether enable soft

  Parameters

  • value: boolean

  Returns void

  Memberof

  SpotLightRenderer

softFarFade

• get softFarFade(): number

• Get soft far fade distance

  Returns number

  Memberof

  SpotLightRenderer

• set softFarFade(value): void

• Set soft far fade distance

  Parameters

  • value: number

  Returns void

  Memberof

  SpotLightRenderer

softNearFade

• get softNearFade(): number

• Get soft near fade distance

  Returns number

  Memberof

  SpotLightRenderer

• set softNearFade(value): void

• Set soft near fade distance

  Parameters

  • value: number

  Returns void

  Memberof

  SpotLightRenderer

visible

• set visible(value): void

• Set whether visible

  Parameters

  • value: boolean

  Returns void

  Memberof

  Renderer

worldBounds

• get worldBounds(): Readonly<Box3>

• Get renderer world bounds

  Returns Readonly<Box3>

  Memberof

  Renderer

afterCameraRender

• afterCameraRender(camera): void

• After camera render

  Parameters

  • camera: Camera

  Returns void

  Memberof

  Renderer

beforeCameraRender

• beforeCameraRender(camera): void

• Before camera render

  Parameters

  • camera: Camera

    the camera use to render

  Returns void

  Memberof

  Renderer

desrtoy

• desrtoy(): void

• Destroy component

  Returns void

  Memberof

  Component

dispose

• dispose(): void

• Clear subscribers

  Returns void

  Memberof

  EventDispatcher

emit

• emit(event): void

• Emit event

  Parameters

  • event: {
        type: string;
        [key: string]: any;
    }

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

getWorldDirection

• getWorldDirection(target): Vector3

• Returns a vector representing the direction of transform's positive z-axis in world space.

  Parameters

  • target: Vector3

    The result will be copied into this Vector3.

  Returns Vector3

  Memberof

  Renderer

getWorldPosition

• getWorldPosition(target): Vector3

• Returns a vector representing the position of the transforms in world space.

  Parameters

  • target: Vector3

    The result will be copied into this Vector3

  Returns Vector3

  Memberof

  Renderer

getWorldQuaternion

• getWorldQuaternion(target): Quaternion

• Returns a quaternion representing the rotation of the transform in world space.

  Parameters

  • target: Quaternion

    The result will be copied into this Quaternion.

  Returns Quaternion

  Memberof

  Renderer

getWorldScale

• getWorldScale(target): Vector3

• Returns a vector of the scaling factors applied to the transform for each axis in world space.

  Parameters

  • target: Vector3

    The result will be copied into this Vector3

  Returns Vector3

  Memberof

  Renderer

localToWorld

• localToWorld(vector): Vector3

• Converts the vector from this object's local space to world space.

  Parameters

  • vector: Vector3

    A vector representing a position in this object's local space.

  Returns Vector3

  Memberof

  Renderer

lookAt

• lookAt(target): void

• Rotates the object to face a point in world space.

  Parameters

  • target: Vector3

    A vector representing a position in world space to look at.

  Returns void

  Memberof

  Renderer

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

raycast

• raycast(raycaster): Intersection<Object3D<Object3DEventMap>>

• Raycast

  Parameters

  • raycaster: Raycaster

  Returns Intersection<Object3D<Object3DEventMap>>

  Memberof

  SpotLightRenderer

setTransformation

• setTransformation(transformation): void

• Set renderer's transformation

  Parameters

  • transformation: Transformation

  Returns void

  Memberof

  Renderer

update

• update(timeSinceLastFrame, totalTime): void

• Renderer component frame update

  Parameters

  • timeSinceLastFrame: number

    time since last frame in seconds
  • totalTime: number

    total time in seconds

  Returns void

  Memberof

  Renderer

updateWorldMatrix

• updateWorldMatrix(): void

• Update world matrix

  Returns void

  Memberof

  Renderer

worldToLocal

• worldToLocal(vector): Vector3

• Converts the vector from world space to this object's local space.

  Parameters

  • vector: Vector3

    A vector representing a position in world space.

  Returns Vector3

  Memberof

  Renderer