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>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in .temp/docdirectory/doc.d.ts:6676
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

attachedNodeSearch playground for attachedNode

attachedNode: AbstractMesh

Abstract mesh the behavior is set on

currentDraggingPointerIdSearch playground for currentDraggingPointerId

currentDraggingPointerId: number

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

detachCameraControlsSearch playground for detachCameraControls

detachCameraControls: boolean

If camera controls should be detached during the drag

dragButtonsSearch playground for dragButtons

dragButtons: number[]

Butttons that can be used to initiate a drag

dragDeltaRatioSearch 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)

draggingSearch playground for dragging

dragging: boolean

If the behavior is currently in a dragging state

lastDragPositionSearch playground for lastDragPosition

lastDragPosition: Vector3

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

maxDragAngleSearch 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)

moveAttachedSearch playground for moveAttached

moveAttached: boolean

If the attached mesh should be moved when dragged

onDragEndObservableSearch playground for onDragEndObservable

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

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

onDragObservableSearch playground for onDragObservable

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

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

onDragStartObservableSearch playground for onDragStartObservable

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

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

onEnabledObservableSearch playground for onEnabledObservable

onEnabledObservable: Observable<boolean>

Fires each time behavior enabled state changes

startAndReleaseDragOnPointerEventsSearch playground for startAndReleaseDragOnPointerEvents

startAndReleaseDragOnPointerEvents: boolean

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

updateDragPlaneSearch playground for updateDragPlane

updateDragPlane: boolean

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

useObjectOrientationForDraggingSearch playground for useObjectOrientationForDragging

useObjectOrientationForDragging: boolean

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

validateDragSearch playground for validateDrag

validateDrag: (targetPosition: Vector3) => boolean

Predicate to determine if it is valid to move the object to a new position when it is moved

param

Type declaration

- (targetPosition: Vector3): boolean
- Parameters
  - targetPosition: Vector3
  Returns boolean

Accessors

currentDraggingPointerID

get currentDraggingPointerID(): number
set currentDraggingPointerID(currentDraggingPointerID: number): any

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

deprecated

Please use currentDraggingPointerId instead

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

deprecated

Please use currentDraggingPointerId instead

Parameters
- currentDraggingPointerID: number
Returns any

enabled

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

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

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

Parameters
- value: boolean
Returns any

name

get name(): string

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

Returns string

options

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

- Defined in .temp/docdirectory/doc.d.ts:6666
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:6673
Sets the options used by the behavior

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

Methods

attachSearch playground for attach

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

- Defined in .temp/docdirectory/doc.d.ts:6710
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

detachSearch playground for detach

detach(): void

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

Returns void

initSearch playground for init

init(): void

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

Returns void

releaseDragSearch playground for releaseDrag

releaseDrag(): void

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

Returns void

startDragSearch playground for startDrag

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

- Defined in .temp/docdirectory/doc.d.ts:6723
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 any

enabled

Returns boolean

Parameters

value: boolean

Returns any

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 any

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