Struct thyme::AnimState

pub struct AnimState { /* private fields */ }

An AnimState consists of one or more (currently up to four) state keys, with each key representing a different state.

For example, a state could be Active + Pressed or Hover. AnimStates are parsed from the theme file as strings in this format, i.e. Active + Pressed, Normal, Hover, are all valid. The + character is used to concatenate multiple states, and whitespace is ignored. The Normal key is special and can only be present by itself. AnimStates are used in Animated images in order to pick a particular image from a set.

Implementations

impl AnimState

pub const fn with_two(state1: AnimStateKey, state2: AnimStateKey) -> AnimState

Creates an AnimState with the two specified state keys.

pub const fn with_three( state1: AnimStateKey, state2: AnimStateKey, state3: AnimStateKey ) -> AnimState

Creates an AnimState with the three specified state keys.

pub const fn with_four( state1: AnimStateKey, state2: AnimStateKey, state3: AnimStateKey, state4: AnimStateKey ) -> AnimState

Creates an AnimState with the four specified state keys.

pub const fn new(state: AnimStateKey) -> AnimState

Creates an AnimState consisting of the single specified state.

pub const fn normal() -> AnimState

Creates an AnimState corresponding to the Normal state with no changes

pub const fn pressed() -> AnimState

Creates an AnimState consisting of only the Pressed state.

pub fn hover() -> AnimState

Creates an AnimState consisting of the Hover state.

pub const fn disabled() -> AnimState

Creates an AnimState consisting of only the Distabled state.

pub fn contains(&self, key: AnimStateKey) -> bool

Returns whether or not this AnimState contains the specified key.

pub fn add(&mut self, to_add: AnimStateKey)

Adds the given state key to this AnimState. Note that adding Normal will have no effect.

pub fn remove(&mut self, to_remove: AnimStateKey)

Removes the given state key from this AnimState, if it is present. Otherwise does nothing. Removing Normal will have no effect

pub fn set(&mut self, key: AnimStateKey, value: bool)

Sets the specified key as either present in this AnimState, or not, depending on value.

Trait Implementations

impl Clone for AnimState

fn clone(&self) -> AnimState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnimState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnimState

fn deserialize<D: Deserializer<'de>>( deserializer: D ) -> Result<AnimState, D::Error>

Deserialize this value from the given Serde deserializer.

impl Hash for AnimState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<AnimState> for AnimState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AnimState

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for AnimState

impl Eq for AnimState

impl StructuralEq for AnimState

impl StructuralPartialEq for AnimState