Skip to content

@tripo3d/engine / Pointer

Interface: Pointer ​

Defined in: pointer/pointer.ts:128

Engine eager 创建且 identity 稳定的鼠标事件控制面。

Properties ​

PropertyModifierTypeDescriptionDefined in
enabledpublicboolean是否允许native automatic admission;false时同步请求清空transient route,manual hitTest仍可使用。pointer/pointer.ts:130
raycasterreadonlyRaycasterPointer 内部复用并对业务开放配置的原生 Raycaster。pointer/pointer.ts:147

Methods ​

hitTest() ​

ts
hitTest(clientX, clientY): PointerHitResult;

Defined in: pointer/pointer.ts:139

在当前 View snapshot 与 candidate index 上执行同步 raycast。

Parameters ​

ParameterTypeDescription
clientXnumber相对浏览器 viewport 的横坐标。
clientYnumber相对浏览器 viewport 的纵坐标。

Returns ​

PointerHitResult

located 或 unlocated 的稳定判别联合结果。

Throws ​

坐标不是有限数值或Pointer/Engine终态后调用时同步抛出。


onMissed() ​

ts
onMissed(handler): () => void;

Defined in: pointer/pointer.ts:145

Parameters ​

ParameterTypeDescription
handler(event) => voidclick/contextmenu 已定位但未命中 Entity 时调用的同步函数。

Returns ​

幂等 unsubscribe。

() => void

Throws ​

handler无效或Pointer/Engine终态后注册时同步抛出。


suspend() ​

ts
suspend(): () => void;

Defined in: pointer/pointer.ts:154

增加一次automatic Pointer suspend计数并清空transient route。

Returns ​

当前调用独占的幂等release;Engine终态后release保持无操作。

() => void

Throws ​

Pointer或Engine终态后调用时同步抛出。

基于 MIT 协议发布(内部使用)