OverlayController class

Inheritance

Constructors

OverlayController()

Properties

activeItem → InteractiveOverlayImage?
no setterinherited
activeKey → Key?
no setterinherited
activeKeys → Set<Key>
Interaction state sets.
finalinherited
activeKeysView → Set<Key>
no setterinherited
canRedo → bool
Whether redo is available.
no setterinherited
canUndo → bool
Whether undo is available.
no setterinherited
current → List<InteractiveOverlayImage>
no setterinherited
events → Stream<InteractiveEvent<InteractiveOverlayImage>>
Stream of all interactive events.
no setterinherited
hasActive → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasHovered → bool
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
hasUnsavedChanges → bool
no setterinherited
history → HistoryManager<InteractiveOverlayImage>
Must be implemented by the using class to provide access to the history manager.
no setterinherited
hoveredKey → Key?
no setterinherited
hoveredKeys → Set<Key>
finalinherited
hoveredKeysView → Set<Key>
no setterinherited
internalCurrent → List<InteractiveOverlayImage>
no setterinherited
internalInitial → List<InteractiveOverlayImage>
no setterinherited
internalSaved → List<InteractiveOverlayImage>
no setterinherited
isEditing → bool
no setterinherited
logic ↔ EntityLogic<InteractiveOverlayImage>
Must be implemented to provide type-specific logic.
latefinalinherited
longPressedItem → InteractiveOverlayImage?
no setterinherited
longPressedKeys → Set<Key>
finalinherited
longPressedKeysView → Set<Key>
no setterinherited
onActiveCallback → ValueChanged<InteractiveOverlayImage>?
no setterinherited
onAddedCallback → ValueChanged<InteractiveOverlayImage>?
Callbacks for CRUD operations (optional).
no setterinherited
onHoverCallback → ValueChanged<InteractiveOverlayImage>?
no setterinherited
onLongPressCallback → ValueChanged<InteractiveOverlayImage>?
no setterinherited
onRemovedCallback → ValueChanged<InteractiveOverlayImage>?
no setterinherited
onTapCallback → ValueChanged<InteractiveOverlayImage>?
Callbacks for interactions (optional).
no setterinherited
onUpdatedCallback → ValueChanged<InteractiveOverlayImage>?
no setterinherited
options → InteractiveOptions<InteractiveOverlayImage>
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spatialIndex → SpatialIndex<InteractiveOverlayImage>
Spatial index for fast range queries.
finalinherited
transientKeys → Set<Key>
finalinherited
transientState → ValueListenable<TransientState<InteractiveOverlayImage>?>
Exposes transient state as a listenable.
no setterinherited
transientStateNotifier → ValueNotifier<TransientState<InteractiveOverlayImage>?>
Transient state for drag operations.
finalinherited
version → int
no setterinherited

Methods

abort() → void
Abort all changes and reverts to the initial state.
inherited
add(InteractiveOverlayImage item, {bool notify = true}) → void
Adds an item to the collection.
inherited
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
calculateDelta({required List<InteractiveOverlayImage> oldState, required List<InteractiveOverlayImage> newState, required Object keySelector(InteractiveOverlayImage), required bool hasSpatialChange(InteractiveOverlayImage, InteractiveOverlayImage)}) → EntityDelta<InteractiveOverlayImage>
Gets the delta between old and new states.
inherited
clearHover([InteractiveOverlayImage? item]) → void
inherited
clearLongPress([InteractiveOverlayImage? item]) → void
inherited
deselect([InteractiveOverlayImage? item]) → void
inherited
discard() → void
Discards all changes and reverts to the saved state.
inherited
dispose() → void
Discards any resources used by the object.
inherited
disposeDrag() → void
inherited
emitEvent(dynamic itemOrEvent) → void
Emits an event based on the provided item or context. This is called by mixins to emit type-safe events.
inherited
endDrag() → void
Ends the drag operation and commits the change.
inherited
ensureIndexFresh() → void
Ensures spatial index is up-to-date before querying. Call this before any spatial operations.
inherited
exitEditMode() → void
inherited
findByKey(Key key) → InteractiveOverlayImage?
Finds an item by key.
inherited
hover(InteractiveOverlayImage item) → void
inherited
isActive(InteractiveOverlayImage item) → bool
inherited
isActiveKey(Key? key) → bool
inherited
isHovered(InteractiveOverlayImage item) → bool
inherited
isHoveredKey(Key? key) → bool
inherited
isLongPressed(InteractiveOverlayImage item) → bool
inherited
isLongPressedKey(Key? key) → bool
inherited
isTransient(InteractiveOverlayImage item) → bool
Checks if an item is in transient state.
inherited
isTransientKey(Key? key) → bool
Checks if a key is in transient state.
inherited
longPress(InteractiveOverlayImage item) → void
inherited
move(Key key, LatLng to, {bool merge = false}) → void
moveCorner(Key key, QuadCorner corner, LatLng to, {bool merge = false}) → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Must be implemented to notify listeners.
inherited
perform(Op<InteractiveOverlayImage> op, {bool merge = false, bool notify = true}) → void
inherited
performOp(Op<InteractiveOverlayImage> op, {bool merge = false}) → void
Must be implemented to perform operations.
inherited
redo() → void
Redo the previously undone operation.
inherited
refreshInteractionReferences(Set<Key> currentKeys) → void
inherited
remove(Key key, {VoidCallback? onBeforeRemove}) → void
Removes an item by key.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
rotate(Key key, double angleRad, {bool merge = true}) → void
save({bool erase = false}) → void
Saves the current state.
inherited
scheduleAutoSave() → void
inherited
select(InteractiveOverlayImage item) → void
inherited
setCallbacks({ValueChanged<InteractiveOverlayImage>? onAdded, ValueChanged<InteractiveOverlayImage>? onRemoved, ValueChanged<InteractiveOverlayImage>? onUpdated, ValueChanged<EntityDelta<InteractiveOverlayImage>>? onSaved, ValueChanged<InteractiveOverlayImage>? onTap, ValueChanged<InteractiveOverlayImage>? onActive, ValueChanged<InteractiveOverlayImage>? onHover, ValueChanged<InteractiveOverlayImage>? onLongPress}) → void
inherited
setEditMode(bool enable) → void
inherited
setEditModeCallback(ValueChanged<bool>? callback) → void
inherited
setItems(List<InteractiveOverlayImage> items, {required bool resetHistory}) → void
Sets the entire collection.
inherited
setOptions(InteractiveOptions<InteractiveOverlayImage> options) → void
Updates the controller configuration options.
override
setOverlays(List<InteractiveOverlayImage> overlays, {required bool resetHistory}) → void
startDrag(InteractiveOverlayImage item, LatLng origin) → void
Starts a drag operation.
inherited
startEditMode() → void
inherited
tap(InteractiveOverlayImage item) → void
inherited
toggleEditMode() → void
inherited
toggleSelect(InteractiveOverlayImage item) → void
inherited
toString() → String
A string representation of this object.
inherited
undo() → void
Undo the last operation.
inherited
update(Key key, InteractiveOverlayImage newItem, {bool merge = false}) → void
Updates an item.
inherited
updateDrag(LatLng current) → void
Updates the current drag position.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

maybeOf(BuildContext context) → OverlayController?
of(BuildContext context) → OverlayController