Engine API Reference - v2.24.0-beta.33
    Preparing search index...

    Class BoundingSphere

    A bounding sphere is a volume for facilitating fast intersection testing.

    A sphere is a center and a radius. It is the cheapest bounding volume to test, so it suits broad-phase checks made before a finer test. containsPoint, intersectsBoundingSphere and intersectsRay return a boolean and allocate nothing. Unlike BoundingBox, the constructor keeps a reference to the center vector it is given rather than copying it, so the sphere follows any later changes to that vector.

    // A trigger volume 2 units around an entity
    const sphere = new BoundingSphere(entity.getPosition().clone(), 2);
    if (sphere.containsPoint(player.getPosition())) {
        // the player is within 2 units of the entity
    }
    Index
    constructor
    center radius
    containsPoint intersectsBoundingSphere intersectsRay

    • Creates a new BoundingSphere instance.

      Parameters

      • Optionalcenter: Vec3 = ...

        The world space coordinate marking the center of the sphere. The constructor takes a reference of this parameter.

      • Optionalradius: number = 0.5

        The radius of the bounding sphere. Defaults to 0.5.

      Returns BoundingSphere

      // Create a new bounding sphere centered on the origin with a radius of 0.5
      const sphere = new BoundingSphere();
    center: Vec3

    Center of sphere.

    radius: number

    The radius of the bounding sphere.

    • Test if a point is inside the sphere.

      Parameters

      • point: Vec3

        Point to test.

      Returns boolean

      True if the point is inside the sphere and false otherwise.

      const sphere = new BoundingSphere(new Vec3(0, 0, 0), 1);
      const point = new Vec3(0.5, 0, 0);
      const isInside = sphere.containsPoint(point); // true

    • Test if a Bounding Sphere is overlapping, enveloping, or inside this Bounding Sphere.

      Parameters

      Returns boolean

      True if the Bounding Sphere is overlapping, enveloping, or inside this Bounding Sphere and false otherwise.

    • Test if a ray intersects with the sphere. A ray that starts inside the sphere intersects it.

      Parameters

      • ray: Ray

        Ray to test against (direction must be normalized).

      • Optionalpoint: Vec3

        If there is an intersection, the intersection point will be copied into here. For a ray that starts inside the sphere, this is the point where the ray leaves it.

      Returns boolean

      True if there is an intersection.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods