Struct ObjectAnimationUsingKeyFrames 

pub struct ObjectAnimationUsingKeyFrames { /* private fields */ }

Animates an Object (arbitrary BaseComponent) property through discrete key frames. Objects can’t be interpolated, so only discrete frames exist.

Implementations

impl ObjectAnimationUsingKeyFrames

pub fn raw(&self) -> *mut c_void

Raw Noesis::BaseComponent*. Borrowed for the lifetime of self.

impl ObjectAnimationUsingKeyFrames

pub fn new() -> Self

Create an empty key-frame object animation.

Panics

Panics if Noesis fails to allocate.

pub fn add_key_frame<C: AsComponent>( &mut self, key_time_secs: f64, value: &C, ) -> bool

Append a discrete key frame setting value at key_time_secs. The collection takes its own reference to value’s component, so the handle may be dropped afterwards. value is any owning handle in this module (its borrowed BaseComponent* is read).

pub fn key_frame_count(&self) -> Option<u32>

Number of key frames.

pub fn key_frame_value(&self, index: u32) -> Option<OwnedComponent>

Read back the component at key frame index as an owned handle (+1 reference), or None if out of range or the value is null.

pub fn key_frame_time(&self, index: u32) -> Option<f64>

Read back the key time (seconds) at index, or None if out of range.

Trait Implementations

impl Animation for ObjectAnimationUsingKeyFrames

fn animation_raw(&self) -> *mut c_void

Borrowed Noesis::AnimationTimeline* for self.

fn set_target_name(&mut self, name: &str) -> bool

Set this animation’s Storyboard.TargetName: the x:Name of the element it drives, resolved against the namescope passed to Storyboard::begin.

fn set_target_property(&mut self, path: &str) -> bool

Set this animation’s Storyboard.TargetProperty: the property path it drives (e.g. "Opacity", "(UIElement.RenderTransform).(ScaleTransform.ScaleX)").

fn set_easing(&mut self, easing: &EasingFunction) -> bool

Attach an easing function. No-op (returns false) for key-frame animations, whose easing is configured per key frame instead.

fn begin_on( &mut self, target: &FrameworkElement, dp_name: &str, handoff: HandoffBehavior, ) -> bool

Start this animation directly on target’s dp_name dependency property, using the target’s view TimeManager (a BeginAnimation / ApplyAnimationClock equivalent). target must be connected to a live View (so it has a TimeManager). Returns false on an unknown property or a disconnected target.

impl AsComponent for ObjectAnimationUsingKeyFrames

fn component_raw(&self) -> *mut c_void

Borrowed Noesis::BaseComponent* for self.

impl Default for ObjectAnimationUsingKeyFrames

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ObjectAnimationUsingKeyFrames

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for ObjectAnimationUsingKeyFrames

impl Timeline for ObjectAnimationUsingKeyFrames

fn timeline_raw(&self) -> *mut c_void

Borrowed Noesis::Timeline* for self.

fn set_duration_secs(&mut self, seconds: f64) -> bool

Set the single-pass duration in seconds.

fn set_duration_auto(&mut self) -> bool

Set Duration="Automatic" (resolved from the content, e.g. key frames).

fn set_duration_forever(&mut self) -> bool

Set Duration="Forever".

fn duration_secs(&self) -> Option<f64>

Read the configured single-pass duration in seconds, or None if the duration is Automatic / Forever (not a resolved TimeSpan).

fn set_begin_time_secs(&mut self, seconds: f64) -> bool

Delay before the timeline begins, in seconds.

fn set_auto_reverse(&mut self, value: bool) -> bool

Play forwards then backwards each iteration when true.

fn set_speed_ratio(&mut self, value: f32) -> bool

Rate at which time progresses relative to the parent (default 1.0).

fn set_fill_behavior(&mut self, behavior: FillBehavior) -> bool

Behaviour once the active period ends (hold the end value or release it).

fn set_repeat_count(&mut self, count: f32) -> bool

Repeat a fixed number of (possibly fractional) iterations.

fn set_repeat_duration_secs(&mut self, seconds: f64) -> bool

Repeat for a fixed wall-clock duration, in seconds.

fn set_repeat_forever(&mut self) -> bool

Repeat forever.