📄 FrustumArray.js¶
📊 Analysis Summary¶
| Metric | Count |
|---|---|
| 🔧 Functions | 6 |
| 🧱 Classes | 1 |
| 📦 Imports | 3 |
| 📊 Variables & Constants | 7 |
📚 Table of Contents¶
🛠️ File Location:¶
📂 src/math/FrustumArray.js
📦 Imports¶
| Name | Source |
|---|---|
WebGLCoordinateSystem |
../constants.js |
Frustum |
./Frustum.js |
Matrix4 |
./Matrix4.js |
Variables & Constants¶
| Name | Type | Kind | Value | Exported |
|---|---|---|---|---|
_projScreenMatrix |
Matrix4 |
let/var | new Matrix4() |
✗ |
_frustum |
Frustum |
let/var | new Frustum() |
✗ |
camera |
any |
let/var | cameraArray.cameras[ i ] |
✗ |
camera |
any |
let/var | cameraArray.cameras[ i ] |
✗ |
camera |
any |
let/var | cameraArray.cameras[ i ] |
✗ |
camera |
any |
let/var | cameraArray.cameras[ i ] |
✗ |
camera |
any |
let/var | cameraArray.cameras[ i ] |
✗ |
Functions¶
FrustumArray.intersectsObject(object: Object3D, cameraArray: any): boolean¶
JSDoc:
/**
* Returns `true` if the 3D object's bounding sphere is intersecting any frustum
* from the camera array.
*
* @param {Object3D} object - The 3D object to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the 3D object is visible in any camera.
*/
Parameters:
objectObject3DcameraArrayany
Returns: boolean
Calls:
_projScreenMatrix.multiplyMatrices_frustum.setFromProjectionMatrix_frustum.intersectsObject
Code
intersectsObject( object, cameraArray ) {
if ( ! cameraArray.isArrayCamera || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsObject( object ) ) {
return true; // Object is visible in at least one camera
}
}
return false; // Not visible in any camera
}
FrustumArray.intersectsSprite(sprite: Sprite, cameraArray: any): boolean¶
JSDoc:
/**
* Returns `true` if the given sprite is intersecting any frustum
* from the camera array.
*
* @param {Sprite} sprite - The sprite to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the sprite is visible in any camera.
*/
Parameters:
spriteSpritecameraArrayany
Returns: boolean
Calls:
_projScreenMatrix.multiplyMatrices_frustum.setFromProjectionMatrix_frustum.intersectsSprite
Code
intersectsSprite( sprite, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSprite( sprite ) ) {
return true; // Sprite is visible in at least one camera
}
}
return false; // Not visible in any camera
}
FrustumArray.intersectsSphere(sphere: Sphere, cameraArray: any): boolean¶
JSDoc:
/**
* Returns `true` if the given bounding sphere is intersecting any frustum
* from the camera array.
*
* @param {Sphere} sphere - The bounding sphere to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the sphere is visible in any camera.
*/
Parameters:
sphereSpherecameraArrayany
Returns: boolean
Calls:
_projScreenMatrix.multiplyMatrices_frustum.setFromProjectionMatrix_frustum.intersectsSphere
Code
intersectsSphere( sphere, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSphere( sphere ) ) {
return true; // Sphere is visible in at least one camera
}
}
return false; // Not visible in any camera
}
FrustumArray.intersectsBox(box: Box3, cameraArray: any): boolean¶
JSDoc:
/**
* Returns `true` if the given bounding box is intersecting any frustum
* from the camera array.
*
* @param {Box3} box - The bounding box to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the box is visible in any camera.
*/
Parameters:
boxBox3cameraArrayany
Returns: boolean
Calls:
_projScreenMatrix.multiplyMatrices_frustum.setFromProjectionMatrix_frustum.intersectsBox
Code
intersectsBox( box, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsBox( box ) ) {
return true; // Box is visible in at least one camera
}
}
return false; // Not visible in any camera
}
FrustumArray.containsPoint(point: Vector3, cameraArray: any): boolean¶
JSDoc:
/**
* Returns `true` if the given point lies within any frustum
* from the camera array.
*
* @param {Vector3} point - The point to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the point is visible in any camera.
*/
Parameters:
pointVector3cameraArrayany
Returns: boolean
Calls:
_projScreenMatrix.multiplyMatrices_frustum.setFromProjectionMatrix_frustum.containsPoint
Code
containsPoint( point, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.containsPoint( point ) ) {
return true; // Point is visible in at least one camera
}
}
return false; // Not visible in any camera
}
FrustumArray.clone(): FrustumArray¶
JSDoc:
/**
* Returns a new frustum array with copied values from this instance.
*
* @return {FrustumArray} A clone of this instance.
*/
Returns: FrustumArray
Classes¶
FrustumArray¶
Class Code
class FrustumArray {
/**
* Constructs a new frustum array.
*
*/
constructor() {
/**
* The coordinate system to use.
*
* @type {WebGLCoordinateSystem|WebGPUCoordinateSystem}
* @default WebGLCoordinateSystem
*/
this.coordinateSystem = WebGLCoordinateSystem;
}
/**
* Returns `true` if the 3D object's bounding sphere is intersecting any frustum
* from the camera array.
*
* @param {Object3D} object - The 3D object to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the 3D object is visible in any camera.
*/
intersectsObject( object, cameraArray ) {
if ( ! cameraArray.isArrayCamera || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsObject( object ) ) {
return true; // Object is visible in at least one camera
}
}
return false; // Not visible in any camera
}
/**
* Returns `true` if the given sprite is intersecting any frustum
* from the camera array.
*
* @param {Sprite} sprite - The sprite to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the sprite is visible in any camera.
*/
intersectsSprite( sprite, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSprite( sprite ) ) {
return true; // Sprite is visible in at least one camera
}
}
return false; // Not visible in any camera
}
/**
* Returns `true` if the given bounding sphere is intersecting any frustum
* from the camera array.
*
* @param {Sphere} sphere - The bounding sphere to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the sphere is visible in any camera.
*/
intersectsSphere( sphere, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSphere( sphere ) ) {
return true; // Sphere is visible in at least one camera
}
}
return false; // Not visible in any camera
}
/**
* Returns `true` if the given bounding box is intersecting any frustum
* from the camera array.
*
* @param {Box3} box - The bounding box to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the box is visible in any camera.
*/
intersectsBox( box, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsBox( box ) ) {
return true; // Box is visible in at least one camera
}
}
return false; // Not visible in any camera
}
/**
* Returns `true` if the given point lies within any frustum
* from the camera array.
*
* @param {Vector3} point - The point to test.
* @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
* @return {boolean} Whether the point is visible in any camera.
*/
containsPoint( point, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.containsPoint( point ) ) {
return true; // Point is visible in at least one camera
}
}
return false; // Not visible in any camera
}
/**
* Returns a new frustum array with copied values from this instance.
*
* @return {FrustumArray} A clone of this instance.
*/
clone() {
return new FrustumArray();
}
}
Methods¶
intersectsObject(object: Object3D, cameraArray: any): boolean¶
Code
intersectsObject( object, cameraArray ) {
if ( ! cameraArray.isArrayCamera || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsObject( object ) ) {
return true; // Object is visible in at least one camera
}
}
return false; // Not visible in any camera
}
intersectsSprite(sprite: Sprite, cameraArray: any): boolean¶
Code
intersectsSprite( sprite, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSprite( sprite ) ) {
return true; // Sprite is visible in at least one camera
}
}
return false; // Not visible in any camera
}
intersectsSphere(sphere: Sphere, cameraArray: any): boolean¶
Code
intersectsSphere( sphere, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsSphere( sphere ) ) {
return true; // Sphere is visible in at least one camera
}
}
return false; // Not visible in any camera
}
intersectsBox(box: Box3, cameraArray: any): boolean¶
Code
intersectsBox( box, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.intersectsBox( box ) ) {
return true; // Box is visible in at least one camera
}
}
return false; // Not visible in any camera
}
containsPoint(point: Vector3, cameraArray: any): boolean¶
Code
containsPoint( point, cameraArray ) {
if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
return false;
}
for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
const camera = cameraArray.cameras[ i ];
_projScreenMatrix.multiplyMatrices(
camera.projectionMatrix,
camera.matrixWorldInverse
);
_frustum.setFromProjectionMatrix(
_projScreenMatrix,
camera.coordinateSystem,
camera.reversedDepth
);
if ( _frustum.containsPoint( point ) ) {
return true; // Point is visible in at least one camera
}
}
return false; // Not visible in any camera
}