three.js/test/unit/src/math/Plane.tests.js

/* global QUnit */

import { Plane } from '../../../../src/math/Plane.js';
import { Vector3 } from '../../../../src/math/Vector3.js';
import { Line3 } from '../../../../src/math/Line3.js';
import { Sphere } from '../../../../src/math/Sphere.js';
import { Box3 } from '../../../../src/math/Box3.js';
import { Matrix4 } from '../../../../src/math/Matrix4.js';
import {
	x,
	y,
	z,
	w,
	zero3,
	one3
} from './Constants.tests.js';

function comparePlane( a, b, threshold ) {

	threshold = threshold || 0.0001;
	return ( a.normal.distanceTo( b.normal ) < threshold &&
	Math.abs( a.constant - b.constant ) < threshold );

}

export default QUnit.module( 'Maths', () => {

	QUnit.module( 'Plane', () => {

		// INSTANCING
		QUnit.test( 'Instancing', ( assert ) => {

			var a = new Plane();
			assert.ok( a.normal.x == 1, 'Passed!' );
			assert.ok( a.normal.y == 0, 'Passed!' );
			assert.ok( a.normal.z == 0, 'Passed!' );
			assert.ok( a.constant == 0, 'Passed!' );

			var a = new Plane( one3.clone(), 0 );
			assert.ok( a.normal.x == 1, 'Passed!' );
			assert.ok( a.normal.y == 1, 'Passed!' );
			assert.ok( a.normal.z == 1, 'Passed!' );
			assert.ok( a.constant == 0, 'Passed!' );

			var a = new Plane( one3.clone(), 1 );
			assert.ok( a.normal.x == 1, 'Passed!' );
			assert.ok( a.normal.y == 1, 'Passed!' );
			assert.ok( a.normal.z == 1, 'Passed!' );
			assert.ok( a.constant == 1, 'Passed!' );

		} );

		// PUBLIC STUFF
		QUnit.test( 'isPlane', ( assert ) => {

			var a = new Plane();
			assert.ok( a.isPlane === true, 'Passed!' );

			var b = new Vector3();
			assert.ok( ! b.isPlane, 'Passed!' );


		} );

		QUnit.test( 'set', ( assert ) => {

			var a = new Plane();
			assert.ok( a.normal.x == 1, 'Passed!' );
			assert.ok( a.normal.y == 0, 'Passed!' );
			assert.ok( a.normal.z == 0, 'Passed!' );
			assert.ok( a.constant == 0, 'Passed!' );

			var b = a.clone().set( new Vector3( x, y, z ), w );
			assert.ok( b.normal.x == x, 'Passed!' );
			assert.ok( b.normal.y == y, 'Passed!' );
			assert.ok( b.normal.z == z, 'Passed!' );
			assert.ok( b.constant == w, 'Passed!' );

		} );

		QUnit.test( 'setComponents', ( assert ) => {

			var a = new Plane();
			assert.ok( a.normal.x == 1, 'Passed!' );
			assert.ok( a.normal.y == 0, 'Passed!' );
			assert.ok( a.normal.z == 0, 'Passed!' );
			assert.ok( a.constant == 0, 'Passed!' );

			var b = a.clone().setComponents( x, y, z, w );
			assert.ok( b.normal.x == x, 'Passed!' );
			assert.ok( b.normal.y == y, 'Passed!' );
			assert.ok( b.normal.z == z, 'Passed!' );
			assert.ok( b.constant == w, 'Passed!' );

		} );

		QUnit.test( 'setFromNormalAndCoplanarPoint', ( assert ) => {

			var normal = one3.clone().normalize();
			var a = new Plane().setFromNormalAndCoplanarPoint( normal, zero3 );

			assert.ok( a.normal.equals( normal ), 'Passed!' );
			assert.ok( a.constant == 0, 'Passed!' );

		} );

		QUnit.test( 'setFromCoplanarPoints', ( assert ) => {

			var a = new Plane();
			var v1 = new Vector3( 2.0, 0.5, 0.25 );
			var v2 = new Vector3( 2.0, - 0.5, 1.25 );
			var v3 = new Vector3( 2.0, - 3.5, 2.2 );
			var normal = new Vector3( 1, 0, 0 );
			var constant = - 2;

			a.setFromCoplanarPoints( v1, v2, v3 );

			assert.ok( a.normal.equals( normal ), 'Check normal' );
			assert.strictEqual( a.constant, constant, 'Check constant' );

		} );

		QUnit.test( 'clone', ( assert ) => {

			var a = new Plane( new Vector3( 2.0, 0.5, 0.25 ) );
			var b = a.clone();

			assert.ok( a.equals( b ), 'clones are equal' );


		} );

		QUnit.test( 'copy', ( assert ) => {

			var a = new Plane( new Vector3( x, y, z ), w );
			var b = new Plane().copy( a );
			assert.ok( b.normal.x == x, 'Passed!' );
			assert.ok( b.normal.y == y, 'Passed!' );
			assert.ok( b.normal.z == z, 'Passed!' );
			assert.ok( b.constant == w, 'Passed!' );

			// ensure that it is a true copy
			a.normal.x = 0;
			a.normal.y = - 1;
			a.normal.z = - 2;
			a.constant = - 3;
			assert.ok( b.normal.x == x, 'Passed!' );
			assert.ok( b.normal.y == y, 'Passed!' );
			assert.ok( b.normal.z == z, 'Passed!' );
			assert.ok( b.constant == w, 'Passed!' );

		} );

		QUnit.test( 'normalize', ( assert ) => {

			var a = new Plane( new Vector3( 2, 0, 0 ), 2 );

			a.normalize();
			assert.ok( a.normal.length() == 1, 'Passed!' );
			assert.ok( a.normal.equals( new Vector3( 1, 0, 0 ) ), 'Passed!' );
			assert.ok( a.constant == 1, 'Passed!' );

		} );

		QUnit.test( 'negate/distanceToPoint', ( assert ) => {

			var a = new Plane( new Vector3( 2, 0, 0 ), - 2 );

			a.normalize();
			assert.ok( a.distanceToPoint( new Vector3( 4, 0, 0 ) ) === 3, 'Passed!' );
			assert.ok( a.distanceToPoint( new Vector3( 1, 0, 0 ) ) === 0, 'Passed!' );

			a.negate();
			assert.ok( a.distanceToPoint( new Vector3( 4, 0, 0 ) ) === - 3, 'Passed!' );
			assert.ok( a.distanceToPoint( new Vector3( 1, 0, 0 ) ) === 0, 'Passed!' );

		} );

		QUnit.test( 'distanceToPoint', ( assert ) => {

			var a = new Plane( new Vector3( 2, 0, 0 ), - 2 );
			var point = new Vector3();

			a.normalize().projectPoint( zero3.clone(), point );
			assert.ok( a.distanceToPoint( point ) === 0, 'Passed!' );
			assert.ok( a.distanceToPoint( new Vector3( 4, 0, 0 ) ) === 3, 'Passed!' );

		} );

		QUnit.test( 'distanceToSphere', ( assert ) => {

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );

			var b = new Sphere( new Vector3( 2, 0, 0 ), 1 );

			assert.ok( a.distanceToSphere( b ) === 1, 'Passed!' );

			a.set( new Vector3( 1, 0, 0 ), 2 );
			assert.ok( a.distanceToSphere( b ) === 3, 'Passed!' );
			a.set( new Vector3( 1, 0, 0 ), - 2 );
			assert.ok( a.distanceToSphere( b ) === - 1, 'Passed!' );

		} );

		QUnit.test( 'projectPoint', ( assert ) => {

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );
			var point = new Vector3();

			a.projectPoint( new Vector3( 10, 0, 0 ), point );
			assert.ok( point.equals( zero3 ), 'Passed!' );
			a.projectPoint( new Vector3( - 10, 0, 0 ), point );
			assert.ok( point.equals( zero3 ), 'Passed!' );

			var a = new Plane( new Vector3( 0, 1, 0 ), - 1 );
			a.projectPoint( new Vector3( 0, 0, 0 ), point );
			assert.ok( point.equals( new Vector3( 0, 1, 0 ) ), 'Passed!' );
			a.projectPoint( new Vector3( 0, 1, 0 ), point );
			assert.ok( point.equals( new Vector3( 0, 1, 0 ) ), 'Passed!' );

		} );

		QUnit.test( 'isInterestionLine/intersectLine', ( assert ) => {

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );
			var point = new Vector3();

			var l1 = new Line3( new Vector3( - 10, 0, 0 ), new Vector3( 10, 0, 0 ) );
			a.intersectLine( l1, point );
			assert.ok( point.equals( new Vector3( 0, 0, 0 ) ), 'Passed!' );

			var a = new Plane( new Vector3( 1, 0, 0 ), - 3 );
			a.intersectLine( l1, point );
			assert.ok( point.equals( new Vector3( 3, 0, 0 ) ), 'Passed!' );

		} );

		QUnit.test( 'intersectsBox', ( assert ) => {

			var a = new Box3( zero3.clone(), one3.clone() );
			var b = new Plane( new Vector3( 0, 1, 0 ), 1 );
			var c = new Plane( new Vector3( 0, 1, 0 ), 1.25 );
			var d = new Plane( new Vector3( 0, - 1, 0 ), 1.25 );
			var e = new Plane( new Vector3( 0, 1, 0 ), 0.25 );
			var f = new Plane( new Vector3( 0, 1, 0 ), - 0.25 );
			var g = new Plane( new Vector3( 0, 1, 0 ), - 0.75 );
			var h = new Plane( new Vector3( 0, 1, 0 ), - 1 );
			var i = new Plane( new Vector3( 1, 1, 1 ).normalize(), - 1.732 );
			var j = new Plane( new Vector3( 1, 1, 1 ).normalize(), - 1.733 );

			assert.ok( ! b.intersectsBox( a ), 'Passed!' );
			assert.ok( ! c.intersectsBox( a ), 'Passed!' );
			assert.ok( ! d.intersectsBox( a ), 'Passed!' );
			assert.ok( ! e.intersectsBox( a ), 'Passed!' );
			assert.ok( f.intersectsBox( a ), 'Passed!' );
			assert.ok( g.intersectsBox( a ), 'Passed!' );
			assert.ok( h.intersectsBox( a ), 'Passed!' );
			assert.ok( i.intersectsBox( a ), 'Passed!' );
			assert.ok( ! j.intersectsBox( a ), 'Passed!' );

		} );

		QUnit.test( 'intersectsSphere', ( assert ) => {

			var a = new Sphere( zero3.clone(), 1 );
			var b = new Plane( new Vector3( 0, 1, 0 ), 1 );
			var c = new Plane( new Vector3( 0, 1, 0 ), 1.25 );
			var d = new Plane( new Vector3( 0, - 1, 0 ), 1.25 );

			assert.ok( b.intersectsSphere( a ), 'Passed!' );
			assert.ok( ! c.intersectsSphere( a ), 'Passed!' );
			assert.ok( ! d.intersectsSphere( a ), 'Passed!' );

		} );

		QUnit.test( 'coplanarPoint', ( assert ) => {

			var point = new Vector3();

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );
			a.coplanarPoint( point );
			assert.ok( a.distanceToPoint( point ) === 0, 'Passed!' );

			var a = new Plane( new Vector3( 0, 1, 0 ), - 1 );
			a.coplanarPoint( point );
			assert.ok( a.distanceToPoint( point ) === 0, 'Passed!' );

		} );

		QUnit.test( 'applyMatrix4/translate', ( assert ) => {

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );

			var m = new Matrix4();
			m.makeRotationZ( Math.PI * 0.5 );

			assert.ok( comparePlane( a.clone().applyMatrix4( m ), new Plane( new Vector3( 0, 1, 0 ), 0 ) ), 'Passed!' );

			var a = new Plane( new Vector3( 0, 1, 0 ), - 1 );
			assert.ok( comparePlane( a.clone().applyMatrix4( m ), new Plane( new Vector3( - 1, 0, 0 ), - 1 ) ), 'Passed!' );

			m.makeTranslation( 1, 1, 1 );
			assert.ok( comparePlane( a.clone().applyMatrix4( m ), a.clone().translate( new Vector3( 1, 1, 1 ) ) ), 'Passed!' );

		} );

		QUnit.test( 'equals', ( assert ) => {

			var a = new Plane( new Vector3( 1, 0, 0 ), 0 );
			var b = new Plane( new Vector3( 1, 0, 0 ), 1 );
			var c = new Plane( new Vector3( 0, 1, 0 ), 0 );

			assert.ok( a.normal.equals( b.normal ), 'Normals: equal' );
			assert.notOk( a.normal.equals( c.normal ), 'Normals: not equal' );

			assert.notStrictEqual( a.constant, b.constant, 'Constants: not equal' );
			assert.strictEqual( a.constant, c.constant, 'Constants: equal' );

			assert.notOk( a.equals( b ), 'Planes: not equal' );
			assert.notOk( a.equals( c ), 'Planes: not equal' );

			a.copy( b );
			assert.ok( a.normal.equals( b.normal ), 'Normals after copy(): equal' );
			assert.strictEqual( a.constant, b.constant, 'Constants after copy(): equal' );
			assert.ok( a.equals( b ), 'Planes after copy(): equal' );

		} );

	} );

} );

QUnit.module( 'Plane' );