Class Spherical

A point given as radius, phi and theta around the origin: its distance, its angle down from +Y, and its angle around +Y, measured from +Z toward +X

Use it for anything that orbits: convert a position in, change the angles, then convert back with Vector3#setFromSpherical.

Example

const orbit = new Spherical().setFromPoint3D(camera.position);

orbit.theta += 0.01;
orbit.phi -= 0.005;
orbit.makeSafe();
camera.position.setFromSpherical(orbit);
camera.lookAt({ x: 0, y: 0, z: 0 });

Index

Constructors

constructor

new Spherical(radius?: number, phi?: number, theta?: number): Spherical
Creates a new Spherical
Parameters
- radius: number = 1
  Distance from origin
- phi: number = 0
  Polar angle (radians) measured from +Y
- theta: number = 0
  Azimuthal angle (radians) measured from +Z
Returns Spherical

Properties

phi

phi: number = 0

Angle in radians down from +Y: 0 points straight up, π / 2 lies level, π points straight down

Example

orbit.phi = Math.PI / 3;

radius

radius: number = 0

Distance from the origin

Example

orbit.radius = Math.max(2, orbit.radius - wheelDelta * 0.01);

theta

theta: number = 0

Angle in radians around +Y, measured from +Z toward +X

Example

orbit.theta += ticker.deltaMS * 0.0005;

`Readonly`type

type: SHAPE_PRIMITIVE_3D = 'spherical'

Names the shape without an instanceof check, like the type on pixi's 2D shapes

Default

'spherical'

Methods

clone

clone(): Spherical
Creates a copy of this spherical

Returns Spherical
A new Spherical with the same values
Example
```
const resetView = orbit.clone();
```

copyFrom

copyFrom(other: Spherical): this
Copies other into this spherical
Parameters
- other: Spherical
  The spherical to copy from
Returns this
This spherical, for chaining
Example
```
savedView.copyFrom(orbit);
```

copyTo

copyTo<T extends Spherical>(target: T): T
Copies this spherical into target
Type Parameters
- T extends Spherical
Parameters
- target: T
  The spherical to copy into
Returns T
The target with values updated
Example
```
orbit.copyTo(savedView);
```

equals

equals(other: Spherical): boolean
Checks whether other matches this spherical
Parameters
- other: Spherical
  The spherical to compare with
Returns boolean
true when radius, phi and theta match exactly (no epsilon tolerance)
Example
```
if (!orbit.equals(lastOrbit)) saveCameraState(orbit);
```

makeSafe

makeSafe(): this
Keeps phi a millionth of a radian away from both poles

A camera that looks at its target with +Y up flips at a pole, so call this after changing phi and before converting back.

Returns this
This spherical, for chaining
Example
```
orbit.phi -= pointerDeltaY * 0.01;
orbit.makeSafe();
```

set

set(radius: number, phi: number, theta: number): this
Sets radius, phi and theta
Parameters
- radius: number
  Distance from origin
- phi: number
  Polar angle (radians) measured from +Y
- theta: number
  Azimuthal angle (radians) measured from +Z
Returns this
This spherical, for chaining
Example
```
const sunDirection = new Vector3().setFromSpherical(new Spherical().set(1, sunPolarAngle, sunAzimuth));
```

setFromCartesianCoords

setFromCartesianCoords(x: number, y: number, z: number): this
Sets this spherical from Cartesian (x, y, z)

Zero-radius inputs collapse theta and phi to 0.
Parameters
- x: number
  Position on the x axis
- y: number
  Position on the y axis
- z: number
  Position on the z axis
Returns this
This spherical, for chaining
Example
```
orbit.setFromCartesianCoords(eye.x - target.x, eye.y - target.y, eye.z - target.z);
```

setFromPoint3D

setFromPoint3D(v: PointData3D): this
Sets this spherical from the Cartesian point v
Parameters
- v: PointData3D
  The Cartesian point to convert
Returns this
This spherical, for chaining
Example
```
const orbit = new Spherical().setFromPoint3D(camera.position);
```

toString

toString(): string

Advanced
Returns a readable string representation of this spherical

Returns string
A string in the form [@pixi/3d/math:Spherical radius=1 phi=0 theta=0]

Class Spherical

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Spherical

Properties

phi

Example

radius

Example

theta

Example

Readonlytype

Default

Methods

clone

Returns Spherical

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

equals

Parameters

Returns boolean

Example

makeSafe

Returns this

Example

set

Parameters

Returns this

Example

setFromCartesianCoords

Parameters

Returns this

Example

setFromPoint3D

Parameters

Returns this

Example

toString

Returns string

Settings

On This Page

`Readonly`type