com.azalient.api.ui.clipboard
Interface IPickable

All Superinterfaces:
IDeletable, IDraggable, ISelectable

public interface IPickable
extends ISelectable

A pickable object is one that can be selected by the user in the main window. All ISelectable objects are also IPickable


Field Summary
static IPickable[] ZERO
          A static zero-length array, created for convenience, and to save memory
 
Method Summary
 IXyz centroid()
          Return a "centre" point for this pickable object
 boolean currentlyUnpickable()
          Returns true if this object is currently invisible, for example a controller for an unsignalised intersection
 boolean inputGesture(InputGesture ig, IPickable pickable, Object data)
          An input gesture - move, increase, decrease.
 String name()
          name for undo description
 boolean pickableNow()
          Is this object pickable right now? This may return false, if for example an image has been fixed.
 void pickOrder(int order)
          [Internal] Set the picking order
 int pickTag()
          Return the unique integer used for picking
 void rename(String s)
          Rename this pickable object
 IViewable viewableTransparent()
          Return a viewable used to determine if this object is currently transparetn, for depth-order sorting
 
Methods inherited from interface com.azalient.api.ui.clipboard.ISelectable
associates, destroy, inside, selected
 
Methods inherited from interface com.azalient.api.ui.clipboard.IDraggable
selected, selectedForDraggingDraw
 
Methods inherited from interface com.azalient.api.ui.clipboard.IDeletable
delete, deleted
 

Field Detail

ZERO

static final IPickable[] ZERO
A static zero-length array, created for convenience, and to save memory

Method Detail

name

String name()
name for undo description

Specified by:
name in interface IDeletable

rename

void rename(String s)
Rename this pickable object


pickTag

int pickTag()
Return the unique integer used for picking


inputGesture

boolean inputGesture(InputGesture ig,
                     IPickable pickable,
                     Object data)
An input gesture - move, increase, decrease. The 'data' is gesture-specific, for example Xyz for move

Returns:
true if gesture was successful (used for undo stack?)

pickableNow

boolean pickableNow()
Is this object pickable right now? This may return false, if for example an image has been fixed.


pickOrder

void pickOrder(int order)
[Internal] Set the picking order

Internal - Not recommended for use. Public as a side-effect of implementation method

currentlyUnpickable

boolean currentlyUnpickable()
Returns true if this object is currently invisible, for example a controller for an unsignalised intersection


centroid

IXyz centroid()
Return a "centre" point for this pickable object


viewableTransparent

IViewable viewableTransparent()
Return a viewable used to determine if this object is currently transparetn, for depth-order sorting