flo_animation 0.1.0

Describes a FlowBetween animation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

mod vector;

pub use self::vector::*;

use super::edit::*;
use super::frame::*;
use super::editable::*;

use std::u32;
use std::sync::*;
use std::ops::Range;
use std::time::Duration;

///
/// A layer represents a renderable plane in an animation
///
pub trait Layer : 
    Send {
    ///
    /// The ID associated with this layer
    /// 
    fn id(&self) -> u64;

    ///
    /// The types of edit that are supported by this layer
    /// 
    fn supported_edit_types(&self) -> Vec<LayerEditType>;

    ///
    /// Retrieves a frame from this layer with the specified parameters
    ///
    fn get_frame_at_time(&self, time_index: Duration) -> Arc<Frame>;

    ///
    /// Retrieves the times where key frames exist
    ///
    fn get_key_frames(&self) -> Box<Iterator<Item=Duration>> { self.get_key_frames_during_time(Duration::from_millis(0)..Duration::from_secs(u32::MAX as u64)) }

    ///
    /// Retrieves the times where key frames exist during a specified time range
    /// 
    fn get_key_frames_during_time(&self, when: Range<Duration>) -> Box<Iterator<Item=Duration>>;

    ///
    /// Adds a new key frame at the specified time
    /// 
    fn add_key_frame(&mut self, when: Duration);

    ///
    /// Removes a key frame from the specified time
    /// 
    fn remove_key_frame(&mut self, when: Duration);

    ///
    /// Retrieves the definition of this layer as a vector layer
    /// 
    fn as_vector_layer<'a>(&'a self) -> Option<Reader<'a, VectorLayer>>;

    ///
    /// Retrieves an editor for the vector layer
    /// 
    fn edit_vectors<'a>(&'a mut self) -> Option<Editor<'a, VectorLayer>>;
}