Accueil / npm / three@0.186.1 / examples / jsm / math / Capsule.js
Capsule.js
import {
Vector3
} from 'three';
/**
* A capsule is essentially a cylinder with hemispherical caps at both ends.
* It can be thought of as a swept sphere, where a sphere is moved along a line segment.
*
* Capsules are often used as bounding volumes (next to AABBs and bounding spheres).
*
* @three_import import { Capsule } from 'three/addons/math/Capsule.js';
*/
class Capsule {
/**
* Constructs a new capsule.
*
* @param {Vector3} [start] - The start vector.
* @param {Vector3} [end] - The end vector.
* @param {number} [radius=1] - The capsule's radius.
*/
constructor( start = new Vector3( 0, 0, 0 ), end = new Vector3( 0, 1, 0 ), radius = 1 ) {
/**
* The start vector.
*
* @type {Vector3}
*/
this.start = start;
/**
* The end vector.
*
* @type {Vector3}
*/
this.end = end;
/**
* The capsule's radius.
*
* @type {number}
* @default 1
*/
this.radius = radius;
}
/**
* Returns a new capsule with copied values from this instance.
*
* @return {Capsule} A clone of this instance.
*/
clone() {
return new this.constructor().copy( this );
}
/**
* Sets the capsule components to the given values.
* Please note that this method only copies the values from the given objects.
*
* @param {Vector3} start - The start vector.
* @param {Vector3} end - The end vector
* @param {number} radius - The capsule's radius.
* @return {Capsule} A reference to this capsule.
*/
set( start, end, radius ) {
this.start.copy( start );
this.end.copy( end );
this.radius = radius;
return this;
}
/**
* Copies the values of the given capsule to this instance.
*
* @param {Capsule} capsule - The capsule to copy.
* @return {Capsule} A reference to this capsule.
*/
copy( capsule ) {
this.start.copy( capsule.start );
this.end.copy( capsule.end );
this.radius = capsule.radius;
return this;
}
/**
* Returns the center point of this capsule.
*
* @param {Vector3} target - The target vector that is used to store the method's result.
* @return {Vector3} The center point.
*/
getCenter( target ) {
return target.copy( this.end ).add( this.start ).multiplyScalar( 0.5 );
}
/**
* Adds the given offset to this capsule, effectively moving it in 3D space.
*
* @param {Vector3} v - The offset that should be used to translate the capsule.
* @return {Capsule} A reference to this capsule.
*/
translate( v ) {
this.start.add( v );
this.end.add( v );
return this;
}
/**
* Returns `true` if the given bounding box intersects with this capsule.
*
* @param {Box3} box - The bounding box to test.
* @return {boolean} Whether the given bounding box intersects with this capsule.
*/
intersectsBox( box ) {
return (
checkAABBAxis(
this.start.x, this.start.y, this.end.x, this.end.y,
box.min.x, box.max.x, box.min.y, box.max.y,
this.radius ) &&
checkAABBAxis(
this.start.x, this.start.z, this.end.x, this.end.z,
box.min.x, box.max.x, box.min.z, box.max.z,
this.radius ) &&
checkAABBAxis(
this.start.y, this.start.z, this.end.y, this.end.z,
box.min.y, box.max.y, box.min.z, box.max.z,
this.radius )
);
}
}
function checkAABBAxis( p1x, p1y, p2x, p2y, minx, maxx, miny, maxy, radius ) {
return (
( minx - p1x < radius || minx - p2x < radius ) &&
( p1x - maxx < radius || p2x - maxx < radius ) &&
( miny - p1y < radius || miny - p2y < radius ) &&
( p1y - maxy < radius || p2y - maxy < radius )
);
}
export { Capsule };