Constructor
new SphericalHarmonics3()
Creates a new instance of SphericalHarmonics3.
Members
coefficients :Array
An array holding the (9) SH coefficients. A single coefficient is represented as an instance of Vector3.
- Array
Methods
add(sh) → {SphericalHarmonics3}
Adds the given SH to this instance.
| Name | Type | Description |
|---|---|---|
sh | SphericalHarmonics3 | The SH to add. |
- Type:
- SphericalHarmonics3
addScaledSH(sh, s) → {SphericalHarmonics3}
A convenience method for performing .add() and .scale() at once.
| Name | Type | Description |
|---|---|---|
sh | SphericalHarmonics3 | The SH to add. |
s | Vector3 | The scale factor. |
- Type:
- SphericalHarmonics3
clone() → {SphericalHarmonics3}
Returns a new instance of SphericalHarmonics3 with equal coefficients.
- Type:
- SphericalHarmonics3
copy(sh) → {SphericalHarmonics3}
Copies the given SH to this instance.
| Name | Type | Description |
|---|---|---|
sh | SphericalHarmonics3 | The SH to compare with. |
- Type:
- SphericalHarmonics3
equals(sh) → {boolean}
Returns true if the given SH and this instance have equal coefficients.
| Name | Type | Description |
|---|---|---|
sh | SphericalHarmonics3 | The SH to compare with. |
- Type:
- boolean
fromArray(array, offsetopt) → {SphericalHarmonics3}
Sets the coefficients of this instance from the given array.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array | Array.<number> | The array holding the numbers of the SH coefficients. | ||
offset | number | <optional> | 0 | The array offset. |
- Type:
- SphericalHarmonics3
getAt(normal, target) → {Vector3}
Returns the radiance in the direction of the given normal.
| Name | Type | Description |
|---|---|---|
normal | Vector3 | The normal vector (assumed to be unit length). |
target | Vector3 | The result vector. |
- Type:
- Vector3
getIrradianceAt(normal, target) → {Vector3}
Reference: https://graphics.stanford.edu/papers/envmap/envmap.pdf Returns the irradiance (radiance convolved with cosine lobe) in the direction of the given normal.
| Name | Type | Description |
|---|---|---|
normal | Vector3 | The normal vector (assumed to be unit length). |
target | Vector3 | The result vector. |
- Type:
- Vector3
lerp(sh, alpha) → {SphericalHarmonics3}
Linear interpolates between the given SH and this instance by the given alpha factor. Sets this coefficients vector to be the vector linearly interpolated between v1 and v2 where alpha is the percent distance along the line connecting the two vectors
- alpha = 0 will be v1, and alpha = 1 will be v2.
| Name | Type | Description |
|---|---|---|
sh | SphericalHarmonics3 | The SH to interpolate with. |
alpha | number | The alpha factor. |
- Type:
- SphericalHarmonics3
scale(s) → {SphericalHarmonics3}
Multiply the s to this SphericalHarmonics3.
| Name | Type | Description |
|---|---|---|
s | number | The scale factor. |
- Type:
- SphericalHarmonics3
set(coefficients) → {SphericalHarmonics3}
Set this sphericalHarmonics3 value.
| Name | Type | Description |
|---|---|---|
coefficients | Array.<Vector3> | An array of SH coefficients. |
- Type:
- SphericalHarmonics3
toArray(arrayopt, offsetopt) → {Array.<number>}
Returns an array with the coefficients, or copies them into the provided array. The coefficients are represented as numbers.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array | Array.<number> | <optional> | The target array. | |
offset | number | <optional> | 0 | The array offset. |
- Type:
- Array.<number>
zero() → {SphericalHarmonics3}
Sets all SH coefficients to 0.
- Type:
- SphericalHarmonics3
(static) getBasisAt(normal, shBasis)
Computes the SH basis for the given normal vector.
| Name | Type | Description |
|---|---|---|
normal | Vector3 | The normal vector (assumed to be unit length). |
shBasis | Array.<number> | The resulting SH basis. |