Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SphericalPolynomial

Class representing spherical polynomial coefficients to the 3rd degree

Hierarchy

  • SphericalPolynomial

Index

Properties

xSearch playground for x

The x coefficients of the spherical polynomial

xxSearch playground for xx

The xx coefficients of the spherical polynomial

xySearch playground for xy

The xy coefficients of the spherical polynomial

ySearch playground for y

The y coefficients of the spherical polynomial

yySearch playground for yy

The yy coefficients of the spherical polynomial

yzSearch playground for yz

The yz coefficients of the spherical polynomial

zSearch playground for z

The z coefficients of the spherical polynomial

zxSearch playground for zx

The zx coefficients of the spherical polynomial

zzSearch playground for zz

The zz coefficients of the spherical polynomial

Accessors

preScaledHarmonics

  • The spherical harmonics used to create the polynomials.

    Returns SphericalHarmonics

Methods

addAmbientSearch playground for addAmbient

  • addAmbient(color: Color3): void
  • Adds an ambient color to the spherical polynomial

    Parameters

    • color: Color3

      the color to add

    Returns void

scaleInPlaceSearch playground for scaleInPlace

  • scaleInPlace(scale: number): void
  • Scales the spherical polynomial by the given amount

    Parameters

    • scale: number

      the amount to scale

    Returns void

updateFromHarmonicsSearch playground for updateFromHarmonics

  • Updates the spherical polynomial from harmonics

    Parameters

    Returns SphericalPolynomial

    the spherical polynomial

Static FromArraySearch playground for FromArray

  • Constructs a spherical polynomial from an array.

    Parameters

    • data: ArrayLike<ArrayLike<number>>

      defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)

    Returns SphericalPolynomial

    the spherical polynomial

Static FromHarmonicsSearch playground for FromHarmonics

  • Gets the spherical polynomial from harmonics

    Parameters

    Returns SphericalPolynomial

    the spherical polynomial

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method