Class DirectionalLight

Directiona light component

Export

DirectionalLight

Date

2024.1.3

Author

yisky

Hierarchy (view full)

Component
- DirectionalLight

Index

Constructors

Properties

_awoken _enabled entity userData

Accessors

color direction enabled intensity light position scene target

Methods

_onAwake _onDestroy _onDisable _onEnable desrtoy dispose emit off on once setTarget translateTargetOnAxis

Constructors

constructor

new DirectionalLight(entity, options?): DirectionalLight
Parameters
- entity: Entity
- options: DirectionalLightOptions = {}
Returns DirectionalLight
Overrides Component.constructor

Properties

`Protected`_awoken

_awoken: boolean = false

`Protected`_enabled

_enabled: boolean = false

`Readonly`entity

entity: Entity

userData

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

Component user data

Memberof

Component

Accessors

color

set color(value): void
Set color
Parameters
- value: ColorRepresentation
Returns void
Memberof
DirectionalLight

direction

set direction(value): void
Set local direction
Parameters
- value: Vector3
Returns void
Memberof
DirectionalLight

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Memberof
Component

Inherited from Component.enabled
set enabled(value): void
Set whether the component is enabled.
Parameters
- value: boolean
Returns void
Memberof
Component

Inherited from Component.enabled

intensity

set intensity(value): void
Set intensity
Parameters
- value: number
Returns void
Memberof
DirectionalLight

light

get light(): DirectionalLight
Get Three.js DirectionalLight

Returns DirectionalLight
Memberof
DirectionalLight

position

set position(value): void
Set local position
Parameters
- value: Vector3
Returns void
Memberof
DirectionalLight

scene

get scene(): Scene
Scene own the component

Returns Scene
Memberof
Component

Inherited from Component.scene

target

set target(value): void
Set local target position
Parameters
- value: Vector3
Returns void
Memberof
DirectionalLight

Methods

`Protected`_onAwake

_onAwake(): void
Protected
Awake component callback

Returns void
Memberof
Component

Inherited from Component._onAwake

`Protected`_onDestroy

_onDestroy(): void
Protected
Destroy callback

Returns void
Memberof
DirectionalLight

Overrides Component._onDestroy

`Protected`_onDisable

_onDisable(): void
Protected
Disable callback

Returns void
Memberof
DirectionalLight

Overrides Component._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable callback

Returns void
Memberof
DirectionalLight

Overrides Component._onEnable

desrtoy

desrtoy(): void
Destroy component

Returns void
Memberof
Component

Inherited from Component.desrtoy

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from Component.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from Component.emit

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

Inherited from Component.off

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

Inherited from Component.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- options: {
  priority?: Priority;
  target?: any;
  } = {}
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Component.once

setTarget

setTarget(target, worldSpace?): void
Set target
Parameters
- target: Vector3
- OptionalworldSpace: boolean = false
Returns void
Memberof
DirectionalLight

translateTargetOnAxis

translateTargetOnAxis(axis, distance): void
Translate target along axis
Parameters
- axis: Vector3
- distance: number
Returns void
Memberof
DirectionalLight