gov.nasa.worldwind.drag.Draggable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation

worldwind-pcm

The newest version!

/*
 * Copyright (C) 2016 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.drag;

/**
 * An interface provided by objects that can be dragged. The {@link DragContext} provided in the {@link
 * Draggable#drag(DragContext)} method includes information on the screen coordinates and the state of the
 * {@link gov.nasa.worldwind.WorldWindow}.
 */
public interface Draggable
{
    /**
     * Indicates whether the object is enabled for dragging.
     *
     * @return true if the object is enabled, else false.
     */
    boolean isDragEnabled();

    /**
     * Controls whether the object is enabled for dragging.
     *
     * @param enabled true if the object is enabled, else false.
     */
    void setDragEnabled(boolean enabled);

    /**
     * Drag the object given the provided {@link DragContext}.
     *
     * @param dragContext the {@link DragContext} of this dragging event.
     */
    void drag(DragContext dragContext);
}