Class Query

实体查询类

Export

Hierarchy

Constructors

constructor

Properties

_engine queryMask

Accessors

engine firstHitOnly raycaster

Methods

_onClick addEventListener boxSelect dispatchEvent dispose raycast raycastUseMouse raycastUseRay removeAllEventListeners removeEventListener removeEventListenerByEventId screenCoordToNDC screenCoordToRay screenCoordToWorldCoord testEntity worldCoordToScreenCoord

Constructors

constructor

Properties

Protected _engine

_engine: Engine

queryMask

queryMask: number = QueryMask.All

查询遮罩值

Memberof

Query

Accessors

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

firstHitOnly

  • set firstHitOnly(value): void

  • 设置BVH射线检测时是否只要命中即结束检测，用于提升检测速度

    Parameters

    • value: boolean

    Returns void

    Memberof

    Query

raycaster

  • get raycaster(): Readonly<Raycaster>

  • 获取射线拾取器

    Returns Readonly<Raycaster>

    Memberof

    Query

Methods

_onClick

  • _onClick(event): void

  • 响应鼠标单击事件

    Parameters

    • event: MouseEvent

    Returns void

    Memberof

    Query

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      } = {}

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

boxSelect

  • 框选查询

    Parameters

    • start: number[] | Vector2
    • end: number[] | Vector2
    • Optional maxDepth: number = Number.MAX_VALUE
    • Optional queryMask: number = QueryMask.All

    Returns Entity[]

    Memberof

    Query

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

raycast

  • 射线查询

    Parameters

    • Optional queryMask: number = QueryMask.All

    Returns HitResult[]

    Memberof

    Query

raycastUseMouse

  • 通过鼠标进行射线查询

    Parameters

    • mouseX: number

      鼠标X坐标（单位：像素）

    • mouseY: number

      鼠标Y坐标（单位：像素）

    • Optional queryMask: number = QueryMask.All

    Returns HitResult[]

    Memberof

    Query

raycastUseRay

  • 通过指定射线执行射线查询

    Parameters

    • ray: Ray

      射线对象

    • Optional queryMask: number = QueryMask.All

    Returns HitResult[]

    Memberof

    Query

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

screenCoordToNDC

  • 屏幕坐标转NDC坐标

    Parameters

    • screenX: number

      当前鼠标X坐标（单位：像素）

    • screenY: number

      当前鼠标Y坐标（单位：像素）

    Returns Vector2

    NDC坐标

    Memberof

    Query

screenCoordToRay

  • 通过屏幕坐标获取世界空间下从相机的近裁剪面出发穿过屏幕上的像素坐标点的射线

    Parameters

    • screenX: number

      当前鼠标X坐标（单位：像素）

    • screenY: number

      当前鼠标Y坐标（单位：像素）

    Returns Ray

    射线对象

    Memberof

    Query

screenCoordToWorldCoord

  • 屏幕坐标转世界坐标

    Parameters

    • screenX: number

      屏幕X坐标（单位：像素）

    • screenY: number

      屏幕Y坐标（单位：像素）

    • Optional distanceToCamera: number

      投影平面距离相机距离（注：需要在相机远近裁剪面之间）

    Returns Vector3

    世界坐标

    Memberof

    Query

testEntity

  • 检测射线是否与实体相交

    Parameters

    • ray: Ray
    • entity: Entity
    • Optional queryMask: number = QueryMask.All

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Query

worldCoordToScreenCoord

  • 世界坐标转换屏幕坐标

    Parameters

    • x: number

      世界坐标X值

    • y: number

      世界坐标Y值

    • z: number

      世界坐标Z值

    Returns Vector2

    屏幕坐标

    Memberof

    Query

Settings

Member Visibility

Theme

On This Page