dot big bang

Developer API
Menu

Class Frustum

All
  • Public
  • Public/Protected
  • All

Hierarchy

  • Frustum

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Frustum.

    Parameters

    • Optional p0: Plane

      First plane of the Frustum. Default is a new Plane.

    • Optional p1: Plane

      Second plane of the Frustum. Default is a new Plane.

    • Optional p2: Plane

      Third plane of the Frustum. Default is a new Plane.

    • Optional p3: Plane

      Fourth plane of the Frustum. Default is a new Plane.

    • Optional p4: Plane

      Fifth plane of the Frustum. Default is a new Plane.

    • Optional p5: Plane

      Sixth plane of the Frustum. Default is a new Plane.

    Returns Frustum

Properties

planes

planes: [Plane, Plane, Plane, Plane, Plane, Plane]

The 6 planes making up the Frustum.

Methods

clone

  • Return a new frustum with the same parameters as this one.

    Returns Frustum

containsPoint

  • containsPoint(point: Vector3): boolean

  • Returns true if this frustum contains the given point.

    Parameters

    • point: Vector3

      The point to check for inclusion.

    Returns boolean

copy

  • Copies the properties of the provided frustum into this one.

    Parameters

    Returns Frustum

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Returns true if this frustum intersects with the given box.

    Parameters

    • box: Box3

      The box to check for intersection with this frustum.

    Returns boolean

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Returns true if this frustum intersects with the given sphere.

    Parameters

    • sphere: Sphere

      The sphere to check for intersection with this frustum.

    Returns boolean

set

  • Sets the planes of this frustum.

    Parameters

    • p0: Plane

      First plane of the Frustum.

    • p1: Plane

      Second plane of the Frustum.

    • p2: Plane

      Third plane of the Frustum.

    • p3: Plane

      Fourth plane of the Frustum.

    • p4: Plane

      Fifth plane of the Frustum.

    • p5: Plane

      Sixth plane of the Frustum.

    Returns Frustum

setFromMatrix

  • Sets the planes of this frustum from the provided projection matrix m.

    Parameters

    • m: Matrix4

      The projection matrix to set this frustum from.

    Returns Frustum