Class Spherical

A point's spherical coordinates.

Hierarchy

  • Base
    • Spherical

Constructors

constructor

Properties

phi radius theta

Accessors

isBox2 isBox3 isColor isCylindrical isEuler isLine3 isMatrix3 isMatrix4 isPlane isQuaternion isRay isSphere isSpherical isTriangle isVector2 isVector3 isVector4

Methods

clone copy makeSafe set setFromCartesianCoords setFromVector3

Constructors

constructor

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

  • Create a new instance. The poles (phi) are at the positive and negative y axis. The equator (theta) starts at positive z..

    Parameters

    • radius: number = 1

      The radius, or the Euclidean distance (straight-line distance) from the point to the origin. Default is 1.0

    • phi: number = 0

      Polar angle in radians from the y (up) axis. Default is 0.

    • theta: number = 0

      Equator angle in radians around the y (up) axis. Default is 0.

    Returns Spherical

Properties

phi

phi: number

Polar angle in radians from the y (up) axis. Default is 0.

radius

radius: number

The radius, or the Euclidean distance (straight-line distance) from the point to the origin. Default is 1.0.

theta

theta: number

Equator angle in radians around the y (up) axis. Default is 0.

Accessors

isBox2

  • get isBox2(): boolean

  • Returns boolean

isBox3

  • get isBox3(): boolean

  • Returns boolean

isColor

  • get isColor(): boolean

  • Returns boolean

isCylindrical

  • get isCylindrical(): boolean

  • Returns boolean

isEuler

  • get isEuler(): boolean

  • Returns boolean

isLine3

  • get isLine3(): boolean

  • Returns boolean

isMatrix3

  • get isMatrix3(): boolean

  • Returns boolean

isMatrix4

  • get isMatrix4(): boolean

  • Returns boolean

isPlane

  • get isPlane(): boolean

  • Returns boolean

isQuaternion

  • get isQuaternion(): boolean

  • Returns boolean

isRay

  • get isRay(): boolean

  • Returns boolean

isSphere

  • get isSphere(): boolean

  • Returns boolean

isSpherical

  • get isSpherical(): boolean

  • Read-only flag to check if a given object is of type Spherical.

    Returns boolean

isTriangle

  • get isTriangle(): boolean

  • Returns boolean

isVector2

  • get isVector2(): boolean

  • Returns boolean

isVector3

  • get isVector3(): boolean

  • Returns boolean

isVector4

  • get isVector4(): boolean

  • Returns boolean

Methods

clone

  • Create a new spherical with the same radius, phi and theta properties as this one.

    Returns

    A new Spherical instance

    Returns Spherical

copy

  • Copies the values of the passed Spherical's radius, phi and theta properties to this spherical.

    Returns

    This instance.

    Parameters

    • other: Spherical

      A spherical to copy properties from.

    Returns Spherical

makeSafe

  • Restricts the polar angle phi to be between 0.000001 and pi - 0.000001.

    Returns

    This instance.

    Returns Spherical

set

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

  • Sets values of this spherical's radius, phi and theta properties.

    Returns

    This instance.

    Parameters

    • radius: number

      The radius, or the Euclidean distance (straight-line distance) from the point to the origin.

    • phi: number

      Polar angle in radians from the y (up) axis.

    • theta: number

      Equator angle in radians around the y (up) axis.

    Returns Spherical

setFromCartesianCoords

  • setFromCartesianCoords(x: number, y: number, z: number): Spherical

  • Sets values of this spherical's radius, phi and theta properties from Cartesian coordinates.

    Returns

    This instance.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    • z: number

      The Z coordinate.

    Returns Spherical

setFromVector3

  • Sets values of this spherical's radius, phi and theta properties from the Vector3.

    Returns

    This instance.

    Parameters

    Returns Spherical

Settings

Member Visibility

Theme