Class 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

Behavior<AbstractMesh>

Constructors

constructor

new PointerDragBehavior(options?: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }): PointerDragBehavior

- Defined in .temp/docdirectory/doc.d.ts:6984
Creates a pointer drag behavior that can be attached to a mesh

Parameters
- Optional options: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }
  
  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)
  - Optional dragAxis?: Vector3
  - Optional dragPlaneNormal?: Vector3
Returns PointerDragBehavior

Properties

attachedNode Search playground for attachedNode

attachedNode: AbstractMesh

Abstract mesh the behavior is set on

currentDraggingPointerId Search playground for currentDraggingPointerId

currentDraggingPointerId: number

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

detachCameraControls Search playground for detachCameraControls

detachCameraControls: boolean

If camera controls should be detached during the drag

dragButtons Search playground for dragButtons

dragButtons: number[]

Butttons that can be used to initiate a drag

dragDeltaRatio Search playground for 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 Search playground for dragging

dragging: boolean

If the behavior is currently in a dragging state

lastDragPosition Search playground for lastDragPosition

lastDragPosition: Vector3

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

maxDragAngle Search playground for 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 Search playground for moveAttached

moveAttached: boolean

If the attached mesh should be moved when dragged

onDragEndObservable Search playground for onDragEndObservable

onDragEndObservable: Observable<{ dragPlanePoint: Vector3; pointerId: number; pointerInfo: Nullable<PointerInfo> }>

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

dragPlanePoint in world space where the drag intersects the drag plane

(if validatedDrag is used, the position of the attached mesh might not equal dragPlanePoint)

onDragObservable Search playground for onDragObservable

onDragObservable: Observable<{ delta: Vector3; dragDistance: number; dragPlaneNormal: Vector3; dragPlanePoint: Vector3; pointerId: number; pointerInfo: Nullable<PointerInfo> }>

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

(if validatedDrag is used, the position of the attached mesh might not equal dragPlanePoint)

onDragStartObservable Search playground for onDragStartObservable

onDragStartObservable: Observable<{ dragPlanePoint: Vector3; pointerId: number; pointerInfo: Nullable<PointerInfo> }>

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

dragPlanePoint in world space where the drag intersects the drag plane

(if validatedDrag is used, the position of the attached mesh might not equal dragPlanePoint)

onEnabledObservable Search playground for onEnabledObservable

onEnabledObservable: Observable<boolean>

Fires each time behavior enabled state changes

startAndReleaseDragOnPointerEvents Search playground for startAndReleaseDragOnPointerEvents

startAndReleaseDragOnPointerEvents: boolean

If pointer events should start and release the drag (Default: true)

updateDragPlane Search playground for updateDragPlane

updateDragPlane: boolean

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

useObjectOrientationForDragging Search playground for useObjectOrientationForDragging

useObjectOrientationForDragging: boolean

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

validateDrag Search playground for validateDrag

validateDrag: ((targetPosition: Vector3) => boolean)

Type declaration

- (targetPosition: Vector3): boolean
- Predicate to determine if it is valid to move the object to a new position when it is moved
  
  Parameters
  - targetPosition: Vector3
  Returns boolean

Accessors

currentDraggingPointerID

get currentDraggingPointerID(): number
set currentDraggingPointerID(currentDraggingPointerID: number): void

- Defined in .temp/docdirectory/doc.d.ts:6874
Get or set the currentDraggingPointerId

deprecated
Please use currentDraggingPointerId instead

Returns number
- Defined in .temp/docdirectory/doc.d.ts:6875
Get or set the currentDraggingPointerId

deprecated
Please use currentDraggingPointerId instead

Parameters
- currentDraggingPointerID: number
Returns void

enabled

get enabled(): boolean
set enabled(value: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:6949
If the drag behavior will react to drag events (Default: true)

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:6948
If the drag behavior will react to drag events (Default: true)

Parameters
- value: boolean
Returns void

name

get name(): string

Implementation of Behavior.name
- Defined in .temp/docdirectory/doc.d.ts:6996
The name of the behavior

Returns string

options

get options(): { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }
set options(options: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }): void

- Defined in .temp/docdirectory/doc.d.ts:6967
Gets the options used by the behavior

Returns { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }
- Optional dragAxis?: Vector3
- Optional dragPlaneNormal?: Vector3
- Defined in .temp/docdirectory/doc.d.ts:6974
Sets the options used by the behavior

Parameters
- options: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }
  - Optional dragAxis?: Vector3
  - Optional dragPlaneNormal?: Vector3
Returns void

Methods

attach Search playground for attach

attach(ownerNode: AbstractMesh, predicate?: ((m: AbstractMesh) => boolean)): void

Implementation of Behavior.attach
- Defined in .temp/docdirectory/doc.d.ts:7011
Attaches the drag behavior the passed in mesh

Parameters
- ownerNode: AbstractMesh
  
  The mesh that will be dragged around once attached
- Optional predicate: ((m: AbstractMesh) => boolean)
  
  Predicate to use for pick filtering
  - - (m: AbstractMesh): boolean
    - Parameters
      - m: AbstractMesh
      Returns boolean
Returns void

detach Search playground for detach

detach(): void

Implementation of Behavior.detach
- Defined in .temp/docdirectory/doc.d.ts:7037
Detaches the behavior from the mesh

Returns void

init Search playground for init

init(): void

Implementation of Behavior.init
- Defined in .temp/docdirectory/doc.d.ts:7000
Initializes the behavior

Returns void

releaseDrag Search playground for releaseDrag

releaseDrag(): void

- Defined in .temp/docdirectory/doc.d.ts:7015
Force release the drag action by code.

Returns void

startDrag Search playground for startDrag

startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:7024
Simulates the start of a pointer drag event on the behavior

Parameters
- Optional pointerId: number
  
  pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
- Optional fromRay: Ray
  
  initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
- Optional startPickedPoint: Vector3
  
  picked point of the pointer to be simulated (Default: attached mesh position)
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }

Optional dragAxis?: Vector3

Optional dragPlaneNormal?: Vector3

Returns PointerDragBehavior

Properties

attachedNodeSearch playground for attachedNode

currentDraggingPointerIdSearch playground for currentDraggingPointerId

detachCameraControlsSearch playground for detachCameraControls

dragButtonsSearch playground for dragButtons

dragDeltaRatioSearch playground for dragDeltaRatio

draggingSearch playground for dragging

lastDragPositionSearch playground for lastDragPosition

maxDragAngleSearch playground for maxDragAngle

moveAttachedSearch playground for moveAttached

onDragEndObservableSearch playground for onDragEndObservable

onDragObservableSearch playground for onDragObservable

onDragStartObservableSearch playground for onDragStartObservable

onEnabledObservableSearch playground for onEnabledObservable

startAndReleaseDragOnPointerEventsSearch playground for startAndReleaseDragOnPointerEvents

updateDragPlaneSearch playground for updateDragPlane

useObjectOrientationForDraggingSearch playground for useObjectOrientationForDragging

validateDragSearch playground for validateDrag

Type declaration

Parameters

targetPosition: Vector3

Returns boolean

Accessors

currentDraggingPointerID

Returns number

Parameters

currentDraggingPointerID: number

Returns void

enabled

Returns boolean

Parameters

value: boolean

Returns void

name

Returns string

options

Returns { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }

Optional dragAxis?: Vector3

Optional dragPlaneNormal?: Vector3

Parameters

options: { dragAxis?: Vector3; dragPlaneNormal?: Vector3 }

Optional dragAxis?: Vector3

Optional dragPlaneNormal?: Vector3

Returns void

Methods

attachSearch playground for attach

Parameters

ownerNode: AbstractMesh

Optional predicate: ((m: AbstractMesh) => boolean)

Parameters

m: AbstractMesh

Returns boolean

Returns void

detachSearch playground for detach

Returns void

initSearch playground for init

Returns void

releaseDragSearch playground for releaseDrag

Returns void

startDragSearch playground for startDrag

Parameters

Optional pointerId: number

Optional fromRay: Ray

Optional startPickedPoint: Vector3

Returns void

attachedNode Search playground for attachedNode

currentDraggingPointerId Search playground for currentDraggingPointerId

detachCameraControls Search playground for detachCameraControls

dragButtons Search playground for dragButtons

dragDeltaRatio Search playground for dragDeltaRatio

dragging Search playground for dragging

lastDragPosition Search playground for lastDragPosition

maxDragAngle Search playground for maxDragAngle

moveAttached Search playground for moveAttached

onDragEndObservable Search playground for onDragEndObservable

onDragObservable Search playground for onDragObservable

onDragStartObservable Search playground for onDragStartObservable

onEnabledObservable Search playground for onEnabledObservable

startAndReleaseDragOnPointerEvents Search playground for startAndReleaseDragOnPointerEvents

updateDragPlane Search playground for updateDragPlane

useObjectOrientationForDragging Search playground for useObjectOrientationForDragging

validateDrag Search playground for validateDrag

attach Search playground for attach

detach Search playground for detach

init Search playground for init

releaseDrag Search playground for releaseDrag

startDrag Search playground for startDrag