Class Frustum

Frustums are used to determine what is inside the camera's field of view. They help speed up the rendering process.

Index

Constructors

Properties

Methods

clone containsPoint copy intersectsBox intersectsObject intersectsSphere intersectsSprite set setFromProjectionMatrix

Constructors

constructor

new Frustum(
    p0?: Plane,
    p1?: Plane,
    p2?: Plane,
    p3?: Plane,
    p4?: Plane,
    p5?: Plane,
): Frustum
Parameters
- Optionalp0: Plane
- Optionalp1: Plane
- Optionalp2: Plane
- Optionalp3: Plane
- Optionalp4: Plane
- Optionalp5: Plane
Returns Frustum
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:14

Properties

planes

planes: Plane[]

Array of 6 vectors.

Methods

clone

clone(): this
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:22

containsPoint

containsPoint(point: Vector3): boolean
Parameters
- point: Vector3
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:29

copy

copy(frustum: Frustum): this
Parameters
- frustum: Frustum
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:23

intersectsBox

intersectsBox(box: Box3): boolean
Parameters
- box: Box3
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:28

intersectsObject

intersectsObject(object: Object3D): boolean
Parameters
- object: Object3D
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:25

intersectsSphere

intersectsSphere(sphere: Sphere): boolean
Parameters
- sphere: Sphere
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:27

intersectsSprite

intersectsSprite(sprite: Sprite): boolean
Parameters
- sprite: Sprite
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:26

set

set(p0: Plane, p1: Plane, p2: Plane, p3: Plane, p4: Plane, p5: Plane): Frustum
Parameters
- p0: Plane
- p1: Plane
- p2: Plane
- p3: Plane
- p4: Plane
- p5: Plane
Returns Frustum
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:21

setFromProjectionMatrix

setFromProjectionMatrix(
    m: Matrix4,
    coordinateSystem?: CoordinateSystem,
    reversedDepth?: boolean,
): this
Parameters
- m: Matrix4
- OptionalcoordinateSystem: CoordinateSystem
- OptionalreversedDepth: boolean
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Frustum.d.ts:24