mirror of
https://github.com/cocos/cocos-engine.git
synced 2026-09-06 15:48:37 +08:00
793 lines
34 KiB
TypeScript
793 lines
34 KiB
TypeScript
/*
|
||
Copyright (c) 2020-2023 Xiamen Yaji Software Co., Ltd.
|
||
|
||
https://www.cocos.com/
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated documentation files (the "Software"), to deal
|
||
in the Software without restriction, including without limitation the rights to
|
||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||
of the Software, and to permit persons to whom the Software is furnished to do so,
|
||
subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in
|
||
all copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
THE SOFTWARE.
|
||
*/
|
||
|
||
import { EDITOR_NOT_IN_PREVIEW } from 'internal:constants';
|
||
import { warn, error } from '@base/debug';
|
||
import { cclegacy } from '@base/global';
|
||
import { memop } from '@base/utils';
|
||
import { Enum } from '@base/object';
|
||
import { Vec3, IQuatLike, IVec3Like } from '@base/math';
|
||
import { System, Settings, settings, geometry } from '../../core';
|
||
import { IPhysicsWorld, IRaycastOptions } from '../spec/i-physics-world';
|
||
import { director, Director, game } from '../../game';
|
||
import { PhysicsMaterial } from './assets/physics-material';
|
||
import { PhysicsRayResult, PhysicsLineStripCastResult } from './physics-ray-result';
|
||
import { IPhysicsConfig, ICollisionMatrix } from './physics-config';
|
||
import { CollisionMatrix } from './collision-matrix';
|
||
import { PhysicsGroup } from './physics-enum';
|
||
import { constructDefaultWorld, IWorldInitData, selector } from './physics-selector';
|
||
import { assetManager, builtinResMgr } from '../../asset/asset-manager';
|
||
import { Collider } from './components/colliders/collider';
|
||
|
||
cclegacy.internal.PhysicsGroup = PhysicsGroup;
|
||
|
||
/**
|
||
* @en
|
||
* Physics system.
|
||
* @zh
|
||
* 物理系统。
|
||
*/
|
||
export class PhysicsSystem extends System implements IWorldInitData {
|
||
public static get PHYSICS_NONE (): boolean {
|
||
return !selector.id;
|
||
}
|
||
|
||
public static get PHYSICS_BUILTIN (): boolean {
|
||
return selector.id === 'builtin';
|
||
}
|
||
|
||
public static get PHYSICS_CANNON (): boolean {
|
||
return selector.id === 'cannon.js';
|
||
}
|
||
|
||
public static get PHYSICS_BULLET (): boolean {
|
||
return selector.id === 'bullet';
|
||
}
|
||
|
||
public static get PHYSICS_PHYSX (): boolean {
|
||
return selector.id === 'physx';
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets the ID of the system.
|
||
* @zh
|
||
* 获取此系统的ID。
|
||
*/
|
||
public static readonly ID = 'PHYSICS';
|
||
|
||
/**
|
||
* @en
|
||
* Gets the predefined physics groups.
|
||
* @zh
|
||
* 获取预定义的物理分组。
|
||
*/
|
||
public static get PhysicsGroup (): typeof PhysicsGroup {
|
||
return PhysicsGroup;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets the physical system instance.
|
||
* @zh
|
||
* 获取物理系统实例。
|
||
*/
|
||
public static get instance (): PhysicsSystem {
|
||
return PhysicsSystem._instance!;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets or sets whether the physical system is enabled, which can be used to pause or continue running the physical system.
|
||
* @zh
|
||
* 获取或设置是否启用物理系统，可以用于暂停或继续运行物理系统。
|
||
*/
|
||
public get enable (): boolean {
|
||
return this._enable;
|
||
}
|
||
|
||
public set enable (value: boolean) {
|
||
this._enable = value;
|
||
}
|
||
|
||
/**
|
||
* @zh
|
||
* Gets or sets whether the physical system allows automatic sleep, which defaults to true.
|
||
* @zh
|
||
* 获取或设置物理系统是否允许自动休眠，默认为 true。
|
||
*/
|
||
public get allowSleep (): boolean {
|
||
return this._allowSleep;
|
||
}
|
||
|
||
public set allowSleep (v: boolean) {
|
||
this._allowSleep = v;
|
||
if (this.physicsWorld) {
|
||
this.physicsWorld.setAllowSleep(v);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets or sets the maximum number of simulated substeps per frame.
|
||
* @zh
|
||
* 获取或设置每帧模拟的最大子步数。
|
||
*/
|
||
public get maxSubSteps (): number {
|
||
return this._maxSubSteps;
|
||
}
|
||
|
||
public set maxSubSteps (value: number) {
|
||
this._maxSubSteps = value;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets or sets the fixed delta time consumed by each simulation step in seconds.
|
||
* @zh
|
||
* 获取或设置每步模拟消耗的固定时间（以 s 为单位）。
|
||
*/
|
||
public get fixedTimeStep (): number {
|
||
return this._fixedTimeStep;
|
||
}
|
||
|
||
public set fixedTimeStep (value: number) {
|
||
this._fixedTimeStep = value;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets or sets the value of gravity in the physical world, which defaults to (0, -10, 0).
|
||
* @zh
|
||
* 获取或设置物理世界的重力数值，默认为 (0, -10, 0)。
|
||
*/
|
||
public get gravity (): Vec3 {
|
||
return this._gravity;
|
||
}
|
||
|
||
public set gravity (gravity: Vec3) {
|
||
this._gravity.set(gravity);
|
||
if (this.physicsWorld) {
|
||
this.physicsWorld.setGravity(gravity);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets or sets the default speed threshold for going to sleep.
|
||
* @zh
|
||
* 获取或设置进入休眠的默认速度临界值。
|
||
*/
|
||
public get sleepThreshold (): number {
|
||
return this._sleepThreshold;
|
||
}
|
||
|
||
public set sleepThreshold (v: number) {
|
||
this._sleepThreshold = v;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Turn on or off the automatic simulation.
|
||
* @zh
|
||
* 获取或设置是否自动模拟。
|
||
*/
|
||
public get autoSimulation (): boolean {
|
||
return this._autoSimulation;
|
||
}
|
||
|
||
public set autoSimulation (value: boolean) {
|
||
this._autoSimulation = value;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets the global default physical material.
|
||
* @zh
|
||
* 获取全局的默认物理材质。
|
||
*/
|
||
public get defaultMaterial (): PhysicsMaterial {
|
||
return this._material;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Set the default physics material.
|
||
* @zh
|
||
* 设置默认物理材质。
|
||
*/
|
||
public setDefaultPhysicsMaterial (material: PhysicsMaterial): void {
|
||
this._material = material;
|
||
this.physicsWorld.setDefaultMaterial(this._material);
|
||
this._material.on(PhysicsMaterial.EVENT_UPDATE, this._updateMaterial, this);
|
||
}
|
||
|
||
// eslint-disable-next-line consistent-return
|
||
private initDefaultMaterial (): Promise<void> {
|
||
if (this._material != null) return Promise.resolve();
|
||
|
||
const builtinMaterial = builtinResMgr.get<PhysicsMaterial>('default-physics-material');
|
||
if (!builtinMaterial) {
|
||
error('PhysicsSystem initDefaultMaterial() Failed to load builtinMaterial');
|
||
return Promise.resolve();
|
||
}
|
||
|
||
const userMaterial = settings.querySettings(Settings.Category.PHYSICS, 'defaultMaterial');
|
||
if (!userMaterial) { //use built-in default physics material
|
||
this.setDefaultPhysicsMaterial(builtinMaterial);
|
||
return Promise.resolve();
|
||
} else { //use user customized default physics material
|
||
return new Promise<PhysicsMaterial>((resolve, reject): void => {
|
||
assetManager.loadAny(userMaterial, (err, asset): void => ((err || !(asset instanceof PhysicsMaterial))
|
||
? reject(err)
|
||
: resolve(asset)));
|
||
}).then((asset): void => {
|
||
this.setDefaultPhysicsMaterial(asset);
|
||
}).catch((reason): void => {
|
||
warn(reason);
|
||
warn(`Failed to load user customized default physics material: ${userMaterial}, will fallback to built-in default physics material`);
|
||
this.setDefaultPhysicsMaterial(builtinMaterial);
|
||
});
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets the wrappered object of the physical world through which you can access the actual underlying object.
|
||
* @zh
|
||
* 获取物理世界的封装对象，通过它你可以访问到实际的底层对象。
|
||
*/
|
||
public get physicsWorld (): IPhysicsWorld {
|
||
return selector.physicsWorld!;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Gets the raycastClosest test result.
|
||
* @zh
|
||
* 获取 raycastClosest 的检测结果。
|
||
*/
|
||
public readonly raycastClosestResult = new PhysicsRayResult();
|
||
|
||
/**
|
||
* @en
|
||
* Gets the raycast test results.
|
||
* @zh
|
||
* 获取 raycast 的检测结果。
|
||
*/
|
||
public readonly raycastResults: PhysicsRayResult[] = [];
|
||
|
||
/**
|
||
* @en
|
||
* Gets the lineStripCastClosest test result.
|
||
* @zh
|
||
* 获取 lineStripCastClosest 的检测结果。
|
||
*/
|
||
public lineStripCastClosestResult = new PhysicsLineStripCastResult();
|
||
|
||
/**
|
||
* @en
|
||
* Gets the lineStripCast test results.
|
||
* @zh
|
||
* 获取 lineStripCast 的检测结果。
|
||
*/
|
||
public lineStripCastResults: PhysicsLineStripCastResult[] = [];
|
||
|
||
/**
|
||
* @en
|
||
* Gets the sweepCastClosest test result.
|
||
* @zh
|
||
* 获取 sweepCastClosest 的检测结果。
|
||
*/
|
||
public readonly sweepCastClosestResult = new PhysicsRayResult();
|
||
|
||
/**
|
||
* @en
|
||
* Gets the sweepCast test results.
|
||
* @zh
|
||
* 获取 sweepCast 的检测结果。
|
||
*/
|
||
public readonly sweepCastResults: PhysicsRayResult[] = [];
|
||
|
||
/**
|
||
* @en
|
||
* Gets the collision matrix that used for initialization only.
|
||
* @zh
|
||
* 获取碰撞矩阵，它仅用于初始化。
|
||
*/
|
||
public readonly collisionMatrix: ICollisionMatrix = new CollisionMatrix(1) as ICollisionMatrix;
|
||
|
||
/**
|
||
* @en
|
||
* The minimum size of the collision body.
|
||
* @zh
|
||
* 碰撞体的最小尺寸。
|
||
*/
|
||
public minVolumeSize = 1e-5;
|
||
|
||
public readonly useNodeChains: boolean = false;
|
||
|
||
private _enable = true;
|
||
private _allowSleep = true;
|
||
private _maxSubSteps = 1;
|
||
private _subStepCount = 0;
|
||
private _fixedTimeStep = 1.0 / 60.0;
|
||
private _autoSimulation = true;
|
||
private _accumulator = 0;
|
||
private _sleepThreshold = 0.1;
|
||
private readonly _gravity = new Vec3(0, -10, 0);
|
||
private _material!: PhysicsMaterial; //default physics material
|
||
private static readonly _instance: PhysicsSystem | null = null;
|
||
private readonly raycastOptions: IRaycastOptions = {
|
||
group: -1,
|
||
mask: -1,
|
||
queryTrigger: true,
|
||
maxDistance: 10000000,
|
||
}
|
||
|
||
private readonly raycastResultPool = new memop.RecyclePool<PhysicsRayResult>((): PhysicsRayResult => new PhysicsRayResult(), 1);
|
||
private readonly sweepResultPool = new memop.RecyclePool<PhysicsRayResult>((): PhysicsRayResult => new PhysicsRayResult(), 1);
|
||
|
||
private constructor () {
|
||
super();
|
||
}
|
||
|
||
postUpdate (deltaTime: number): void {
|
||
if (EDITOR_NOT_IN_PREVIEW && !this._executeInEditMode && !selector.runInEditor) return;
|
||
|
||
if (!this.physicsWorld) return;
|
||
|
||
if (!this._enable) {
|
||
this.physicsWorld.syncSceneToPhysics();
|
||
return;
|
||
}
|
||
|
||
if (this._autoSimulation) {
|
||
this._subStepCount = 0;
|
||
this._accumulator += deltaTime;
|
||
director.emit(Director.EVENT_BEFORE_PHYSICS);
|
||
while (this._subStepCount < this._maxSubSteps) {
|
||
if (this._accumulator >= this._fixedTimeStep) {
|
||
this.physicsWorld.syncSceneToPhysics();
|
||
this.physicsWorld.step(this._fixedTimeStep);
|
||
this.physicsWorld.emitEvents();
|
||
this.physicsWorld.syncAfterEvents();
|
||
this._accumulator -= this._fixedTimeStep;
|
||
this._subStepCount++;
|
||
} else {
|
||
this.physicsWorld.syncSceneToPhysics();
|
||
break;
|
||
}
|
||
}
|
||
director.emit(Director.EVENT_AFTER_PHYSICS);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Reset the physics configuration.
|
||
* @zh
|
||
* 重置物理配置。
|
||
*/
|
||
resetConfiguration (config?: IPhysicsConfig): void {
|
||
const allowSleep = config ? config.allowSleep : settings.querySettings(Settings.Category.PHYSICS, 'allowSleep');
|
||
if (typeof allowSleep === 'boolean') this._allowSleep = allowSleep;
|
||
const fixedTimeStep = config ? config.fixedTimeStep : settings.querySettings(Settings.Category.PHYSICS, 'fixedTimeStep');
|
||
if (typeof fixedTimeStep === 'number') this._fixedTimeStep = fixedTimeStep;
|
||
const maxSubSteps = config ? config.maxSubSteps : settings.querySettings(Settings.Category.PHYSICS, 'maxSubSteps');
|
||
if (typeof maxSubSteps === 'number') this._maxSubSteps = maxSubSteps;
|
||
const sleepThreshold = config ? config.sleepThreshold : settings.querySettings(Settings.Category.PHYSICS, 'sleepThreshold');
|
||
if (typeof sleepThreshold === 'number') this._sleepThreshold = sleepThreshold;
|
||
const autoSimulation = config ? config.autoSimulation : settings.querySettings(Settings.Category.PHYSICS, 'autoSimulation');
|
||
if (typeof autoSimulation === 'boolean') this.autoSimulation = autoSimulation;
|
||
|
||
const gravity = config ? config.gravity : settings.querySettings(Settings.Category.PHYSICS, 'gravity');
|
||
if (gravity) Vec3.copy(this._gravity, gravity);
|
||
|
||
const collisionMatrix = config ? config.collisionMatrix : settings.querySettings(Settings.Category.PHYSICS, 'collisionMatrix');
|
||
if (collisionMatrix) {
|
||
for (const i in collisionMatrix) {
|
||
this.collisionMatrix[`${1 << parseInt(i)}`] = collisionMatrix[i];
|
||
}
|
||
}
|
||
const collisionGroups = config ? config.collisionGroups : settings.querySettings<Array<{ name: string, index: number }>>(Settings.Category.PHYSICS, 'collisionGroups');
|
||
if (collisionGroups) {
|
||
const cg = collisionGroups;
|
||
if (cg instanceof Array) {
|
||
cg.forEach((v): void => { PhysicsGroup[v.name] = 1 << v.index; });
|
||
Enum.update(PhysicsGroup);
|
||
}
|
||
}
|
||
|
||
if (this.physicsWorld) {
|
||
this.physicsWorld.setGravity(this._gravity);
|
||
this.physicsWorld.setAllowSleep(this._allowSleep);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Reset the accumulator of time to given value.
|
||
* @zh
|
||
* 重置时间累积总量为给定值。
|
||
*/
|
||
resetAccumulator (time = 0): void {
|
||
this._accumulator = time;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Perform simulation steps for the physics world.
|
||
* @zh
|
||
* 执行物理世界的模拟步进。
|
||
* @param fixedTimeStep
|
||
*/
|
||
step (fixedTimeStep: number, deltaTime?: number, maxSubSteps?: number): void {
|
||
if (this.physicsWorld) this.physicsWorld.step(fixedTimeStep, deltaTime, maxSubSteps);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Sync the scene world transform changes to the physics world.
|
||
* @zh
|
||
* 同步场景世界的变化信息到物理世界中。
|
||
*/
|
||
syncSceneToPhysics (): void {
|
||
if (this.physicsWorld) this.physicsWorld.syncSceneToPhysics();
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Emit trigger and collision events.
|
||
* @zh
|
||
* 触发`trigger`和`collision`事件。
|
||
*/
|
||
emitEvents (): void {
|
||
if (this.physicsWorld) this.physicsWorld.emitEvents();
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Collision detect all collider, and record all the detected results, through PhysicsSystem.Instance.RaycastResults access to the results.
|
||
* @zh
|
||
* 检测所有的碰撞盒，并记录所有被检测到的结果，通过 PhysicsSystem.instance.raycastResults 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
raycast (worldRay: geometry.Ray, mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.raycastResultPool.reset();
|
||
this.raycastResults.length = 0;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.raycast(worldRay, this.raycastOptions, this.raycastResultPool, this.raycastResults);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Collision detect all collider, and record and ray test results with the shortest distance
|
||
* by PhysicsSystem.Instance.RaycastClosestResult access to the results.
|
||
* @zh
|
||
* 检测所有的碰撞盒，并记录与射线距离最短的检测结果，通过 PhysicsSystem.instance.raycastClosestResult 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
raycastClosest (worldRay: geometry.Ray, mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.raycastClosest(worldRay, this.raycastOptions, this.raycastClosestResult);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Collision detect all collider and record all the detected results, using
|
||
* PhysicsSystem.Instance.lineStripCastResults to access the results.
|
||
* @zh
|
||
* 逐线段检测所有的碰撞盒，并记录所有检测结果。通过 PhysicsSystem.instance.lineStripCastResults 访问结果。
|
||
* @param samplePointsWorldSpace @zh 世界空间下的采样点/直线段 @en sample points/line segments in world space
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 沿着直线段的最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance along the line segments, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
lineStripCast (samplePointsWorldSpace: Array<Vec3>, mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (samplePointsWorldSpace.length < 2) return false;
|
||
this.lineStripCastResults = [];
|
||
let distance = 0;
|
||
const worldRay = new geometry.Ray();
|
||
for (let i = 1; i < samplePointsWorldSpace.length; ++i) {
|
||
if (distance > maxDistance) break;
|
||
|
||
const fromPoint = samplePointsWorldSpace[i - 1];
|
||
const toPoint = samplePointsWorldSpace[i];
|
||
const direction = new Vec3();
|
||
Vec3.subtract(direction, toPoint, fromPoint);
|
||
const stepLength = Vec3.len(direction);
|
||
distance += stepLength;
|
||
Vec3.multiplyScalar(direction, direction, 1.0 / stepLength);
|
||
worldRay.d = direction;
|
||
worldRay.o = fromPoint;
|
||
const hit = this.raycast(worldRay, mask, stepLength, queryTrigger);
|
||
if (hit) {
|
||
for (let re = 0; re < this.raycastResults.length; re++) {
|
||
const result = this.raycastResults[re];
|
||
//if ray starts inside shape and hit point equals to start point, this should be ignored
|
||
if (re === 0 && Vec3.equals(fromPoint, result.hitPoint)) { continue; }
|
||
const copiedResult = new PhysicsLineStripCastResult();
|
||
copiedResult._assign(result.hitPoint, result.distance, result.collider, result.hitNormal, i - 1);
|
||
this.lineStripCastResults.push(copiedResult);
|
||
}
|
||
}
|
||
}
|
||
return this.lineStripCastResults.length > 0;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Collision detect all collider, and record the ray test results with the shortest distance.
|
||
* Using PhysicsSystem.Instance.lineStripCastClosestResult to access the result.
|
||
* @zh
|
||
* 逐线段检测所有的碰撞盒，并记录沿这些线段距离最短的检测结果，通过 PhysicsSystem.instance.lineStripCastClosestResult 访问结果。
|
||
* @param samplePointsWorldSpace @zh 世界空间下的采样点/直线段 @en sample points/line segments in world space
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 沿着直线段的最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance along the line segments, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
lineStripCastClosest (samplePointsWorldSpace: Array<Vec3>, mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (samplePointsWorldSpace.length < 2) { return false; }
|
||
let distance = 0;
|
||
const worldRay = new geometry.Ray();
|
||
let hit = false;
|
||
for (let i = 1; i < samplePointsWorldSpace.length; ++i) {
|
||
if (distance > maxDistance) break;
|
||
|
||
const fromPoint = samplePointsWorldSpace[i - 1];
|
||
const toPoint = samplePointsWorldSpace[i];
|
||
const direction = new Vec3();
|
||
Vec3.subtract(direction, toPoint, fromPoint);
|
||
const stepLength = Vec3.len(direction);
|
||
distance += stepLength;
|
||
Vec3.multiplyScalar(direction, direction, 1.0 / stepLength);
|
||
worldRay.d = direction;
|
||
worldRay.o = fromPoint;
|
||
hit = this.raycastClosest(worldRay, mask, stepLength, queryTrigger);
|
||
if (hit) {
|
||
const result = this.raycastClosestResult;
|
||
const copiedResult = new PhysicsLineStripCastResult();
|
||
copiedResult._assign(result.hitPoint, result.distance, result.collider, result.hitNormal, i - 1);
|
||
this.lineStripCastClosestResult = copiedResult;
|
||
break;
|
||
}
|
||
}
|
||
return hit;
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a box along a ray and record information on what was hit.
|
||
* Access the results through PhysicsSystem.Instance.sweepCastResults.
|
||
* @zh
|
||
* 将盒体沿着射线发射，记录所有被检测到的结果，通过 PhysicsSystem.instance.sweepCastResults 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param halfExtent @zh 盒体的一半尺寸 @en Half extent of the box
|
||
* @param orientation @zh 盒体的方向 @en Orientation of the box
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepBox (worldRay: geometry.Ray, halfExtent: IVec3Like, orientation: IQuatLike,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.sweepResultPool.reset();
|
||
this.sweepCastResults.length = 0;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepBox(worldRay, halfExtent, orientation,
|
||
this.raycastOptions, this.sweepResultPool, this.sweepCastResults);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a box along a ray and record information on the closest hit.
|
||
* Access the results through PhysicsSystem.Instance.sweepCastClosestResult.
|
||
* @zh
|
||
* 将盒体沿着射线发射，记录距离最近的碰撞结果，通过 PhysicsSystem.instance.sweepCastClosestResult 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param halfExtent @zh 盒体的一半尺寸 @en Half extent of the box
|
||
* @param orientation @zh 盒体的方向 @en Orientation of the box
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepBoxClosest (worldRay: geometry.Ray, halfExtent: IVec3Like, orientation: IQuatLike,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepBoxClosest(worldRay, halfExtent, orientation,
|
||
this.raycastOptions, this.sweepCastClosestResult);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a sphere along a ray and record information on what was hit.
|
||
* Access the results through PhysicsSystem.Instance.sweepCastResults.
|
||
* @zh
|
||
* 将球体沿着射线发射，记录所有被检测到的结果，通过 PhysicsSystem.instance.sweepCastResults 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param radius @zh 球体的半径 @en Radius of the sphere
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepSphere (worldRay: geometry.Ray, radius: number,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.sweepResultPool.reset();
|
||
this.sweepCastResults.length = 0;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepSphere(worldRay, radius,
|
||
this.raycastOptions, this.sweepResultPool, this.sweepCastResults);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a sphere along a ray and record information on the closest hit.
|
||
* Access the result through PhysicsSystem.Instance.sweepCastClosestResult.
|
||
* @zh
|
||
* 将球体沿着射线发射，记录距离最近的碰撞结果，通过 PhysicsSystem.instance.sweepCastClosestResult 访问结果。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param radius @zh 球体的半径 @en Radius of the sphere
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepSphereClosest (worldRay: geometry.Ray, radius: number,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepSphereClosest(worldRay, radius,
|
||
this.raycastOptions, this.sweepCastClosestResult);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a capsule along a ray and record information on what was hit.
|
||
* Access the results through PhysicsSystem.Instance.sweepCastResults.
|
||
* Capsule's default axis is along the world space Y axis.
|
||
* @zh
|
||
* 将胶囊体沿着射线发射，记录所有被检测到的结果，通过 PhysicsSystem.instance.sweepCastResults 访问结果。
|
||
* 胶囊体的默认朝向是世界空间下的 Y 轴。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param radius @zh 胶囊体的半径 @en Radius of the capsule
|
||
* @param height @zh 胶囊体末端两个半球圆心的距离 @en Distance between the two half-sphere centers of the capsule
|
||
* @param orientation @zh 胶囊体的朝向 @en Orientation of the capsule
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepCapsule (worldRay: geometry.Ray, radius: number, height: number, orientation: IQuatLike,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.sweepResultPool.reset();
|
||
this.sweepCastResults.length = 0;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepCapsule(worldRay, radius, height, orientation,
|
||
this.raycastOptions, this.sweepResultPool, this.sweepCastResults);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Cast a capsule along a ray and record information on the closest hit.
|
||
* Access the result through PhysicsSystem.Instance.sweepCastClosestResult.
|
||
* Capsule's default axis is along the world space Y axis.
|
||
* @zh
|
||
* 将胶囊体沿着射线发射，记录距离最近的碰撞结果，通过 PhysicsSystem.instance.sweepCastClosestResult 访问结果。
|
||
* 胶囊体的默认朝向是世界空间下的 Y 轴。
|
||
* @param worldRay @zh 世界空间下的一条射线 @en A ray in world space
|
||
* @param radius @zh 胶囊体的半径 @en Radius of the capsule
|
||
* @param height @zh 胶囊体末端两个半球圆心的距离 @en Distance between the two half-sphere centers of the capsule
|
||
* @param orientation @zh 胶囊体的朝向 @en Orientation of the capsule
|
||
* @param mask @zh 掩码，默认为 0xffffffff @en Mask, default value is 0xffffffff
|
||
* @param maxDistance @zh 最大检测距离，默认为 10000000，目前请勿传入 Infinity 或 Number.MAX_VALUE
|
||
* @en Maximum detection distance, default value is 10000000, do not pass Infinity or Number.MAX_VALUE for now
|
||
* @param queryTrigger @zh 是否检测触发器 @en Whether to detect triggers
|
||
* @return {boolean} @zh 表示是否有检测到碰撞 @en Indicates whether a collision has been detected
|
||
*/
|
||
sweepCapsuleClosest (worldRay: geometry.Ray, radius: number, height: number, orientation: IQuatLike,
|
||
mask = 0xffffffff, maxDistance = 10000000, queryTrigger = true): boolean {
|
||
if (!this.physicsWorld) return false;
|
||
this.raycastOptions.mask = mask >>> 0;
|
||
this.raycastOptions.maxDistance = maxDistance;
|
||
this.raycastOptions.queryTrigger = queryTrigger;
|
||
return this.physicsWorld.sweepCapsuleClosest(worldRay, radius, height, orientation,
|
||
this.raycastOptions, this.sweepCastClosestResult);
|
||
}
|
||
|
||
private _updateMaterial (): void {
|
||
if (this.physicsWorld) this.physicsWorld.setDefaultMaterial(this._material);
|
||
}
|
||
|
||
/**
|
||
* @en
|
||
* Construct and register the system singleton.
|
||
* If the module is pre-loaded, it will be executed automatically.
|
||
* @zh
|
||
* 构造并注册系统单例。
|
||
* 预先加载模块的情况下，会自动执行。
|
||
*/
|
||
static constructAndRegister (): void {
|
||
const enabled = settings.querySettings(Settings.Category.PHYSICS, 'enabled') ?? true;
|
||
if (!enabled) { return; }
|
||
if (!PhysicsSystem._instance) {
|
||
// Construct physics world and physics system only once
|
||
const sys = new PhysicsSystem();
|
||
(PhysicsSystem._instance as unknown as PhysicsSystem) = sys;
|
||
sys.resetConfiguration();
|
||
constructDefaultWorld(sys);
|
||
director.registerSystem(PhysicsSystem.ID, sys, sys.priority);
|
||
|
||
game.onPostProjectInitDelegate.add(sys.initDefaultMaterial.bind(sys));
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* By registering the initialization event, the system can be automatically
|
||
* constructed and registered when the module is pre-loaded
|
||
*/
|
||
director.once(Director.EVENT_INIT, (): void => { PhysicsSystem.constructAndRegister(); });
|