Struct RippleState 

pub struct RippleState { /* private fields */ }

RippleState

Manage ripple animations and hover state for interactive UI components. Use with remember to create persistent state across frames.

Implementations

impl RippleState

pub const ANIMATION_DURATION: Duration

The default duration of the ripple animation.

pub fn new() -> Self

Creates a new RippleState with default values.

Example

use tessera_components::ripple_state::RippleState;
let state = RippleState::new();

pub fn start_animation(&mut self, click_pos: [f32; 2])

Starts a new ripple animation from the given click position.

Arguments

• click_pos - The normalized [x, y] position in 0.0..=1.0 where the ripple originates.

Example

use tessera_components::ripple_state::RippleState;
let session = tessera_ui::RuntimeSession::new();
let _scope = session.enter();
let mut state = RippleState::new();
state.start_animation([0.5, 0.5]);

pub fn start_animation_with_spec( &mut self, click_pos: [f32; 2], size: PxSize, spec: RippleSpec, )

Starts a ripple animation using the provided size and spec.

pub fn release(&mut self)

Marks the ripple as no longer pressed.

pub fn set_pressed(&mut self, pressed: bool)

Sets whether the component is pressed.

pub fn animation(&mut self) -> Option<RippleAnimation>

Returns the current ripple animation snapshot.

pub fn animation_snapshot(&self) -> Option<RippleAnimation>

Returns a read-only snapshot of the current ripple animation.

pub fn animation_snapshot_at(&self, now: Instant) -> Option<RippleAnimation>

Returns a read-only animation snapshot at now.

pub fn animation_at(&mut self, now: Instant) -> Option<RippleAnimation>

Returns the current ripple animation snapshot at now.

pub fn animation_snapshot_at_frame_nanos( &self, frame_nanos: u64, ) -> Option<RippleAnimation>

Returns a read-only animation snapshot at frame_nanos.

pub fn animation_at_frame_nanos( &mut self, frame_nanos: u64, ) -> Option<RippleAnimation>

Returns the current ripple animation snapshot at frame_nanos.

pub fn get_animation_progress(&mut self) -> Option<(f32, [f32; 2])>

Returns the current progress of the ripple animation and the origin position.

Returns Some((progress, [x, y])) if the animation is active, where:

• progress is a value in [0.0, 1.0) representing the animation progress.
• [x, y] is the normalized origin of the ripple in 0.0..=1.0.

Returns None if the animation is not active or has completed.

Example

use tessera_components::ripple_state::RippleState;
let session = tessera_ui::RuntimeSession::new();
let _scope = session.enter();
let mut state = RippleState::new();
state.start_animation([0.5, 0.5]);
let (progress, center) = state.get_animation_progress().expect("active ripple");
assert_eq!(progress, 0.0);
assert_eq!(center, [0.5, 0.5]);

pub fn set_hovered(&mut self, hovered: bool)

Sets whether the component is hovered.

pub fn is_hovered(&self) -> bool

Returns whether the component is hovered.

pub fn set_focused(&mut self, focused: bool)

Sets whether the component is focused.

pub fn is_focused(&self) -> bool

Returns whether the component is focused.

pub fn set_dragged(&mut self, dragged: bool)

Sets whether the component is dragged.

pub fn is_dragged(&self) -> bool

Returns whether the component is dragged.

pub fn is_pressed(&self) -> bool

Returns whether the component is pressed.

pub fn state_layer_alpha(&self) -> f32

Returns the state-layer alpha derived from the current interactions.

Trait Implementations

impl Default for RippleState

fn default() -> Self

Creates a new RippleState with all fields initialized to their default values.