Struct AnimationOptions 

pub struct AnimationOptions {
    pub snap_to_grid: bool,
    pub tick_hz: Option<u32>,
    pub position_tolerance_px: Option<i32>,
    pub before_flags: Option<FolderFlagOp>,
    pub after_flags: Option<FolderFlagOp>,
    pub force_fallback: bool,
    pub render_options: OverlayRenderOptions,
}

Global options that apply to every icon in an animation batch.

Fields

snap_to_grid: bool

Align destinations to available grid cells before preparation. Protects stationary icons and resolves target conflicts; never changes Shell flags. Defaults to false. Failures occur before artwork, flags or position writes.

tick_hz: Option<u32>

Tick rate in Hz. Defaults to 100 (matching the legacy 10 ms step).

position_tolerance_px: Option<i32>

Distance threshold in pixels below which an icon is considered “at target” and dropped from the active set. Defaults to 10 (matching the legacy POSITION_ERROR_VALUE).

before_flags: Option<FolderFlagOp>

Optional folder-flag operation applied before the animation starts.

after_flags: Option<FolderFlagOp>

Optional folder-flag operation applied after the animation ends (regardless of success or user-triggered stop).

force_fallback: bool

Force the engine to skip the overlay entirely and take the “loud warning + direct teleport” fallback path.

Lets tests and the animate_direct demo binary exercise the fallback without needing a real overlay failure. Defaults to false — normal callers get the overlay animation.

render_options: OverlayRenderOptions

Feature toggles for the overlay renderer’s decoration passes (label text, shortcut-arrow overlay, admin shield overlay). Defaults to OverlayRenderOptions::all_enabled — every decoration Explorer draws is drawn on the overlay too.

Trait Implementations

impl Clone for AnimationOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for AnimationOptions

impl Debug for AnimationOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AnimationOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AnimationOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AnimationOptions