Class Sphere

A 3D sphere — { centre, radius }. Sibling of Ellipse in the geometry surface; used by Octree / adapter.querySphere as the canonical 3D region-query shape, and by user code for any sphere-vs-sphere / sphere-vs-AABB collision check under Camera3d.

Not currently part of the BodyShape union — Body is 2D- only in melonJS today; Sphere is a math/geometry primitive that would slot in once a 3D physics adapter ships.

Example

import { Sphere } from "melonjs";

const a = new Sphere(0, 0, 0, 10);
const b = new Sphere(15, 0, 0, 10);
a.overlaps(b); // true — surfaces touch at x = 5

Index

Constructors

constructor

new Sphere(x: number, y: number, z: number, radius: number): Sphere
Parameters
- x: number
  centre x
- y: number
  centre y
- z: number
  centre z
- radius: number
  sphere radius
Returns Sphere
- Defined in packages/melonjs/src/geometries/sphere.ts:44

Properties

pos

pos: Vector3d

Centre coordinates of the sphere (Y-down, +Z forward — Camera3d convention).

radius

radius: number

Sphere radius. Negative values are treated like their absolute value in Sphere.overlaps / Sphere.contains.

Methods

clear

clear(): Sphere
Reset the sphere to a zero-radius point at the origin.

Returns Sphere
- Defined in packages/melonjs/src/geometries/sphere.ts:161

clone

clone(): Sphere
Deep copy of this sphere. The clone shares NOTHING with the original — independent pos Vector3d, independent AABB cache. Pulls from spherePool so back-to-back clones are allocation-free.

Returns Sphere
- Defined in packages/melonjs/src/geometries/sphere.ts:176

contains

contains(x: number, y: number, z: number): boolean
Test whether a point lies inside the sphere (boundary inclusive). Squared-distance test — no sqrt on the hot path. Matches the boundary convention of AABB3d.contains.
Parameters
- x: number
  point x
- y: number
  point y
- z: number
  point z
Returns boolean
- Defined in packages/melonjs/src/geometries/sphere.ts:76
contains(v: Vector3d): boolean
Vector form of Sphere.contains.
Parameters
- v: Vector3d
  point
Returns boolean
- Defined in packages/melonjs/src/geometries/sphere.ts:81

getBounds

getBounds(): AABB3d
Smallest AABB3d containing this sphere. Cached — repeat calls without a setShape between return the same instance and the same values.

Returns AABB3d
- Defined in packages/melonjs/src/geometries/sphere.ts:137

overlaps

overlaps(other: Sphere): boolean
Test whether this sphere overlaps another. Boundary inclusive (touching surfaces count as overlap), matching AABB3d.overlaps.
Parameters
- other: Sphere
  the other sphere
Returns boolean
- Defined in packages/melonjs/src/geometries/sphere.ts:109

overlapsAABB

overlapsAABB(aabb: AABB3d): boolean
Test whether this sphere overlaps an axis-aligned box. Delegates to AABB3d.overlapsSphere so the two shapes agree on boundary semantics.
Parameters
- aabb: AABB3d
  the box
Returns boolean
- Defined in packages/melonjs/src/geometries/sphere.ts:128

setShape

setShape(x: number, y: number, z: number, radius: number): Sphere
Re-position and resize the sphere in one shot. Mirrors Ellipse.setShape.
Parameters
- x: number
  centre x
- y: number
  centre y
- z: number
  centre z
- radius: number
  sphere radius
Returns Sphere
this sphere for chaining
- Defined in packages/melonjs/src/geometries/sphere.ts:58

Class Sphere

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Sphere

Properties

pos

radius

Methods

clear

Returns Sphere

clone

Returns Sphere

contains

Parameters

Returns boolean

Parameters

Returns boolean

getBounds

Returns AABB3d

overlaps

Parameters

Returns boolean

overlapsAABB

Parameters

Returns boolean

setShape

Parameters

Returns Sphere

Settings

On This Page