Class SphericalHarmonics<TDataType>

A representation of a sphere of values via Spherical Harmonics (SH).

System.Object
SphericalHarmonics<TDataType>
SphericalHarmonics
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class SphericalHarmonics<TDataType> : Object
Type Parameters
TDataType

The type of data contained by the sphere

Constructors

SphericalHarmonics(Int32)

The desired order to

Declaration
protected SphericalHarmonics(int order)
Parameters
System.Int32 order

Fields

MaximumOrder

The maximum order supported.

Declaration
public const int MaximumOrder = 5
Field Value
System.Int32

Properties

Coefficients

Get the coefficients defining the spherical harmonics (the spherical coordinates x{l,m} multiplying the spherical base Y{l,m}).

Declaration
public TDataType[] Coefficients { get; }
Property Value
TDataType[]

Item[Int32, Int32]

Returns the coefficient x{l,m} of the spherical harmonics (the {l,m} spherical coordinate corresponding to the spherical base Y{l,m}).

Declaration
public TDataType this[int l, int m] { get; set; }
Parameters
System.Int32 l

the l index of the coefficient
System.Int32 m

the m index of the coefficient
Property Value
TDataType

the value of the coefficient

Order

The order of calculation of the spherical harmonic.

Declaration
public int Order { get; }
Property Value
System.Int32

Methods

Evaluate(Float3)

Evaluate the value of the spherical harmonics in the provided direction.

Declaration
public abstract TDataType Evaluate(Float3 direction)
Parameters
Float3 direction

The direction
Returns
TDataType

The value of the spherical harmonics in the direction

Extension Methods