Skip to main content

KeyPath

Enum KeyPath 

Source
pub enum KeyPath {
Show 17 variants TransformScale, TransformScaleX, TransformScaleY, TransformRotation, Opacity, Position, PositionX, PositionY, BackgroundColor, CornerRadius, BorderWidth, BorderColor, ShadowOpacity, ShadowRadius, ShadowOffset, Bounds, Custom(&'static str),
}
Expand description

Property key path for animation targets.

Each variant maps to a Core Animation key path string that identifies which property of a CALayer to animate.

§Examples

// Animate scale
let anim = CABasicAnimationBuilder::new(KeyPath::TransformScale)
    .values(0.5, 1.0)
    .build();

// Animate position
let anim = CABasicAnimationBuilder::new(KeyPath::PositionX)
    .values(0.0, 100.0)
    .build();

Variants§

§

TransformScale

Uniform scale transform (transform.scale). Value range: 0.0 = invisible, 1.0 = normal size.

§

TransformScaleX

Horizontal scale transform (transform.scale.x).

§

TransformScaleY

Vertical scale transform (transform.scale.y).

§

TransformRotation

Z-axis rotation transform (transform.rotation.z). Value is in radians.

§

Opacity

Layer opacity (opacity). Value range: 0.0 = transparent, 1.0 = opaque.

§

Position

Layer center position (position). Value type: CGPoint.

§

PositionX

Horizontal position (position.x).

§

PositionY

Vertical position (position.y).

§

BackgroundColor

Layer background color (backgroundColor). Value type: CGColor.

§

CornerRadius

Corner radius (cornerRadius).

§

BorderWidth

Border width (borderWidth).

§

BorderColor

Border color (borderColor). Value type: CGColor.

§

ShadowOpacity

Shadow opacity (shadowOpacity).

§

ShadowRadius

Shadow radius (shadowRadius).

§

ShadowOffset

Shadow offset (shadowOffset). Value type: CGSize.

§

Bounds

Bounds rectangle (bounds). Value type: CGRect.

§

Custom(&'static str)

Custom key path string.

Implementations§

Source§

impl KeyPath

Source

pub const fn as_str(&self) -> &'static str

Returns the Core Animation key path string for this property.

§Examples
assert_eq!(KeyPath::TransformScale.as_str(), "transform.scale");
assert_eq!(KeyPath::Opacity.as_str(), "opacity");

Trait Implementations§

Source§

impl Clone for KeyPath

Source§

fn clone(&self) -> KeyPath

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for KeyPath

Source§

impl Debug for KeyPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for KeyPath

Source§

impl Hash for KeyPath

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for KeyPath

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for KeyPath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.