Skip to main content

Interface: DraggableOptions

Defined in: src/interaction/Draggable.ts:9

Options for configuring draggable behavior.

Properties​

autoRender?​

optional autoRender: boolean

Defined in: src/interaction/Draggable.ts:29

Render the scene after each drag update so the motion is visible without a running render loop. Defaults to true. Set to false if you render manually (e.g. inside onDrag) or run your own render loop.


constrainX?​

optional constrainX: [number, number]

Defined in: src/interaction/Draggable.ts:11

X-axis constraints as [min, max] or null for no constraint


constrainY?​

optional constrainY: [number, number]

Defined in: src/interaction/Draggable.ts:13

Y-axis constraints as [min, max] or null for no constraint


constrainZ?​

optional constrainZ: [number, number]

Defined in: src/interaction/Draggable.ts:15

Z-axis constraints as [min, max] or null for no constraint (3D scenes only)


onDrag()?​

optional onDrag: (mobject, position, delta) => void

Defined in: src/interaction/Draggable.ts:19

Callback during drag with position and delta

Parameters​

mobject​

Mobject

position​

Vector3Tuple

delta​

Vector3Tuple

Returns​

void


onDragEnd()?​

optional onDragEnd: (mobject, position) => void

Defined in: src/interaction/Draggable.ts:21

Callback when drag ends

Parameters​

mobject​

Mobject

position​

Vector3Tuple

Returns​

void


onDragStart()?​

optional onDragStart: (mobject, position) => void

Defined in: src/interaction/Draggable.ts:17

Callback when drag starts

Parameters​

mobject​

Mobject

position​

Vector3Tuple

Returns​

void


snapToGrid?​

optional snapToGrid: number

Defined in: src/interaction/Draggable.ts:23

Grid size for snapping, or null for no snapping