Package com.simsilica.lemur.event

Class DragHandler

java.lang.Object

com.simsilica.lemur.event.DefaultCursorListener

com.simsilica.lemur.event.DragHandler

All Implemented Interfaces:

CursorListener

public class DragHandler
extends DefaultCursorListener

Work in progress.

Constructor Summary

Constructors

Constructor	Description
DragHandler()
DragHandler(Function<Spatial,Spatial> draggableLocator)

Method Summary

Modifier and Type	Method	Description
void	cursorButtonEvent(CursorButtonEvent event, Spatial target, Spatial capture)
void	cursorMoved(CursorMotionEvent event, Spatial target, Spatial capture)
protected void	endDrag(CursorButtonEvent event, Spatial target, Spatial capture)
protected Spatial	findDraggable(Spatial capture)	Finds the draggable spatial for the specified capture spatial.
boolean	getConsumeDrags()
boolean	getConsumeDrops()
Function<Spatial,Spatial>	getDraggableLocator()
protected Vector2f	getDragStartLocation()
boolean	isDragging()
void	setConsumeDrags(boolean consumeDrags)
void	setConsumeDrops(boolean consumeDrops)
void	setDraggableLocator(Function<Spatial,Spatial> draggableLocator)	Sets the function that will be used to find the draggable spatial relative to the spatial that was clicked.
protected void	startDrag(CursorButtonEvent event, Spatial target, Spatial capture)

Methods inherited from class com.simsilica.lemur.event.DefaultCursorListener

click, cursorEntered, cursorExited

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DragHandler

public DragHandler()

DragHandler

public DragHandler(Function<Spatial,Spatial> draggableLocator)

Method Details

setDraggableLocator

public void setDraggableLocator(Function<Spatial,Spatial> draggableLocator)

Sets the function that will be used to find the draggable spatial relative to the spatial that was clicked. By default, this is the identity() function and will return the spatial that was clicked.

getDraggableLocator

public Function<Spatial,Spatial> getDraggableLocator()

isDragging

public boolean isDragging()

getDragStartLocation

protected Vector2f getDragStartLocation()

findDraggable

protected Spatial findDraggable(Spatial capture)

Finds the draggable spatial for the specified capture spatial. By default this just returns the capture because the parentLocator function is the identity function. This can be overridden by specifying a different function or overriding this method.

startDrag

protected void startDrag(CursorButtonEvent event,
 Spatial target,
 Spatial capture)

endDrag

protected void endDrag(CursorButtonEvent event,
 Spatial target,
 Spatial capture)

cursorButtonEvent

public void cursorButtonEvent(CursorButtonEvent event,
 Spatial target,
 Spatial capture)

Specified by:

cursorButtonEvent in interface CursorListener

Overrides:

cursorButtonEvent in class DefaultCursorListener

cursorMoved

public void cursorMoved(CursorMotionEvent event,
 Spatial target,
 Spatial capture)

Specified by:

cursorMoved in interface CursorListener

Overrides:

cursorMoved in class DefaultCursorListener

setConsumeDrags

public void setConsumeDrags(boolean consumeDrags)

getConsumeDrags

public boolean getConsumeDrags()

setConsumeDrops

public void setConsumeDrops(boolean consumeDrops)

getConsumeDrops

public boolean getConsumeDrops()