Class Sphere

A sphere from center and radius, mostly used as a bounding volume

The cheapest volume to test, and unlike a Box it doesn't grow when rotated. Mesh3D#boundingSphere gives a mesh's bounding sphere in world space.

Example

const blast = new Sphere(new Vector3(), 4);

blast.center.copyFrom(grenade.position);
for (const enemy of enemies) {
  if (blast.intersectsSphere(enemy.boundingSphere)) enemy.takeDamage(50);
}

See

Ray#intersectSphere For the point where a ray hits the sphere

Index

Constructors

constructor

new Sphere(center?: Vector3, radius?: number): Sphere
Creates a new Sphere

Left out, the center is the origin and the radius is -1, which makes the sphere empty. A center passed in becomes the sphere's own; it is not copied.
Parameters
- Optionalcenter: Vector3
  The center of the sphere
- radius: number = -1
  The radius of the sphere
Returns Sphere

Properties

`Readonly`center

center: Vector3

The center of the sphere

Example

pickupRange.center.copyFrom(player.position);

radius

radius: number = 0

The radius of the sphere; negative values mark the sphere as empty

Example

shield.radius = 2 + Math.sin(time * 4) * 0.1;

`Readonly`type

type: SHAPE_PRIMITIVE_3D = 'sphere'

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

Default

'sphere'

Methods

applyMatrix4

applyMatrix4(matrix: Matrix4, out?: Sphere): this
Transforms this sphere by an affine matrix

The radius scales by the matrix's largest axis scale, so the sphere still bounds the shape under rotation and per-axis scale. Under shear, as when a non-uniformly scaled parent holds a rotated child, the radius can come out too small; for one that always fits, multiply the original radius by the square root of Matrix4#getMaxSingularValueSq yourself. An empty sphere stays empty.

matrix must be affine (bottom row [0, 0, 0, 1]), as a Container3D#worldTransform always is and a projection matrix isn't.
Parameters
- matrix: Matrix4
  The affine matrix to transform by
- out: Sphere = ...
  Target to write the result into instead of mutating this sphere
Returns this
The result sphere for chaining
Example
```
const worldBounds = new Sphere();

mesh.geometry.boundsSphere.applyMatrix4(mesh.worldTransform, worldBounds);
```

clone

clone(): Sphere
Creates a new Sphere with the same center and radius

Returns Sphere
The new sphere
Example
```
const snapshot = mesh.boundingSphere.clone();
```

containsPoint

containsPoint(point: PointData3D): boolean
Returns true when point is inside this sphere (boundary is inclusive)
Parameters
- point: PointData3D
  The point to test
Returns boolean
Whether the point is inside this sphere
Example
```
if (pickupRange.containsPoint(coin.position)) collect(coin);
```

copyFrom

copyFrom(sphere: Sphere): this
Copies sphere into this sphere
Parameters
- sphere: Sphere
  The sphere to copy from
Returns this
This sphere for chaining
Example
```
const cached = new Sphere().copyFrom(mesh.boundingSphere);
```

copyTo

copyTo<T extends Sphere>(target: T): T
Copies this sphere into target and returns it
Type Parameters
- T extends Sphere
Parameters
- target: T
  The sphere to copy into
Returns T
The given target
Example
```
mesh.boundingSphere.copyTo(cachedBounds);
```

distanceToPoint

distanceToPoint(point: PointData3D): number
Returns the signed distance from point to the surface of this sphere (negative when inside)
Parameters
- point: PointData3D
  The point to measure from
Returns number
The signed distance to the sphere surface
Example
```
const fade = Math.min(1, Math.max(0, -forceField.distanceToPoint(player.position)));
```

equals

equals(sphere: Sphere): boolean
Returns true when center and radius match sphere exactly (no epsilon tolerance)
Parameters
- sphere: Sphere
  The sphere to compare with
Returns boolean
Whether the center and radius match
Example
```
if (!mesh.boundingSphere.equals(lastBounds)) markShadowDirty();
```

getBounds

getBounds(out?: Box): Box
Writes the axis-aligned box around this sphere into out (or a new Box)

An empty sphere gives an empty box.
Parameters
- Optionalout: Box
  Optional box to write into; a new Box when omitted
Returns Box
The bounds of this sphere
Example
```
const bounds = mesh.boundingSphere.getBounds(scratchBox);
```

intersectsBox

intersectsBox(box: Box): boolean
Returns true when this sphere and box overlap; an empty sphere never does
Parameters
- box: Box
  The box to test
Returns boolean
Whether the sphere and box overlap
Example
```
if (blast.intersectsBox(crate.bounds)) crate.shatter();
```

intersectsPlane

intersectsPlane(plane: Plane): boolean
Returns true when plane passes through this sphere or touches it; never for an empty sphere
Parameters
- plane: Plane
  The plane to test
Returns boolean
Whether the plane passes through or touches the sphere
Example
```
const splashing = ball.boundingSphere.intersectsPlane(water);
```

intersectsRay

intersectsRay(ray: Ray): boolean
Returns true when ray hits this sphere; same as Ray#intersectsSphere
Parameters
- ray: Ray
  The ray to test
Returns boolean
Whether the ray hits this sphere
Example
```
const hovered = mesh.boundingSphere.intersectsRay(pointerRay);
```

intersectsSphere

intersectsSphere(sphere: Sphere): boolean
Returns true when this sphere and sphere overlap; an empty sphere never does
Parameters
- sphere: Sphere
  The sphere to test
Returns boolean
Whether the spheres overlap
Example
```
if (ball.boundingSphere.intersectsSphere(paddle.boundingSphere)) bounce();
```

isEmpty

isEmpty(): boolean
Returns true when this sphere is empty (radius < 0)

Returns boolean
Whether this sphere is empty
Example
```
if (!mesh.boundingSphere.isEmpty()) zoomTo(mesh.boundingSphere);
```

makeEmpty

makeEmpty(): this
Resets this sphere to the empty state (center = 0, radius = -1)

Returns this
This sphere for chaining
Example
```
if (!grenade.armed) blast.makeEmpty();
```

set

set(center: PointData3D, radius: number): this
Sets the center and radius of this sphere, copying the center
Parameters
- center: PointData3D
  The center of the sphere
- radius: number
  The radius of the sphere
Returns this
This sphere for chaining
Example
```
hearingRange.set(guard.position, 6);
```

setFromBox

setFromBox(box: Box): this
Sets this sphere to the smallest sphere around box's corners; an empty box gives an empty sphere
Parameters
- box: Box
  The box to bound
Returns this
This sphere for chaining
Example
```
const bounds = new Sphere().setFromBox(model.getLocalBounds());
```

toString

toString(): string

Advanced
Returns a string representation of this sphere

Returns string
A string in the form [@pixi/3d/math:Sphere center=(0, 0, 0) radius=1]

Class Sphere

Example

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Sphere

Properties

Readonlycenter

Example

radius

Example

Readonlytype

Default

Methods

applyMatrix4

Parameters

Returns this

Example

clone

Returns Sphere

Example

containsPoint

Parameters

Returns boolean

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

distanceToPoint

Parameters

Returns number

Example

equals

Parameters

Returns boolean

Example

getBounds

Parameters

Returns Box

Example

intersectsBox

Parameters

Returns boolean

Example

intersectsPlane

Parameters

Returns boolean

Example

intersectsRay

Parameters

Returns boolean

Example

intersectsSphere

Parameters

Returns boolean

Example

isEmpty

Returns boolean

Example

makeEmpty

Returns this

Example

set

Parameters

Returns this

Example

setFromBox

Parameters

Returns this

`Readonly`center

`Readonly`type