Skip to main content

TextSelector

Enum TextSelector 

Source
pub enum TextSelector {
    Range {
        based_on: TextUnit,
        units: RangeUnits,
        start: Animated<f32>,
        end: Animated<f32>,
        offset: Animated<f32>,
        shape: RangeShape,
        amount: Animated<f32>,
    },
    Timing {
        state: RunState,
        ramp: MediaTime,
        sweep: bool,
    },
    Class {
        class: String,
    },
}
Expand description

How an animator selects characters.

Variants§

§

Range

A range over the text’s units, shaped at its ends, like After Effects’ range selector.

Fields

§based_on: TextUnit

What the range counts: characters (the default), non-space characters, words, or lines.

§units: RangeUnits

Whether start, end and offset are percents of the units (the default) or unit indices.

§start: Animated<f32>

Where the range starts: [-100, 200] percent, or [-N, 2N] units for N of MAX_RANGE_INDEX. Default 0.

§end: Animated<f32>

Where it ends, in the same range. Default 100.

§offset: Animated<f32>

Added to start and end, in the same range. Default 0.

§shape: RangeShape

How selection rises and falls across the range.

§amount: Animated<f32>

The selection’s scale, in [0, 1]. Default 1.

§

Timing

Characters of timed runs, by the run’s time against the current time.

Fields

§state: RunState

Which runs it selects: those not yet said, being said, or said.

§ramp: MediaTime

How long the state takes to fade in and out; zero switches.

§sweep: bool

Splits each run’s span over its characters in order, sweeping the run character by character.

§

Class

Characters of runs that carry a class.

Fields

§class: String

The class name.

Trait Implementations§

Source§

impl Clone for TextSelector

Source§

fn clone(&self) -> Self

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 Debug for TextSelector

Source§

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

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

impl<'de> Deserialize<'de> for TextSelector

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TextSelector

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TextSelector

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TextSelector

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.