Class Spherical

constructor

• new Spherical(radius: number, theta: number, phi: number): Spherical

  Creates a new Spherical object from the given spherical coordinates

  Parameters

  • radius: number

    spherical radius

  • theta: number

    angle from positive y axis to radial line from 0 to PI (vertical)

  • phi: number

    angle from positive x axis measured anticlockwise from -PI to PI (horizontal)

  Returns Spherical

phi

radius

theta

add

• add(spherical: Spherical): Spherical

  Adds the current Spherical and the given Spherical

  Parameters

  • spherical: Spherical

    the spherical to add

  Returns Spherical

  the sum spherical

addInPlace

• addInPlace(spherical: Spherical): Spherical

  Adds the given spherical to the current spherical

  Parameters

  • spherical: Spherical

    the spherical to add

  Returns Spherical

  the current spherical

addInPlaceFromFloats

• addInPlaceFromFloats(radius: number, theta: number, phi: number): Spherical

  Adds the provided values to the current spherical

  Parameters

  • radius: number

    the amount to add to the radius

  • theta: number

    the amount to add to the theta

  • phi: number

    the amount to add to the phi

  Returns Spherical

  the current spherical

addToRef

• addToRef(spherical: Spherical, ref: Spherical): Spherical

  Adds the current Spherical and the given Spherical and stores the result

  Parameters

  • spherical: Spherical

    the spherical to add

  • ref: Spherical

    the spherical to store the result in

  Returns Spherical

  the updated ref

asArray

• asArray(): number[]

  Converts the current spherical to an array

  Returns number[]

  the current spherical as an array

clone

• clone(): Spherical

  Clones the current spherical

  Returns Spherical

  a clone of the current spherical

copyFrom

• copyFrom(source: Spherical): Spherical

  Copies the source spherical into the current spherical

  Parameters

  • source: Spherical

    the spherical to copy from

  Returns Spherical

  the current spherical

copyFromFloats

• copyFromFloats(radius: number, theta: number, phi: number): Spherical

  Copies the given values into the current spherical

  Parameters

  • radius: number

    the radius to use

  • theta: number

    the theta to use

  • phi: number

    the phi to use

  Returns Spherical

  the current spherical

divide

• divide(spherical: Spherical): Spherical

  Divides the current Spherical by the given Spherical

  Parameters

  • spherical: Spherical

    the spherical to divide

  Returns Spherical

  the quotient spherical

divideInPlace

• divideInPlace(spherical: Spherical): Spherical

  Divides the current Spherical by the given Spherical

  Parameters

  • spherical: Spherical

    the spherical to divide

  Returns Spherical

  the current spherical

divideToRef

• divideToRef(spherical: Spherical, ref: Spherical): Spherical

  Divides the current Spherical by the given Spherical and stores the result

  Parameters

  • spherical: Spherical

    the spherical to divide

  • ref: Spherical

    the spherical to store the result in

  Returns Spherical

  the updated ref

getClassName

• getClassName(): string

  Gets the class name

  Returns string

  the string "Spherical"

multiply

• multiply(spherical: Spherical): Spherical

  Multiplies the given Spherical with the current Spherical

  Parameters

  • spherical: Spherical

    the spherical to multiply

  Returns Spherical

  the product spherical

multiplyInPlace

• multiplyInPlace(spherical: Spherical): Spherical

  Multiplies the given Spherical with the current Spherical

  Parameters

  • spherical: Spherical

    the spherical to multiply

  Returns Spherical

  the current spherical

multiplyToRef

• multiplyToRef(spherical: Spherical, ref: Spherical): Spherical

  Multiplies the given Spherical with the current Spherical and stores the result

  Parameters

  • spherical: Spherical

    the spherical to multiply

  • ref: Spherical

    the spherical to store the result in

  Returns Spherical

  the updated ref

scale

• scale(scale: number): Spherical

  Scales the current spherical and returns a new spherical with the scaled coordinates

  Parameters

  • scale: number

    defines the multiplication factor

  Returns Spherical

  the scaled spherical

scaleInPlace

• scaleInPlace(scale: number): Spherical

  Scales the current spherical

  Parameters

  • scale: number

    defines the multiplication factor

  Returns Spherical

  the current spherical

scaleToRef

• scaleToRef(scale: number, ref: Spherical): Spherical

  Scales the current spherical and stores the result

  Parameters

  • scale: number

    defines the multiplication factor

  • ref: Spherical

    where to store the result

  Returns Spherical

  the updated ref

set

• set(radius: number, theta: number, phi: number): Spherical

  Sets the values of the current spherical

  Parameters

  • radius: number

    the new radius

  • theta: number

    the new theta

  • phi: number

    the new phi

  Returns Spherical

  the current spherical

setAll

• setAll(value: number): Spherical

  Sets the values of the current spherical

  Parameters

  • value: number

    the new values

  Returns Spherical

  the current spherical

subtract

• subtract(spherical: Spherical): Spherical

  Subtracts the given Spherical from the current Spherical

  Parameters

  • spherical: Spherical

    the spherical to subtract

  Returns Spherical

  the difference spherical

subtractFromFloats

• subtractFromFloats(radius: number, theta: number, phi: number): Spherical

  Subtracts the given floats from the current spherical

  Parameters

  • radius: number

    the amount to subtract from the radius

  • theta: number

    the amount to subtract from the theta

  • phi: number

    the amount to subtract from the phi

  Returns Spherical

  the difference spherical

subtractFromFloatsToRef

• subtractFromFloatsToRef(
      radius: number,
      theta: number,
      phi: number,
      ref: Spherical,
  ): Spherical

  Subtracts the given floats from the current spherical

  Parameters

  • radius: number

    the amount to subtract from the radius

  • theta: number

    the amount to subtract from the theta

  • phi: number

    the amount to subtract from the phi

  • ref: Spherical

    the spherical to store the result in

  Returns Spherical

  the updated ref

subtractInPlace

• subtractInPlace(spherical: Spherical): Spherical

  Subtracts the given Spherical from the current Spherical

  Parameters

  • spherical: Spherical

    the spherical to subtract

  Returns Spherical

  the current spherical

subtractToRef

• subtractToRef(spherical: Spherical, ref: Spherical): Spherical

  Subtracts the given Spherical from the current Spherical and stores the result

  Parameters

  • spherical: Spherical

    the spherical to subtract

  • ref: Spherical

    the spherical to store the result in

  Returns Spherical

  the updated ref

toString

• toString(): string

  Converts the current spherical to a string

  Returns string

  the current spherical as a string

toVector3

• toVector3(): Vector3

  Gets a Vector3 from the current spherical coordinates

  Returns Vector3

  the (x, y,z) form of the current Spherical

toVector3ToRef

• toVector3ToRef(ref: Vector3): Vector3

  Assigns the rectangular coordinates of the current Spherical to a Vector3

  Parameters

  • ref: Vector3

    the Vector3 to update

  Returns Vector3

  the updated Vector3

StaticFromArray

• FromArray(array: number[]): Spherical

  Converts an array of floats to a spherical

  Parameters

  • array: number[]

    the array to convert

  Returns Spherical

  the converted spherical

StaticFromVector3

• FromVector3(vector: DeepImmutable<Vector3>): Spherical

  Gets a Spherical from a Vector3

  Parameters

  • vector: DeepImmutable<Vector3>

    defines the vector in (x, y, z) coordinate space

  Returns Spherical

  a new Spherical

StaticFromVector3ToRef

• FromVector3ToRef(vector: DeepImmutable<Vector3>, ref: Spherical): Spherical

  Assigns the spherical coordinates from a Vector3

  Parameters

  • vector: DeepImmutable<Vector3>

    the vector to convert

  • ref: Spherical

    the Spherical to update

  Returns Spherical

  the updated ref