Class DirectionalLightHelper2

Hierarchy (View Summary)

ALightHelperWidget
- DirectionalLightHelper2

Index

Constructors

Properties

assetType color isWidget light lightPlane lineWidth material modelObject object size targetLine uiConfig visible

Methods

_objectBeforeRender _objectUpdate attach detach dispose update Check Create

Constructors

constructor

new DirectionalLightHelper2(
    light: DirectionalLight,
    size?: number,
    color?: ColorRepresentation,
): DirectionalLightHelper2
Parameters
- light: DirectionalLight
- Optionalsize: number
- Optionalcolor: ColorRepresentation
Returns DirectionalLightHelper2
Overrides ALightHelperWidget.constructor
- Defined in src/three/widgets/DirectionalLightHelper2.ts:24

Properties

assetType

assetType: string = 'widget'

color

color: undefined | ColorRepresentation

isWidget

isWidget: true = ...

light

light: undefined | DirectionalLight & IUiConfigContainer<any, string>

lightPlane

lightPlane: Line2

lineWidth

lineWidth: number = 5

material

material: LineMaterial2

modelObject

modelObject: DirectionalLightHelper2 = ...

Deprecated

not required

object

object: undefined | Object3D<Object3DEventMap> & IUiConfigContainer<any, string>

size

size: number = 0.5

targetLine

targetLine: Line2

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

visible

visible: boolean = true

Object gets rendered if true.

Default Value

true

Methods

`Protected`_objectBeforeRender

_objectBeforeRender(): void
Returns void
Inherited from ALightHelperWidget._objectBeforeRender
- Defined in src/three/widgets/AHelperWidget.ts:50

`Protected`_objectUpdate

_objectUpdate(): void
Returns void
Inherited from ALightHelperWidget._objectUpdate
- Defined in src/three/widgets/AHelperWidget.ts:46

attach

attach(object: Object3D): this
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D
Returns this
Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See
add
Inherited from ALightHelperWidget.attach
- Defined in src/three/widgets/AHelperWidget.ts:56

detach

detach(): this
Returns this
Inherited from ALightHelperWidget.detach
- Defined in src/three/widgets/AHelperWidget.ts:71

dispose

dispose(): void
Returns void
Overrides ALightHelperWidget.dispose
- Defined in src/three/widgets/DirectionalLightHelper2.ts:68

update

update(): void
Returns void
Overrides ALightHelperWidget.update
- Defined in src/three/widgets/DirectionalLightHelper2.ts:82

`Static`Check

Check(light: Object3D): true
Parameters
- light: Object3D
Returns true
- Defined in src/three/widgets/DirectionalLightHelper2.ts:108

`Static`Create

Create(light: Object3D): DirectionalLightHelper2
Parameters
- light: Object3D
Returns DirectionalLightHelper2
- Defined in src/three/widgets/DirectionalLightHelper2.ts:111