📄 `Projector.js`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	22
🧱 Classes	6
📦 Imports	9
📊 Variables & Constants	89

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 examples/jsm/renderers/Projector.js

📦 Imports¶

Name	Source
`Box3`	`three`
`Color`	`three`
`DoubleSide`	`three`
`Frustum`	`three`
`Matrix3`	`three`
`Matrix4`	`three`
`Vector2`	`three`
`Vector3`	`three`
`Vector4`	`three`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`_object`	`any`	let/var	`not shown`	✗
`_objectCount`	`any`	let/var	`not shown`	✗
`_objectPoolLength`	`number`	let/var	`0`	✗
`_vertex`	`any`	let/var	`not shown`	✗
`_vertexCount`	`any`	let/var	`not shown`	✗
`_vertexPoolLength`	`number`	let/var	`0`	✗
`_face`	`any`	let/var	`not shown`	✗
`_faceCount`	`any`	let/var	`not shown`	✗
`_facePoolLength`	`number`	let/var	`0`	✗
`_line`	`any`	let/var	`not shown`	✗
`_lineCount`	`any`	let/var	`not shown`	✗
`_linePoolLength`	`number`	let/var	`0`	✗
`_sprite`	`any`	let/var	`not shown`	✗
`_spriteCount`	`any`	let/var	`not shown`	✗
`_spritePoolLength`	`number`	let/var	`0`	✗
`_modelMatrix`	`any`	let/var	`not shown`	✗
`_renderData`	`{ objects: any[]; lights: any[]; elem...`	let/var	`{ objects: [], lights: [], elements: [] }`	✗
`_vector3`	`any`	let/var	`new Vector3()`	✗
`_vector4`	`any`	let/var	`new Vector4()`	✗
`_clipBox`	`any`	let/var	`new Box3( new Vector3( - 1, - 1, - 1 ), new Vector3( 1, 1, 1 ) )`	✗
`_boundingBox`	`any`	let/var	`new Box3()`	✗
`_points3`	`any[]`	let/var	`new Array( 3 )`	✗
`_viewMatrix`	`any`	let/var	`new Matrix4()`	✗
`_viewProjectionMatrix`	`any`	let/var	`new Matrix4()`	✗
`_modelViewProjectionMatrix`	`any`	let/var	`new Matrix4()`	✗
`_frustum`	`any`	let/var	`new Frustum()`	✗
`_objectPool`	`any[]`	let/var	`[]`	✗
`_vertexPool`	`any[]`	let/var	`[]`	✗
`_facePool`	`any[]`	let/var	`[]`	✗
`_linePool`	`any[]`	let/var	`[]`	✗
`_spritePool`	`any[]`	let/var	`[]`	✗
`normals`	`any[]`	let/var	`[]`	✗
`colors`	`any[]`	let/var	`[]`	✗
`uvs`	`any[]`	let/var	`[]`	✗
`object`	`any`	let/var	`null`	✗
`normalMatrix`	`any`	let/var	`new Matrix3()`	✗
`position`	`any`	let/var	`vertex.position`	✗
`positionWorld`	`any`	let/var	`vertex.positionWorld`	✗
`positionScreen`	`any`	let/var	`vertex.positionScreen`	✗
`invW`	`number`	let/var	`1 / positionScreen.w`	✗
`v1`	`any`	let/var	`_vertexPool[ a ]`	✗
`v2`	`any`	let/var	`_vertexPool[ b ]`	✗
`v1`	`any`	let/var	`_vertexPool[ a ]`	✗
`v2`	`any`	let/var	`_vertexPool[ b ]`	✗
`v3`	`any`	let/var	`_vertexPool[ c ]`	✗
`normal`	`any`	let/var	`_face.vertexNormalsModel[ i ]`	✗
`uv`	`any`	let/var	`_face.uvs[ i ]`	✗
`renderList`	`any`	let/var	`new RenderList()`	✗
`children`	`any`	let/var	`object.children`	✗
`objects`	`any[]`	let/var	`_renderData.objects`	✗
`object`	`any`	let/var	`objects[ o ].object`	✗
`geometry`	`any`	let/var	`object.geometry`	✗
`material`	`any`	let/var	`object.material`	✗
`attributes`	`any`	let/var	`geometry.attributes`	✗
`groups`	`any`	let/var	`geometry.groups`	✗
`positions`	`any`	let/var	`attributes.position.array`	✗
`x`	`any`	let/var	`positions[ i ]`	✗
`y`	`any`	let/var	`positions[ i + 1 ]`	✗
`z`	`any`	let/var	`positions[ i + 2 ]`	✗
`morphTargets`	`any`	let/var	`geometry.morphAttributes.position`	✗
`morphTargetsRelative`	`any`	let/var	`geometry.morphTargetsRelative`	✗
`morphInfluences`	`any`	let/var	`object.morphTargetInfluences`	✗
`influence`	`any`	let/var	`morphInfluences[ t ]`	✗
`target`	`any`	let/var	`morphTargets[ t ]`	✗
`normals`	`any`	let/var	`attributes.normal.array`	✗
`colors`	`any`	let/var	`attributes.color.array`	✗
`uvs`	`any`	let/var	`attributes.uv.array`	✗
`indices`	`any`	let/var	`geometry.index.array`	✗
`group`	`any`	let/var	`groups[ g ]`	✗
`group`	`any`	let/var	`groups[ g ]`	✗
`attributes`	`any`	let/var	`geometry.attributes`	✗
`positions`	`any`	let/var	`attributes.position.array`	✗
`colors`	`any`	let/var	`attributes.color.array`	✗
`indices`	`any`	let/var	`geometry.index.array`	✗
`step`	`1 \\| 2`	let/var	`object.isLineSegments ? 2 : 1`	✗
`attributes`	`any`	let/var	`geometry.attributes`	✗
`positions`	`any`	let/var	`attributes.position.array`	✗
`invW`	`number`	let/var	`1 / _vector4.w`	✗
`object`	`RenderableObject`	let/var	`new RenderableObject()`	✗
`vertex`	`RenderableVertex`	let/var	`new RenderableVertex()`	✗
`face`	`RenderableFace`	let/var	`new RenderableFace()`	✗
`line`	`RenderableLine`	let/var	`new RenderableLine()`	✗
`sprite`	`RenderableSprite`	let/var	`new RenderableSprite()`	✗
`alpha1`	`number`	let/var	`0`	✗
`alpha2`	`number`	let/var	`1`	✗
`bc1near`	`any`	let/var	`s1.z + s1.w`	✗
`bc2near`	`any`	let/var	`s2.z + s2.w`	✗
`bc1far`	`any`	let/var	`- s1.z + s1.w`	✗
`bc2far`	`any`	let/var	`- s2.z + s2.w`	✗

Functions¶

`RenderableVertex.copy(vertex: any): void`¶

Parameters:

vertex any

Returns: void

Calls:

this.positionWorld.copy
this.positionScreen.copy

Code

copy( vertex ) {

        this.positionWorld.copy( vertex.positionWorld );
        this.positionScreen.copy( vertex.positionScreen );

    }

`RenderList(): { setObject: (value: any) => void; projectVertex: (vertex: any) => void; checkTriangleVisibility: (v1: any, v2: any, v3: any) => any; checkBackfaceCulling: (v1: any, v2: any, v3: any) => boolean; ... 5 more ...; pushTriangle: (a: any, b: any, c: any, material: any, ...args: any[]) => void; }`¶

Returns: { setObject: (value: any) => void; projectVertex: (vertex: any) => void; checkTriangleVisibility: (v1: any, v2: any, v3: any) => any; checkBackfaceCulling: (v1: any, v2: any, v3: any) => boolean; ... 5 more ...; pushTriangle: (a: any, b: any, c: any, material: any, ...args: any[]) => void; }

Calls:

normalMatrix.getNormalMatrix
positionWorld.copy( position ).applyMatrix4
positionScreen.copy( positionWorld ).applyMatrix4
getNextVertexInPool
_vertex.position.set
projectVertex
normals.push
colors.push
uvs.push
_clipBox.intersectsBox
_boundingBox.setFromPoints
v1.positionScreen.copy( v1.position ).applyMatrix4
v2.positionScreen.copy( v2.position ).applyMatrix4
clipLine
v1.positionScreen.multiplyScalar
v2.positionScreen.multiplyScalar
getNextLineInPool
_line.v1.copy
_line.v2.copy
Math.max
_line.vertexColors[ 0 ].fromArray
_line.vertexColors[ 1 ].fromArray
_renderData.elements.push
checkTriangleVisibility
checkBackfaceCulling
getNextFaceInPool
_face.v1.copy
_face.v2.copy
_face.v3.copy
_vector3.subVectors
_vector4.subVectors
_vector3.cross
_face.normalModel.copy
_face.normalModel.applyMatrix3( normalMatrix ).normalize
normal.fromArray
normal.applyMatrix3( normalMatrix ).normalize
uv.fromArray
_face.color.fromArray

Internal Comments:

// Clip (x7)
// Perform the perspective divide (x5)
// face normal (x4)

Code

function RenderList() {

            const normals = [];
            const colors = [];
            const uvs = [];

            let object = null;

            const normalMatrix = new Matrix3();

            function setObject( value ) {

                object = value;

                normalMatrix.getNormalMatrix( object.matrixWorld );

                normals.length = 0;
                colors.length = 0;
                uvs.length = 0;

            }

            function projectVertex( vertex ) {

                const position = vertex.position;
                const positionWorld = vertex.positionWorld;
                const positionScreen = vertex.positionScreen;

                positionWorld.copy( position ).applyMatrix4( _modelMatrix );
                positionScreen.copy( positionWorld ).applyMatrix4( _viewProjectionMatrix );

                const invW = 1 / positionScreen.w;

                positionScreen.x *= invW;
                positionScreen.y *= invW;
                positionScreen.z *= invW;

                vertex.visible = positionScreen.x >= - 1 && positionScreen.x <= 1 &&
                         positionScreen.y >= - 1 && positionScreen.y <= 1 &&
                         positionScreen.z >= - 1 && positionScreen.z <= 1;

            }

            function pushVertex( x, y, z ) {

                _vertex = getNextVertexInPool();
                _vertex.position.set( x, y, z );

                projectVertex( _vertex );

            }

            function pushNormal( x, y, z ) {

                normals.push( x, y, z );

            }

            function pushColor( r, g, b ) {

                colors.push( r, g, b );

            }

            function pushUv( x, y ) {

                uvs.push( x, y );

            }

            function checkTriangleVisibility( v1, v2, v3 ) {

                if ( v1.visible === true || v2.visible === true || v3.visible === true ) return true;

                _points3[ 0 ] = v1.positionScreen;
                _points3[ 1 ] = v2.positionScreen;
                _points3[ 2 ] = v3.positionScreen;

                return _clipBox.intersectsBox( _boundingBox.setFromPoints( _points3 ) );

            }

            function checkBackfaceCulling( v1, v2, v3 ) {

                return ( ( v3.positionScreen.x - v1.positionScreen.x ) *
                        ( v2.positionScreen.y - v1.positionScreen.y ) -
                        ( v3.positionScreen.y - v1.positionScreen.y ) *
                        ( v2.positionScreen.x - v1.positionScreen.x ) ) < 0;

            }

            function pushLine( a, b ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];

                // Clip

                v1.positionScreen.copy( v1.position ).applyMatrix4( _modelViewProjectionMatrix );
                v2.positionScreen.copy( v2.position ).applyMatrix4( _modelViewProjectionMatrix );

                if ( clipLine( v1.positionScreen, v2.positionScreen ) === true ) {

                    // Perform the perspective divide
                    v1.positionScreen.multiplyScalar( 1 / v1.positionScreen.w );
                    v2.positionScreen.multiplyScalar( 1 / v2.positionScreen.w );

                    _line = getNextLineInPool();
                    _line.id = object.id;
                    _line.v1.copy( v1 );
                    _line.v2.copy( v2 );
                    _line.z = Math.max( v1.positionScreen.z, v2.positionScreen.z );
                    _line.renderOrder = object.renderOrder;

                    _line.material = object.material;

                    if ( object.material.vertexColors ) {

                        _line.vertexColors[ 0 ].fromArray( colors, a * 3 );
                        _line.vertexColors[ 1 ].fromArray( colors, b * 3 );

                    }

                    _renderData.elements.push( _line );

                }

            }

            function pushTriangle( a, b, c, material ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];
                const v3 = _vertexPool[ c ];

                if ( checkTriangleVisibility( v1, v2, v3 ) === false ) return;

                if ( material.side === DoubleSide || checkBackfaceCulling( v1, v2, v3 ) === true ) {

                    _face = getNextFaceInPool();

                    _face.id = object.id;
                    _face.v1.copy( v1 );
                    _face.v2.copy( v2 );
                    _face.v3.copy( v3 );
                    _face.z = ( v1.positionScreen.z + v2.positionScreen.z + v3.positionScreen.z ) / 3;
                    _face.renderOrder = object.renderOrder;

                    // face normal
                    _vector3.subVectors( v3.position, v2.position );
                    _vector4.subVectors( v1.position, v2.position );
                    _vector3.cross( _vector4 );
                    _face.normalModel.copy( _vector3 );
                    _face.normalModel.applyMatrix3( normalMatrix ).normalize();

                    for ( let i = 0; i < 3; i ++ ) {

                        const normal = _face.vertexNormalsModel[ i ];
                        normal.fromArray( normals, arguments[ i ] * 3 );
                        normal.applyMatrix3( normalMatrix ).normalize();

                        const uv = _face.uvs[ i ];
                        uv.fromArray( uvs, arguments[ i ] * 2 );

                    }

                    _face.vertexNormalsLength = 3;

                    _face.material = material;

                    if ( material.vertexColors ) {

                        _face.color.fromArray( colors, a * 3 );

                    }

                    _renderData.elements.push( _face );

                }

            }

            return {
                setObject: setObject,
                projectVertex: projectVertex,
                checkTriangleVisibility: checkTriangleVisibility,
                checkBackfaceCulling: checkBackfaceCulling,
                pushVertex: pushVertex,
                pushNormal: pushNormal,
                pushColor: pushColor,
                pushUv: pushUv,
                pushLine: pushLine,
                pushTriangle: pushTriangle
            };

        }

`setObject(value: any): void`¶

Parameters:

value any

Returns: void

Calls:

normalMatrix.getNormalMatrix

Code

function setObject( value ) {

                object = value;

                normalMatrix.getNormalMatrix( object.matrixWorld );

                normals.length = 0;
                colors.length = 0;
                uvs.length = 0;

            }

`projectVertex(vertex: any): void`¶

Parameters:

vertex any

Returns: void

Calls:

positionWorld.copy( position ).applyMatrix4
positionScreen.copy( positionWorld ).applyMatrix4

Code

function projectVertex( vertex ) {

                const position = vertex.position;
                const positionWorld = vertex.positionWorld;
                const positionScreen = vertex.positionScreen;

                positionWorld.copy( position ).applyMatrix4( _modelMatrix );
                positionScreen.copy( positionWorld ).applyMatrix4( _viewProjectionMatrix );

                const invW = 1 / positionScreen.w;

                positionScreen.x *= invW;
                positionScreen.y *= invW;
                positionScreen.z *= invW;

                vertex.visible = positionScreen.x >= - 1 && positionScreen.x <= 1 &&
                         positionScreen.y >= - 1 && positionScreen.y <= 1 &&
                         positionScreen.z >= - 1 && positionScreen.z <= 1;

            }

`pushVertex(x: any, y: any, z: any): void`¶

Parameters:

x any
y any
z any

Returns: void

Calls:

getNextVertexInPool
_vertex.position.set
projectVertex

Code

function pushVertex( x, y, z ) {

                _vertex = getNextVertexInPool();
                _vertex.position.set( x, y, z );

                projectVertex( _vertex );

            }

`pushNormal(x: any, y: any, z: any): void`¶

Parameters:

x any
y any
z any

Returns: void

Calls:

normals.push

Code

function pushNormal( x, y, z ) {

                normals.push( x, y, z );

            }

`pushColor(r: any, g: any, b: any): void`¶

Parameters:

r any
g any
b any

Returns: void

Calls:

colors.push

Code

function pushColor( r, g, b ) {

                colors.push( r, g, b );

            }

`pushUv(x: any, y: any): void`¶

Parameters:

x any
y any

Returns: void

Calls:

uvs.push

Code

function pushUv( x, y ) {

                uvs.push( x, y );

            }

`checkTriangleVisibility(v1: any, v2: any, v3: any): any`¶

Parameters:

v1 any
v2 any
v3 any

Returns: any

Calls:

_clipBox.intersectsBox
_boundingBox.setFromPoints

Code

function checkTriangleVisibility( v1, v2, v3 ) {

                if ( v1.visible === true || v2.visible === true || v3.visible === true ) return true;

                _points3[ 0 ] = v1.positionScreen;
                _points3[ 1 ] = v2.positionScreen;
                _points3[ 2 ] = v3.positionScreen;

                return _clipBox.intersectsBox( _boundingBox.setFromPoints( _points3 ) );

            }

`checkBackfaceCulling(v1: any, v2: any, v3: any): boolean`¶

Parameters:

v1 any
v2 any
v3 any

Returns: boolean

Code

function checkBackfaceCulling( v1, v2, v3 ) {

                return ( ( v3.positionScreen.x - v1.positionScreen.x ) *
                        ( v2.positionScreen.y - v1.positionScreen.y ) -
                        ( v3.positionScreen.y - v1.positionScreen.y ) *
                        ( v2.positionScreen.x - v1.positionScreen.x ) ) < 0;

            }

`pushLine(a: any, b: any): void`¶

Parameters:

a any
b any

Returns: void

Calls:

v1.positionScreen.copy( v1.position ).applyMatrix4
v2.positionScreen.copy( v2.position ).applyMatrix4
clipLine
v1.positionScreen.multiplyScalar
v2.positionScreen.multiplyScalar
getNextLineInPool
_line.v1.copy
_line.v2.copy
Math.max
_line.vertexColors[ 0 ].fromArray
_line.vertexColors[ 1 ].fromArray
_renderData.elements.push

Internal Comments:

// Clip (x7)
// Perform the perspective divide (x5)

Code

function pushLine( a, b ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];

                // Clip

                v1.positionScreen.copy( v1.position ).applyMatrix4( _modelViewProjectionMatrix );
                v2.positionScreen.copy( v2.position ).applyMatrix4( _modelViewProjectionMatrix );

                if ( clipLine( v1.positionScreen, v2.positionScreen ) === true ) {

                    // Perform the perspective divide
                    v1.positionScreen.multiplyScalar( 1 / v1.positionScreen.w );
                    v2.positionScreen.multiplyScalar( 1 / v2.positionScreen.w );

                    _line = getNextLineInPool();
                    _line.id = object.id;
                    _line.v1.copy( v1 );
                    _line.v2.copy( v2 );
                    _line.z = Math.max( v1.positionScreen.z, v2.positionScreen.z );
                    _line.renderOrder = object.renderOrder;

                    _line.material = object.material;

                    if ( object.material.vertexColors ) {

                        _line.vertexColors[ 0 ].fromArray( colors, a * 3 );
                        _line.vertexColors[ 1 ].fromArray( colors, b * 3 );

                    }

                    _renderData.elements.push( _line );

                }

            }

`pushTriangle(a: any, b: any, c: any, material: any): void`¶

Parameters:

a any
b any
c any
material any

Returns: void

Calls:

checkTriangleVisibility
checkBackfaceCulling
getNextFaceInPool
_face.v1.copy
_face.v2.copy
_face.v3.copy
_vector3.subVectors
_vector4.subVectors
_vector3.cross
_face.normalModel.copy
_face.normalModel.applyMatrix3( normalMatrix ).normalize
normal.fromArray
normal.applyMatrix3( normalMatrix ).normalize
uv.fromArray
_face.color.fromArray
_renderData.elements.push

Internal Comments:

// face normal (x4)

Code

function pushTriangle( a, b, c, material ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];
                const v3 = _vertexPool[ c ];

                if ( checkTriangleVisibility( v1, v2, v3 ) === false ) return;

                if ( material.side === DoubleSide || checkBackfaceCulling( v1, v2, v3 ) === true ) {

                    _face = getNextFaceInPool();

                    _face.id = object.id;
                    _face.v1.copy( v1 );
                    _face.v2.copy( v2 );
                    _face.v3.copy( v3 );
                    _face.z = ( v1.positionScreen.z + v2.positionScreen.z + v3.positionScreen.z ) / 3;
                    _face.renderOrder = object.renderOrder;

                    // face normal
                    _vector3.subVectors( v3.position, v2.position );
                    _vector4.subVectors( v1.position, v2.position );
                    _vector3.cross( _vector4 );
                    _face.normalModel.copy( _vector3 );
                    _face.normalModel.applyMatrix3( normalMatrix ).normalize();

                    for ( let i = 0; i < 3; i ++ ) {

                        const normal = _face.vertexNormalsModel[ i ];
                        normal.fromArray( normals, arguments[ i ] * 3 );
                        normal.applyMatrix3( normalMatrix ).normalize();

                        const uv = _face.uvs[ i ];
                        uv.fromArray( uvs, arguments[ i ] * 2 );

                    }

                    _face.vertexNormalsLength = 3;

                    _face.material = material;

                    if ( material.vertexColors ) {

                        _face.color.fromArray( colors, a * 3 );

                    }

                    _renderData.elements.push( _face );

                }

            }

`projectObject(object: any): void`¶

Parameters:

object any

Returns: void

Calls:

_renderData.lights.push
_frustum.intersectsObject
addObject
_frustum.intersectsSprite
projectObject

Code

function projectObject( object ) {

            if ( object.visible === false ) return;

            if ( object.isLight ) {

                _renderData.lights.push( object );

            } else if ( object.isMesh || object.isLine || object.isPoints ) {

                if ( object.material.visible === false ) return;
                if ( object.frustumCulled === true && _frustum.intersectsObject( object ) === false ) return;

                addObject( object );

            } else if ( object.isSprite ) {

                if ( object.material.visible === false ) return;
                if ( object.frustumCulled === true && _frustum.intersectsSprite( object ) === false ) return;

                addObject( object );

            }

            const children = object.children;

            for ( let i = 0, l = children.length; i < l; i ++ ) {

                projectObject( children[ i ] );

            }

        }

`addObject(object: any): void`¶

Parameters:

object any

Returns: void

Calls:

getNextObjectInPool
_vector3.setFromMatrixPosition
_vector3.applyMatrix4
_renderData.objects.push

Code

function addObject( object ) {

            _object = getNextObjectInPool();
            _object.id = object.id;
            _object.object = object;

            _vector3.setFromMatrixPosition( object.matrixWorld );
            _vector3.applyMatrix4( _viewProjectionMatrix );
            _object.z = _vector3.z;
            _object.renderOrder = object.renderOrder;

            _renderData.objects.push( _object );

        }

`pushPoint(_vector4: any, object: any, camera: any): void`¶

Parameters:

_vector4 any
object any
camera any

Returns: void

Calls:

getNextSpriteInPool
Math.abs
_renderData.elements.push

Code

function pushPoint( _vector4, object, camera ) {

            const invW = 1 / _vector4.w;

            _vector4.z *= invW;

            if ( _vector4.z >= - 1 && _vector4.z <= 1 ) {

                _sprite = getNextSpriteInPool();
                _sprite.id = object.id;
                _sprite.x = _vector4.x * invW;
                _sprite.y = _vector4.y * invW;
                _sprite.z = _vector4.z;
                _sprite.renderOrder = object.renderOrder;
                _sprite.object = object;

                _sprite.rotation = object.rotation;

                _sprite.scale.x = object.scale.x * Math.abs( _sprite.x - ( _vector4.x + camera.projectionMatrix.elements[ 0 ] ) / ( _vector4.w + camera.projectionMatrix.elements[ 12 ] ) );
                _sprite.scale.y = object.scale.y * Math.abs( _sprite.y - ( _vector4.y + camera.projectionMatrix.elements[ 5 ] ) / ( _vector4.w + camera.projectionMatrix.elements[ 13 ] ) );

                _sprite.material = object.material;

                _renderData.elements.push( _sprite );

            }

        }

`getNextObjectInPool(): any`¶

Returns: any

Calls:

_objectPool.push

Code

function getNextObjectInPool() {

            if ( _objectCount === _objectPoolLength ) {

                const object = new RenderableObject();
                _objectPool.push( object );
                _objectPoolLength ++;
                _objectCount ++;
                return object;

            }

            return _objectPool[ _objectCount ++ ];

        }

`getNextVertexInPool(): any`¶

Returns: any

Calls:

_vertexPool.push

Code

function getNextVertexInPool() {

            if ( _vertexCount === _vertexPoolLength ) {

                const vertex = new RenderableVertex();
                _vertexPool.push( vertex );
                _vertexPoolLength ++;
                _vertexCount ++;
                return vertex;

            }

            return _vertexPool[ _vertexCount ++ ];

        }

`getNextFaceInPool(): any`¶

Returns: any

Calls:

_facePool.push

Code

function getNextFaceInPool() {

            if ( _faceCount === _facePoolLength ) {

                const face = new RenderableFace();
                _facePool.push( face );
                _facePoolLength ++;
                _faceCount ++;
                return face;

            }

            return _facePool[ _faceCount ++ ];


        }

`getNextLineInPool(): any`¶

Returns: any

Calls:

_linePool.push

Code

function getNextLineInPool() {

            if ( _lineCount === _linePoolLength ) {

                const line = new RenderableLine();
                _linePool.push( line );
                _linePoolLength ++;
                _lineCount ++;
                return line;

            }

            return _linePool[ _lineCount ++ ];

        }

`getNextSpriteInPool(): any`¶

Returns: any

Calls:

_spritePool.push

Code

function getNextSpriteInPool() {

            if ( _spriteCount === _spritePoolLength ) {

                const sprite = new RenderableSprite();
                _spritePool.push( sprite );
                _spritePoolLength ++;
                _spriteCount ++;
                return sprite;

            }

            return _spritePool[ _spriteCount ++ ];

        }

`painterSort(a: any, b: any): number`¶

Parameters:

a any
b any

Returns: number

Code

function painterSort( a, b ) {

            if ( a.renderOrder !== b.renderOrder ) {

                return a.renderOrder - b.renderOrder;

            } else if ( a.z !== b.z ) {

                return b.z - a.z;

            } else if ( a.id !== b.id ) {

                return a.id - b.id;

            } else {

                return 0;

            }

        }

`clipLine(s1: any, s2: any): boolean`¶

Parameters:

s1 any
s2 any

Returns: boolean

Calls:

Math.max
Math.min
s1.lerp
s2.lerp

Internal Comments:

// Calculate the boundary coordinate of each vertex for the near and far clip planes, (x2)
// Z = -1 and Z = +1, respectively. (x2)
// Both vertices lie entirely within all clip planes.
// Both vertices lie entirely outside one of the clip planes.
// The line segment spans at least one clip plane.
// v1 lies outside the near plane, v2 inside (x3)
// v2 lies outside the near plane, v1 inside (x3)
// v1 lies outside the far plane, v2 inside (x3)
// v2 lies outside the far plane, v2 inside (x3)
// The line segment spans two boundaries, but is outside both of them.
// (This can't happen when we're only clipping against just near/far but good
//  to leave the check here for future usage if other clip planes are added.)
// Update the s1 and s2 vertices to match the clipped line segment. (x4)

Code

function clipLine( s1, s2 ) {

            let alpha1 = 0, alpha2 = 1;

            // Calculate the boundary coordinate of each vertex for the near and far clip planes,
            // Z = -1 and Z = +1, respectively.

            const bc1near = s1.z + s1.w,
                bc2near = s2.z + s2.w,
                bc1far = - s1.z + s1.w,
                bc2far = - s2.z + s2.w;

            if ( bc1near >= 0 && bc2near >= 0 && bc1far >= 0 && bc2far >= 0 ) {

                // Both vertices lie entirely within all clip planes.
                return true;

            } else if ( ( bc1near < 0 && bc2near < 0 ) || ( bc1far < 0 && bc2far < 0 ) ) {

                // Both vertices lie entirely outside one of the clip planes.
                return false;

            } else {

                // The line segment spans at least one clip plane.

                if ( bc1near < 0 ) {

                    // v1 lies outside the near plane, v2 inside
                    alpha1 = Math.max( alpha1, bc1near / ( bc1near - bc2near ) );

                } else if ( bc2near < 0 ) {

                    // v2 lies outside the near plane, v1 inside
                    alpha2 = Math.min( alpha2, bc1near / ( bc1near - bc2near ) );

                }

                if ( bc1far < 0 ) {

                    // v1 lies outside the far plane, v2 inside
                    alpha1 = Math.max( alpha1, bc1far / ( bc1far - bc2far ) );

                } else if ( bc2far < 0 ) {

                    // v2 lies outside the far plane, v2 inside
                    alpha2 = Math.min( alpha2, bc1far / ( bc1far - bc2far ) );

                }

                if ( alpha2 < alpha1 ) {

                    // The line segment spans two boundaries, but is outside both of them.
                    // (This can't happen when we're only clipping against just near/far but good
                    //  to leave the check here for future usage if other clip planes are added.)
                    return false;

                } else {

                    // Update the s1 and s2 vertices to match the clipped line segment.
                    s1.lerp( s2, alpha1 );
                    s2.lerp( s1, 1 - alpha2 );

                    return true;

                }

            }

        }

Classes¶

`RenderableObject`¶

Class Code

class RenderableObject {

    constructor() {

        this.id = 0;

        this.object = null;
        this.z = 0;
        this.renderOrder = 0;

    }

}

`RenderableFace`¶

Class Code

class RenderableFace {

    constructor() {

        this.id = 0;

        this.v1 = new RenderableVertex();
        this.v2 = new RenderableVertex();
        this.v3 = new RenderableVertex();

        this.normalModel = new Vector3();

        this.vertexNormalsModel = [ new Vector3(), new Vector3(), new Vector3() ];
        this.vertexNormalsLength = 0;

        this.color = new Color();
        this.material = null;
        this.uvs = [ new Vector2(), new Vector2(), new Vector2() ];

        this.z = 0;
        this.renderOrder = 0;

    }

}

`RenderableVertex`¶

Class Code

class RenderableVertex {

    constructor() {

        this.position = new Vector3();
        this.positionWorld = new Vector3();
        this.positionScreen = new Vector4();

        this.visible = true;

    }

    copy( vertex ) {

        this.positionWorld.copy( vertex.positionWorld );
        this.positionScreen.copy( vertex.positionScreen );

    }

}

Methods¶

`copy(vertex: any): void`¶

Code

copy( vertex ) {

        this.positionWorld.copy( vertex.positionWorld );
        this.positionScreen.copy( vertex.positionScreen );

    }

`RenderableLine`¶

Class Code

class RenderableLine {

    constructor() {

        this.id = 0;

        this.v1 = new RenderableVertex();
        this.v2 = new RenderableVertex();

        this.vertexColors = [ new Color(), new Color() ];
        this.material = null;

        this.z = 0;
        this.renderOrder = 0;

    }

}

`RenderableSprite`¶

Class Code

class RenderableSprite {

    constructor() {

        this.id = 0;

        this.object = null;

        this.x = 0;
        this.y = 0;
        this.z = 0;

        this.rotation = 0;
        this.scale = new Vector2();

        this.material = null;
        this.renderOrder = 0;

    }

}

`Projector`¶

Class Code

class Projector {

    /**
     * Constructs a new projector.
     */
    constructor() {

        let _object, _objectCount, _objectPoolLength = 0,
            _vertex, _vertexCount, _vertexPoolLength = 0,
            _face, _faceCount, _facePoolLength = 0,
            _line, _lineCount, _linePoolLength = 0,
            _sprite, _spriteCount, _spritePoolLength = 0,
            _modelMatrix;

        const

            _renderData = { objects: [], lights: [], elements: [] },

            _vector3 = new Vector3(),
            _vector4 = new Vector4(),

            _clipBox = new Box3( new Vector3( - 1, - 1, - 1 ), new Vector3( 1, 1, 1 ) ),
            _boundingBox = new Box3(),
            _points3 = new Array( 3 ),

            _viewMatrix = new Matrix4(),
            _viewProjectionMatrix = new Matrix4(),

            _modelViewProjectionMatrix = new Matrix4(),

            _frustum = new Frustum(),

            _objectPool = [], _vertexPool = [], _facePool = [], _linePool = [], _spritePool = [];

        //

        function RenderList() {

            const normals = [];
            const colors = [];
            const uvs = [];

            let object = null;

            const normalMatrix = new Matrix3();

            function setObject( value ) {

                object = value;

                normalMatrix.getNormalMatrix( object.matrixWorld );

                normals.length = 0;
                colors.length = 0;
                uvs.length = 0;

            }

            function projectVertex( vertex ) {

                const position = vertex.position;
                const positionWorld = vertex.positionWorld;
                const positionScreen = vertex.positionScreen;

                positionWorld.copy( position ).applyMatrix4( _modelMatrix );
                positionScreen.copy( positionWorld ).applyMatrix4( _viewProjectionMatrix );

                const invW = 1 / positionScreen.w;

                positionScreen.x *= invW;
                positionScreen.y *= invW;
                positionScreen.z *= invW;

                vertex.visible = positionScreen.x >= - 1 && positionScreen.x <= 1 &&
                         positionScreen.y >= - 1 && positionScreen.y <= 1 &&
                         positionScreen.z >= - 1 && positionScreen.z <= 1;

            }

            function pushVertex( x, y, z ) {

                _vertex = getNextVertexInPool();
                _vertex.position.set( x, y, z );

                projectVertex( _vertex );

            }

            function pushNormal( x, y, z ) {

                normals.push( x, y, z );

            }

            function pushColor( r, g, b ) {

                colors.push( r, g, b );

            }

            function pushUv( x, y ) {

                uvs.push( x, y );

            }

            function checkTriangleVisibility( v1, v2, v3 ) {

                if ( v1.visible === true || v2.visible === true || v3.visible === true ) return true;

                _points3[ 0 ] = v1.positionScreen;
                _points3[ 1 ] = v2.positionScreen;
                _points3[ 2 ] = v3.positionScreen;

                return _clipBox.intersectsBox( _boundingBox.setFromPoints( _points3 ) );

            }

            function checkBackfaceCulling( v1, v2, v3 ) {

                return ( ( v3.positionScreen.x - v1.positionScreen.x ) *
                        ( v2.positionScreen.y - v1.positionScreen.y ) -
                        ( v3.positionScreen.y - v1.positionScreen.y ) *
                        ( v2.positionScreen.x - v1.positionScreen.x ) ) < 0;

            }

            function pushLine( a, b ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];

                // Clip

                v1.positionScreen.copy( v1.position ).applyMatrix4( _modelViewProjectionMatrix );
                v2.positionScreen.copy( v2.position ).applyMatrix4( _modelViewProjectionMatrix );

                if ( clipLine( v1.positionScreen, v2.positionScreen ) === true ) {

                    // Perform the perspective divide
                    v1.positionScreen.multiplyScalar( 1 / v1.positionScreen.w );
                    v2.positionScreen.multiplyScalar( 1 / v2.positionScreen.w );

                    _line = getNextLineInPool();
                    _line.id = object.id;
                    _line.v1.copy( v1 );
                    _line.v2.copy( v2 );
                    _line.z = Math.max( v1.positionScreen.z, v2.positionScreen.z );
                    _line.renderOrder = object.renderOrder;

                    _line.material = object.material;

                    if ( object.material.vertexColors ) {

                        _line.vertexColors[ 0 ].fromArray( colors, a * 3 );
                        _line.vertexColors[ 1 ].fromArray( colors, b * 3 );

                    }

                    _renderData.elements.push( _line );

                }

            }

            function pushTriangle( a, b, c, material ) {

                const v1 = _vertexPool[ a ];
                const v2 = _vertexPool[ b ];
                const v3 = _vertexPool[ c ];

                if ( checkTriangleVisibility( v1, v2, v3 ) === false ) return;

                if ( material.side === DoubleSide || checkBackfaceCulling( v1, v2, v3 ) === true ) {

                    _face = getNextFaceInPool();

                    _face.id = object.id;
                    _face.v1.copy( v1 );
                    _face.v2.copy( v2 );
                    _face.v3.copy( v3 );
                    _face.z = ( v1.positionScreen.z + v2.positionScreen.z + v3.positionScreen.z ) / 3;
                    _face.renderOrder = object.renderOrder;

                    // face normal
                    _vector3.subVectors( v3.position, v2.position );
                    _vector4.subVectors( v1.position, v2.position );
                    _vector3.cross( _vector4 );
                    _face.normalModel.copy( _vector3 );
                    _face.normalModel.applyMatrix3( normalMatrix ).normalize();

                    for ( let i = 0; i < 3; i ++ ) {

                        const normal = _face.vertexNormalsModel[ i ];
                        normal.fromArray( normals, arguments[ i ] * 3 );
                        normal.applyMatrix3( normalMatrix ).normalize();

                        const uv = _face.uvs[ i ];
                        uv.fromArray( uvs, arguments[ i ] * 2 );

                    }

                    _face.vertexNormalsLength = 3;

                    _face.material = material;

                    if ( material.vertexColors ) {

                        _face.color.fromArray( colors, a * 3 );

                    }

                    _renderData.elements.push( _face );

                }

            }

            return {
                setObject: setObject,
                projectVertex: projectVertex,
                checkTriangleVisibility: checkTriangleVisibility,
                checkBackfaceCulling: checkBackfaceCulling,
                pushVertex: pushVertex,
                pushNormal: pushNormal,
                pushColor: pushColor,
                pushUv: pushUv,
                pushLine: pushLine,
                pushTriangle: pushTriangle
            };

        }

        const renderList = new RenderList();

        function projectObject( object ) {

            if ( object.visible === false ) return;

            if ( object.isLight ) {

                _renderData.lights.push( object );

            } else if ( object.isMesh || object.isLine || object.isPoints ) {

                if ( object.material.visible === false ) return;
                if ( object.frustumCulled === true && _frustum.intersectsObject( object ) === false ) return;

                addObject( object );

            } else if ( object.isSprite ) {

                if ( object.material.visible === false ) return;
                if ( object.frustumCulled === true && _frustum.intersectsSprite( object ) === false ) return;

                addObject( object );

            }

            const children = object.children;

            for ( let i = 0, l = children.length; i < l; i ++ ) {

                projectObject( children[ i ] );

            }

        }

        function addObject( object ) {

            _object = getNextObjectInPool();
            _object.id = object.id;
            _object.object = object;

            _vector3.setFromMatrixPosition( object.matrixWorld );
            _vector3.applyMatrix4( _viewProjectionMatrix );
            _object.z = _vector3.z;
            _object.renderOrder = object.renderOrder;

            _renderData.objects.push( _object );

        }

        /**
         * Projects the given scene in 3D space into a 2D representation. The result
         * is an object with renderable items.
         *
         * @param {Object3D} scene - A scene or any other type of 3D object.
         * @param {Camera} camera - The camera.
         * @param {boolean} sortObjects - Whether to sort objects or not.
         * @param {boolean} sortElements - Whether to sort elements (faces, lines and sprites) or not.
         * @return {{objects:Array<Objects>,lights:Array<Objects>,elements:Array<Objects>}} The projected scene as renderable objects.
         */
        this.projectScene = function ( scene, camera, sortObjects, sortElements ) {

            _faceCount = 0;
            _lineCount = 0;
            _spriteCount = 0;

            _renderData.elements.length = 0;

            if ( scene.matrixWorldAutoUpdate === true ) scene.updateMatrixWorld();
            if ( camera.parent === null && camera.matrixWorldAutoUpdate === true ) camera.updateMatrixWorld();

            _viewMatrix.copy( camera.matrixWorldInverse );
            _viewProjectionMatrix.multiplyMatrices( camera.projectionMatrix, _viewMatrix );

            _frustum.setFromProjectionMatrix( _viewProjectionMatrix );

            //

            _objectCount = 0;

            _renderData.objects.length = 0;
            _renderData.lights.length = 0;

            projectObject( scene );

            if ( sortObjects === true ) {

                _renderData.objects.sort( painterSort );

            }

            //

            const objects = _renderData.objects;

            for ( let o = 0, ol = objects.length; o < ol; o ++ ) {

                const object = objects[ o ].object;
                const geometry = object.geometry;

                renderList.setObject( object );

                _modelMatrix = object.matrixWorld;

                _vertexCount = 0;

                if ( object.isMesh ) {

                    let material = object.material;

                    const isMultiMaterial = Array.isArray( material );

                    const attributes = geometry.attributes;
                    const groups = geometry.groups;

                    if ( attributes.position === undefined ) continue;

                    const positions = attributes.position.array;

                    for ( let i = 0, l = positions.length; i < l; i += 3 ) {

                        let x = positions[ i ];
                        let y = positions[ i + 1 ];
                        let z = positions[ i + 2 ];

                        const morphTargets = geometry.morphAttributes.position;

                        if ( morphTargets !== undefined ) {

                            const morphTargetsRelative = geometry.morphTargetsRelative;
                            const morphInfluences = object.morphTargetInfluences;

                            for ( let t = 0, tl = morphTargets.length; t < tl; t ++ ) {

                                const influence = morphInfluences[ t ];

                                if ( influence === 0 ) continue;

                                const target = morphTargets[ t ];

                                if ( morphTargetsRelative ) {

                                    x += target.getX( i / 3 ) * influence;
                                    y += target.getY( i / 3 ) * influence;
                                    z += target.getZ( i / 3 ) * influence;

                                } else {

                                    x += ( target.getX( i / 3 ) - positions[ i ] ) * influence;
                                    y += ( target.getY( i / 3 ) - positions[ i + 1 ] ) * influence;
                                    z += ( target.getZ( i / 3 ) - positions[ i + 2 ] ) * influence;

                                }

                            }

                        }

                        renderList.pushVertex( x, y, z );

                    }

                    if ( attributes.normal !== undefined ) {

                        const normals = attributes.normal.array;

                        for ( let i = 0, l = normals.length; i < l; i += 3 ) {

                            renderList.pushNormal( normals[ i ], normals[ i + 1 ], normals[ i + 2 ] );

                        }

                    }

                    if ( attributes.color !== undefined ) {

                        const colors = attributes.color.array;

                        for ( let i = 0, l = colors.length; i < l; i += 3 ) {

                            renderList.pushColor( colors[ i ], colors[ i + 1 ], colors[ i + 2 ] );

                        }

                    }

                    if ( attributes.uv !== undefined ) {

                        const uvs = attributes.uv.array;

                        for ( let i = 0, l = uvs.length; i < l; i += 2 ) {

                            renderList.pushUv( uvs[ i ], uvs[ i + 1 ] );

                        }

                    }

                    if ( geometry.index !== null ) {

                        const indices = geometry.index.array;

                        if ( groups.length > 0 ) {

                            for ( let g = 0; g < groups.length; g ++ ) {

                                const group = groups[ g ];

                                material = isMultiMaterial === true
                                     ? object.material[ group.materialIndex ]
                                     : object.material;

                                if ( material === undefined ) continue;

                                for ( let i = group.start, l = group.start + group.count; i < l; i += 3 ) {

                                    renderList.pushTriangle( indices[ i ], indices[ i + 1 ], indices[ i + 2 ], material );

                                }

                            }

                        } else {

                            for ( let i = 0, l = indices.length; i < l; i += 3 ) {

                                renderList.pushTriangle( indices[ i ], indices[ i + 1 ], indices[ i + 2 ], material );

                            }

                        }

                    } else {

                        if ( groups.length > 0 ) {

                            for ( let g = 0; g < groups.length; g ++ ) {

                                const group = groups[ g ];

                                material = isMultiMaterial === true
                                     ? object.material[ group.materialIndex ]
                                     : object.material;

                                if ( material === undefined ) continue;

                                for ( let i = group.start, l = group.start + group.count; i < l; i += 3 ) {

                                    renderList.pushTriangle( i, i + 1, i + 2, material );

                                }

                            }

                        } else {

                            for ( let i = 0, l = positions.length / 3; i < l; i += 3 ) {

                                renderList.pushTriangle( i, i + 1, i + 2, material );

                            }

                        }

                    }

                } else if ( object.isLine ) {

                    _modelViewProjectionMatrix.multiplyMatrices( _viewProjectionMatrix, _modelMatrix );

                    const attributes = geometry.attributes;

                    if ( attributes.position !== undefined ) {

                        const positions = attributes.position.array;

                        for ( let i = 0, l = positions.length; i < l; i += 3 ) {

                            renderList.pushVertex( positions[ i ], positions[ i + 1 ], positions[ i + 2 ] );

                        }

                        if ( attributes.color !== undefined ) {

                            const colors = attributes.color.array;

                            for ( let i = 0, l = colors.length; i < l; i += 3 ) {

                                renderList.pushColor( colors[ i ], colors[ i + 1 ], colors[ i + 2 ] );

                            }

                        }

                        if ( geometry.index !== null ) {

                            const indices = geometry.index.array;

                            for ( let i = 0, l = indices.length; i < l; i += 2 ) {

                                renderList.pushLine( indices[ i ], indices[ i + 1 ] );

                            }

                        } else {

                            const step = object.isLineSegments ? 2 : 1;

                            for ( let i = 0, l = ( positions.length / 3 ) - 1; i < l; i += step ) {

                                renderList.pushLine( i, i + 1 );

                            }

                        }

                    }

                } else if ( object.isPoints ) {

                    _modelViewProjectionMatrix.multiplyMatrices( _viewProjectionMatrix, _modelMatrix );

                    const attributes = geometry.attributes;

                    if ( attributes.position !== undefined ) {

                        const positions = attributes.position.array;

                        for ( let i = 0, l = positions.length; i < l; i += 3 ) {

                            _vector4.set( positions[ i ], positions[ i + 1 ], positions[ i + 2 ], 1 );
                            _vector4.applyMatrix4( _modelViewProjectionMatrix );

                            pushPoint( _vector4, object, camera );

                        }

                    }

                } else if ( object.isSprite ) {

                    object.modelViewMatrix.multiplyMatrices( camera.matrixWorldInverse, object.matrixWorld );
                    _vector4.set( _modelMatrix.elements[ 12 ], _modelMatrix.elements[ 13 ], _modelMatrix.elements[ 14 ], 1 );
                    _vector4.applyMatrix4( _viewProjectionMatrix );

                    pushPoint( _vector4, object, camera );

                }

            }

            if ( sortElements === true ) {

                _renderData.elements.sort( painterSort );

            }

            return _renderData;

        };

        function pushPoint( _vector4, object, camera ) {

            const invW = 1 / _vector4.w;

            _vector4.z *= invW;

            if ( _vector4.z >= - 1 && _vector4.z <= 1 ) {

                _sprite = getNextSpriteInPool();
                _sprite.id = object.id;
                _sprite.x = _vector4.x * invW;
                _sprite.y = _vector4.y * invW;
                _sprite.z = _vector4.z;
                _sprite.renderOrder = object.renderOrder;
                _sprite.object = object;

                _sprite.rotation = object.rotation;

                _sprite.scale.x = object.scale.x * Math.abs( _sprite.x - ( _vector4.x + camera.projectionMatrix.elements[ 0 ] ) / ( _vector4.w + camera.projectionMatrix.elements[ 12 ] ) );
                _sprite.scale.y = object.scale.y * Math.abs( _sprite.y - ( _vector4.y + camera.projectionMatrix.elements[ 5 ] ) / ( _vector4.w + camera.projectionMatrix.elements[ 13 ] ) );

                _sprite.material = object.material;

                _renderData.elements.push( _sprite );

            }

        }

        // Pools

        function getNextObjectInPool() {

            if ( _objectCount === _objectPoolLength ) {

                const object = new RenderableObject();
                _objectPool.push( object );
                _objectPoolLength ++;
                _objectCount ++;
                return object;

            }

            return _objectPool[ _objectCount ++ ];

        }

        function getNextVertexInPool() {

            if ( _vertexCount === _vertexPoolLength ) {

                const vertex = new RenderableVertex();
                _vertexPool.push( vertex );
                _vertexPoolLength ++;
                _vertexCount ++;
                return vertex;

            }

            return _vertexPool[ _vertexCount ++ ];

        }

        function getNextFaceInPool() {

            if ( _faceCount === _facePoolLength ) {

                const face = new RenderableFace();
                _facePool.push( face );
                _facePoolLength ++;
                _faceCount ++;
                return face;

            }

            return _facePool[ _faceCount ++ ];


        }

        function getNextLineInPool() {

            if ( _lineCount === _linePoolLength ) {

                const line = new RenderableLine();
                _linePool.push( line );
                _linePoolLength ++;
                _lineCount ++;
                return line;

            }

            return _linePool[ _lineCount ++ ];

        }

        function getNextSpriteInPool() {

            if ( _spriteCount === _spritePoolLength ) {

                const sprite = new RenderableSprite();
                _spritePool.push( sprite );
                _spritePoolLength ++;
                _spriteCount ++;
                return sprite;

            }

            return _spritePool[ _spriteCount ++ ];

        }

        //

        function painterSort( a, b ) {

            if ( a.renderOrder !== b.renderOrder ) {

                return a.renderOrder - b.renderOrder;

            } else if ( a.z !== b.z ) {

                return b.z - a.z;

            } else if ( a.id !== b.id ) {

                return a.id - b.id;

            } else {

                return 0;

            }

        }

        function clipLine( s1, s2 ) {

            let alpha1 = 0, alpha2 = 1;

            // Calculate the boundary coordinate of each vertex for the near and far clip planes,
            // Z = -1 and Z = +1, respectively.

            const bc1near = s1.z + s1.w,
                bc2near = s2.z + s2.w,
                bc1far = - s1.z + s1.w,
                bc2far = - s2.z + s2.w;

            if ( bc1near >= 0 && bc2near >= 0 && bc1far >= 0 && bc2far >= 0 ) {

                // Both vertices lie entirely within all clip planes.
                return true;

            } else if ( ( bc1near < 0 && bc2near < 0 ) || ( bc1far < 0 && bc2far < 0 ) ) {

                // Both vertices lie entirely outside one of the clip planes.
                return false;

            } else {

                // The line segment spans at least one clip plane.

                if ( bc1near < 0 ) {

                    // v1 lies outside the near plane, v2 inside
                    alpha1 = Math.max( alpha1, bc1near / ( bc1near - bc2near ) );

                } else if ( bc2near < 0 ) {

                    // v2 lies outside the near plane, v1 inside
                    alpha2 = Math.min( alpha2, bc1near / ( bc1near - bc2near ) );

                }

                if ( bc1far < 0 ) {

                    // v1 lies outside the far plane, v2 inside
                    alpha1 = Math.max( alpha1, bc1far / ( bc1far - bc2far ) );

                } else if ( bc2far < 0 ) {

                    // v2 lies outside the far plane, v2 inside
                    alpha2 = Math.min( alpha2, bc1far / ( bc1far - bc2far ) );

                }

                if ( alpha2 < alpha1 ) {

                    // The line segment spans two boundaries, but is outside both of them.
                    // (This can't happen when we're only clipping against just near/far but good
                    //  to leave the check here for future usage if other clip planes are added.)
                    return false;

                } else {

                    // Update the s1 and s2 vertices to match the clipped line segment.
                    s1.lerp( s2, alpha1 );
                    s2.lerp( s1, 1 - alpha2 );

                    return true;

                }

            }

        }

    }

}

📄 Projector.js¶

📊 Analysis Summary¶

📚 Table of Contents¶

🛠️ File Location:¶

📦 Imports¶

Variables & Constants¶

Functions¶

RenderableVertex.copy(vertex: any): void¶

setObject(value: any): void¶

projectVertex(vertex: any): void¶

pushVertex(x: any, y: any, z: any): void¶

pushNormal(x: any, y: any, z: any): void¶

pushColor(r: any, g: any, b: any): void¶

pushUv(x: any, y: any): void¶

checkTriangleVisibility(v1: any, v2: any, v3: any): any¶

checkBackfaceCulling(v1: any, v2: any, v3: any): boolean¶

pushLine(a: any, b: any): void¶

pushTriangle(a: any, b: any, c: any, material: any): void¶

projectObject(object: any): void¶

addObject(object: any): void¶

pushPoint(_vector4: any, object: any, camera: any): void¶

getNextObjectInPool(): any¶

getNextVertexInPool(): any¶

getNextFaceInPool(): any¶

getNextLineInPool(): any¶

getNextSpriteInPool(): any¶

painterSort(a: any, b: any): number¶

clipLine(s1: any, s2: any): boolean¶

Classes¶

RenderableObject¶

RenderableFace¶

RenderableVertex¶

Methods¶

copy(vertex: any): void¶

RenderableLine¶

RenderableSprite¶

Projector¶

📄 `Projector.js`¶

`RenderableVertex.copy(vertex: any): void`¶

`setObject(value: any): void`¶

`projectVertex(vertex: any): void`¶

`pushVertex(x: any, y: any, z: any): void`¶

`pushNormal(x: any, y: any, z: any): void`¶

`pushColor(r: any, g: any, b: any): void`¶

`pushUv(x: any, y: any): void`¶

`checkTriangleVisibility(v1: any, v2: any, v3: any): any`¶

`checkBackfaceCulling(v1: any, v2: any, v3: any): boolean`¶

`pushLine(a: any, b: any): void`¶

`pushTriangle(a: any, b: any, c: any, material: any): void`¶

`projectObject(object: any): void`¶

`addObject(object: any): void`¶

`pushPoint(_vector4: any, object: any, camera: any): void`¶

`getNextObjectInPool(): any`¶

`getNextVertexInPool(): any`¶

`getNextFaceInPool(): any`¶

`getNextLineInPool(): any`¶

`getNextSpriteInPool(): any`¶

`painterSort(a: any, b: any): number`¶

`clipLine(s1: any, s2: any): boolean`¶

`RenderableObject`¶

`RenderableFace`¶

`RenderableVertex`¶

`copy(vertex: any): void`¶

`RenderableLine`¶

`RenderableSprite`¶

`Projector`¶