PointerDragBehavior

A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events

Hierarchy

  • PointerDragBehavior

Implements

Index

Constructors

constructor

  • Creates a pointer drag behavior that can be attached to a mesh

    Parameters

    • Optional options: object

      The drag axis or normal of the plane that will be dragged across. If no options are specified the drag plane will always face the ray's origin (eg. camera)

    Returns PointerDragBehavior

Properties

currentDraggingPointerID

currentDraggingPointerID: number

The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)

detachCameraControls

detachCameraControls: boolean

If camera controls should be detached during the drag

dragDeltaRatio

dragDeltaRatio: number

The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)

dragging

dragging: boolean

If the behavior is currently in a dragging state

enabled

enabled: boolean

If the drag behavior will react to drag events (Default: true)

lastDragPosition

lastDragPosition: Vector3

The last position where the pointer hit the drag plane in world space

maxDragAngle

maxDragAngle: number

The maximum tolerated angle between the drag plane and dragging pointer rays to trigger pointer events. Set to 0 to allow any angle (default: 0)

moveAttached

moveAttached: boolean

If the attached mesh should be moved when dragged

name

name: string

The name of the behavior

onDragEndObservable

onDragEndObservable: Observable<object>

Fires each time a drag ends (eg. mouse release after drag)

onDragObservable

onDragObservable: Observable<object>

Fires each time the attached mesh is dragged with the pointer

  • delta between last drag position and current drag position in world space
  • dragDistance along the drag axis
  • dragPlaneNormal normal of the current drag plane used during the drag
  • dragPlanePoint in world space where the drag intersects the drag plane

onDragStartObservable

onDragStartObservable: Observable<object>

Fires each time a drag begins (eg. mouse down on mesh)

updateDragPlane

updateDragPlane: boolean

If the drag plane orientation should be updated during the dragging (Default: true)

useObjectOrienationForDragging

useObjectOrienationForDragging: boolean

If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)

Methods

attach

  • attach(ownerNode: Mesh): void
  • Attaches the drag behavior the passed in mesh

    Parameters

    • ownerNode: Mesh

      The mesh that will be dragged around once attached

    Returns void

detach

  • detach(): void
  • Detaches the behavior from the mesh

    Returns void

init

  • init(): void
  • Initializes the behavior

    Returns void

releaseDrag

  • releaseDrag(): void
  • Returns void

Generated using TypeDoc