Class SphericalHarmonics3

Hierarchy

SphericalHarmonics3

Index

Constructors

constructor

new SphericalHarmonics3(): SphericalHarmonics3
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:4

Properties

coefficients

coefficients: THREE.Vector3[]

Default

[new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3(), new THREE.Vector3()]

`Readonly` isSphericalHarmonics3

isSphericalHarmonics3: true

Methods

add

add(sh: SphericalHarmonics3): SphericalHarmonics3
Parameters
- sh: SphericalHarmonics3
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:15

addScaledSH

addScaledSH(sh: SphericalHarmonics3, s: number): SphericalHarmonics3
Parameters
- sh: SphericalHarmonics3
- s: number
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:16

clone

clone(): SphericalHarmonics3
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:21

copy

copy(sh: SphericalHarmonics3): SphericalHarmonics3
Parameters
- sh: SphericalHarmonics3
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:20

equals

equals(sh: SphericalHarmonics3): boolean
Parameters
- sh: SphericalHarmonics3
Returns boolean
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:19

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): SphericalHarmonics3
Sets the values of this spherical harmonics from the provided array or array-like.
Parameters
- array: number[] | ArrayLike<number>
  
  the source array or array-like.
- Optional offset: number
  
  (optional) offset into the array. Default is 0.
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:28

getAt

getAt(normal: THREE.Vector3, target: THREE.Vector3): THREE.Vector3
Parameters
- normal: THREE.Vector3
- target: THREE.Vector3
Returns THREE.Vector3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:46

getIrradianceAt

getIrradianceAt(normal: THREE.Vector3, target: THREE.Vector3): THREE.Vector3
Parameters
- normal: THREE.Vector3
- target: THREE.Vector3
Returns THREE.Vector3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:47

lerp

lerp(sh: SphericalHarmonics3, alpha: number): SphericalHarmonics3
Parameters
- sh: SphericalHarmonics3
- alpha: number
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:18

scale

scale(s: number): SphericalHarmonics3
Parameters
- s: number
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:17

set

set(coefficients: THREE.Vector3[]): SphericalHarmonics3
Parameters
- coefficients: THREE.Vector3[]
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:13

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array with the values of this spherical harmonics, or copies them into the provided array.

Returns
The created or provided array.
Parameters
- Optional array: number[]
  
  (optional) array to store the spherical harmonics to. If this is not provided, a new array will be created.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns number[]
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:36
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
Returns an array with the values of this spherical harmonics, or copies them into the provided array-like.

Returns
The provided array-like.
Parameters
- array: ArrayLike<number>
  
  array-like to store the spherical harmonics to.
- Optional offset: number
  
  (optional) optional offset into the array-like.
Returns ArrayLike<number>
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:44

zero

zero(): SphericalHarmonics3
Returns SphericalHarmonics3
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:14

`Static` getBasisAt

getBasisAt(normal: THREE.Vector3, shBasis: number[]): void
Parameters
- normal: THREE.Vector3
- shBasis: number[]
Returns void
- Defined in node_modules/@types/three/src/math/SphericalHarmonics3.d.ts:49

Class SphericalHarmonics3

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SphericalHarmonics3

Properties

coefficients

Default

Readonly isSphericalHarmonics3

Methods

add

Parameters

sh: SphericalHarmonics3

Returns SphericalHarmonics3

addScaledSH

Parameters

sh: SphericalHarmonics3

s: number

Returns SphericalHarmonics3

clone

Returns SphericalHarmonics3

copy

Parameters

sh: SphericalHarmonics3

Returns SphericalHarmonics3

equals

Parameters

sh: SphericalHarmonics3

Returns boolean

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns SphericalHarmonics3

getAt

Parameters

normal: THREE.Vector3

target: THREE.Vector3

Returns THREE.Vector3

getIrradianceAt

Parameters

normal: THREE.Vector3

target: THREE.Vector3

Returns THREE.Vector3

lerp

Parameters

sh: SphericalHarmonics3

alpha: number

Returns SphericalHarmonics3

scale

Parameters

s: number

Returns SphericalHarmonics3

set

Parameters

coefficients: THREE.Vector3[]

Returns SphericalHarmonics3

toArray

Returns

Parameters

Optional array: number[]

Optional offset: number

Returns number[]

Returns

Parameters

array: ArrayLike<number>

Optional offset: number

Returns ArrayLike<number>

zero

Returns SphericalHarmonics3

Static getBasisAt

Parameters

normal: THREE.Vector3

shBasis: number[]

Returns void

Settings

`Readonly` isSphericalHarmonics3

`Optional` offset: number

`Optional` array: number[]

`Optional` offset: number

`Optional` offset: number

`Static` getBasisAt