Options
Menu

Class JSPickingCollider

Pure JS picking collider for display objects. Used with the RaycastPicker picking object.

see

away.base.DisplayObject#pickingCollider

see

away.pick.RaycastPicker

class

away.pick.JSPickingCollider

Hierarchy

  • JSPickingCollider

Index

Constructors

Methods

Constructors

constructor

  • Creates a new JSPickingCollider object.

    Parameters

    • Default value findClosestCollision: boolean = false

      Determines whether the picking collider searches for the closest collision along the ray. Defaults to false.

    Returns JSPickingCollider

Methods

testBillboardCollision

  • testBillboardCollision(billboard: Billboard, material: IMaterial, pickingCollision: PickingCollision): boolean

  • Tests a Billboard object for a collision with the picking ray.

    Parameters

    • billboard: Billboard

      The billboard instance to be tested.

    • material: IMaterial
    • pickingCollision: PickingCollision

      The collision object used to store the collision results

    Returns boolean

testLineCollision

  • testLineCollision(lineElements: LineElements, material: IMaterial, pickingCollision: PickingCollision, count: number, offset?: number): boolean

  • Tests a LineElements object for a collision with the picking ray.

    Parameters

    • lineElements: LineElements
    • material: IMaterial
    • pickingCollision: PickingCollision
    • count: number
    • Default value offset: number = 0

    Returns boolean

testTriangleCollision

  • testTriangleCollision(triangleElements: TriangleElements, material: IMaterial, pickingCollision: PickingCollision, count: number, offset?: number): boolean

  • Tests a TriangleElements object for a collision with the picking ray.

    Parameters

    • triangleElements: TriangleElements
    • material: IMaterial
    • pickingCollision: PickingCollision
    • count: number
    • Default value offset: number = 0

    Returns boolean

Generated using TypeDoc