vera 0.3.0

Vulkan Engine in Rust for 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use crate::{
    Evolution, Tf, Cl, Transformation, Colorization, Vertex,
    D_TRANSFORMATION_SPEED_EVOLUTION, D_TRANSFORMATION_START_TIME, D_TRANSFORMATION_END_TIME,
    D_COLORIZATION_SPEED_EVOLUTION, D_COLORIZATION_START_TIME, D_COLORIZATION_END_TIME,
};

/// A model (a model is a shape).
/// 1 model = 1 entity.  
/// This is what `fn new()` of specific models return.  
/// - `vertices` are the vertices of the model, each group of three `Vertex` forming a triangle.
/// - `t` are the runtime transformations of the model.
pub struct Model {
    pub vertices: Vec<Vertex>,
    pub t: Vec<Tf>,
}

impl Model {
    /// Merges several models into one single entity, with empty transformations.
    pub fn from_merge(models: Vec<Model>) -> Self {
        Self {
            vertices: models
                .into_iter()
                .flat_map(move |model| model.vertices.into_iter())
                .collect(),
            t: vec![],
        }
    }
    /// Creates a single entity from the given vertices, with empty transformations.
    /// The number of vertices should (most likely) be a multiple of 3.
    pub fn from_vertices(vertices: Vec<Vertex>) -> Self {
        Self {
            vertices,
            t: vec![],
        }
    }
    /// Sets the model rgb color values.
    pub fn rgb(mut self, red: f32, green: f32, blue: f32) -> Self {
        self.vertices
            .iter_mut()
            .for_each(|v| v.set_rgb(red, green, blue));
        self
    }
    /// Sets the model opacity
    pub fn alpha(mut self, alpha: f32) -> Self {
        self.vertices.iter_mut().for_each(|v| v.set_alpha(alpha));
        self
    }

    /// Adds a new transformation with default speed evolution, start time and end time.
    /// # Don't
    /// DO NOT call this function in multithreaded scenarios, as it calls static mut. See [the crate root](super).
    pub fn transform(mut self, transformation: Transformation) -> Self {
        self.t.push(Tf {
            t: transformation,
            e: unsafe { D_TRANSFORMATION_SPEED_EVOLUTION },
            start: unsafe { D_TRANSFORMATION_START_TIME },
            end: unsafe { D_TRANSFORMATION_END_TIME },
        });
        self
    }

    /// Adds a new color change with default speed evolution, start time and end time.
    /// # Don't
    /// DO NOT call this function in multithreaded scenarios, as it calls static mut. See [the crate root](super).
    pub fn recolor(mut self, colorization: Colorization) -> Self {
        self.vertices.iter_mut().for_each(|v| { v.c.push(Cl {
            c: colorization,
            e: unsafe { D_COLORIZATION_SPEED_EVOLUTION },
            start: unsafe { D_COLORIZATION_START_TIME },
            end: unsafe { D_COLORIZATION_END_TIME },
        })});
        self
    }

    /// Modifies the speed evolution of the latest colorization added.
    pub fn evolution_c(mut self, e: Evolution) -> Self {
        self.vertices.iter_mut().for_each(|v| { v.c.last_mut().unwrap().e = e; });
        self
    }

    /// Modifies the start time of the latest colorization added.
    /// A start after an end will result in the colorization being instantaneous at start.
    pub fn start_c(mut self, start: f32) -> Self {
        self.vertices.iter_mut().for_each(|v| { v.c.last_mut().unwrap().start = start; });
        self
    }

    /// Modifies the end time of the latest colorization added.
    /// An end before a start will result in the colorization being instantaneous at start.
    pub fn end_c(mut self, end: f32) -> Self {
        self.vertices.iter_mut().for_each(|v| { v.c.last_mut().unwrap().end = end; });
        self
    }

    /// Modifies the speed evolution of the latest transformation added.
    pub fn evolution_t(mut self, e: Evolution) -> Self {
        self.t.last_mut().unwrap().e = e;
        self
    }

    /// Modifies the start time of the latest transformation added.
    /// A start after an end will result in the transformation being instantaneous at start.
    pub fn start_t(mut self, start: f32) -> Self {
        self.t.last_mut().unwrap().start = start;
        self
    }

    /// Modifies the end time of the latest transformation added.
    /// An end before a start will result in the transformation being instantaneous at start.
    pub fn end_t(mut self, end: f32) -> Self {
        self.t.last_mut().unwrap().end = end;
        self
    }
}

/// A triangle model
pub struct Triangle;

impl Triangle {
    pub fn new(v1: Vertex, v2: Vertex, v3: Vertex) -> Model {
        Model::from_vertices(vec![v1, v2, v3])
    }
}