pub struct RippleState { /* private fields */ }Expand description
§RippleState
Manage ripple animations and hover state for interactive UI components.
Recommended use: create a single RippleState handle and clone it to share.
§Parameters
- This type has no constructor parameters; create it with
RippleState::new().
§Examples
use tessera_ui_basic_components::ripple_state::RippleState;
let s = RippleState::new();
assert!(!s.is_hovered());
s.set_hovered(true);
assert!(s.is_hovered());Implementations§
Source§impl RippleState
impl RippleState
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new RippleState with default values.
§Example
use tessera_ui_basic_components::ripple_state::RippleState;
let state = RippleState::new();Sourcepub fn start_animation(&self, click_pos: [f32; 2])
pub fn start_animation(&self, click_pos: [f32; 2])
Starts a new ripple animation from the given click position.
§Arguments
click_pos- The normalized[x, y]position (typically in the range [0.0, 1.0]) where the ripple originates.
§Example
use tessera_ui_basic_components::ripple_state::RippleState;
let state = RippleState::new();
state.start_animation([0.5, 0.5]);Sourcepub fn get_animation_progress(&self) -> Option<(f32, [f32; 2])>
pub fn get_animation_progress(&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:
progressis a value in[0.0, 1.0)representing the animation progress.[x, y]is the normalized origin of the ripple.
Returns None if the animation is not active or has completed.
§Example
use tessera_ui_basic_components::ripple_state::RippleState;
let state = RippleState::new();
state.start_animation([0.5, 0.5]);
if let Some((progress, center)) = state.get_animation_progress() {
// Use progress and center for rendering
}Sourcepub fn set_hovered(&self, hovered: bool)
pub fn set_hovered(&self, hovered: bool)
Sourcepub fn is_hovered(&self) -> bool
pub fn is_hovered(&self) -> bool
Returns whether the pointer is currently hovering over the component.
§Example
use tessera_ui_basic_components::ripple_state::RippleState;
let state = RippleState::new();
let hovered = state.is_hovered();Trait Implementations§
Source§impl Clone for RippleState
impl Clone for RippleState
Source§fn clone(&self) -> RippleState
fn clone(&self) -> RippleState
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for RippleState
impl RefUnwindSafe for RippleState
impl Send for RippleState
impl Sync for RippleState
impl Unpin for RippleState
impl UnwindSafe for RippleState
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more