nightshade-api 0.51.0

Procedural high level API for the nightshade game engine
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

//! Move, rotate, and scale entities without touching quaternions or dirty
//! flags.

use nightshade::prelude::nalgebra_glm::Mat4;
use nightshade::prelude::*;

/// Sets the entity's position in its parent's space (world space when it has
/// no parent).
#[inline]
pub fn set_position(world: &mut World, entity: Entity, position: Vec3) {
    if let Some(transform) =
        world.get_mut::<nightshade::ecs::transform::components::LocalTransform>(entity)
    {
        transform.translation = position;
    }
}

/// Sets the entity's scale.
#[inline]
pub fn set_scale(world: &mut World, entity: Entity, scale: Vec3) {
    if let Some(transform) =
        world.get_mut::<nightshade::ecs::transform::components::LocalTransform>(entity)
    {
        transform.scale = scale;
    }
}

/// Replaces the entity's rotation with `radians` around `axis`.
#[inline]
pub fn set_rotation(world: &mut World, entity: Entity, axis: Vec3, radians: f32) {
    if let Some(transform) =
        world.get_mut::<nightshade::ecs::transform::components::LocalTransform>(entity)
    {
        transform.rotation = nalgebra_glm::quat_angle_axis(radians, &axis.normalize());
    }
}

/// Rotates the entity by `radians` around `axis` on top of its current
/// rotation. Call every frame with a delta for a steady spin.
#[inline]
pub fn rotate(world: &mut World, entity: Entity, axis: Vec3, radians: f32) {
    if let Some(transform) =
        world.get_mut::<nightshade::ecs::transform::components::LocalTransform>(entity)
    {
        transform.rotation =
            nalgebra_glm::quat_angle_axis(radians, &axis.normalize()) * transform.rotation;
    }
}

/// The entity's position in world space, correct even before the engine's
/// transform propagation has run for the frame.
pub fn position(world: &World, entity: Entity) -> Vec3 {
    if world
        .get::<freecs::dynamic::ChildOf>(entity)
        .map(|child_of| child_of.0)
        .is_none()
    {
        return world
            .get::<nightshade::ecs::transform::components::LocalTransform>(entity)
            .map(|transform| transform.translation)
            .unwrap_or_else(Vec3::zeros);
    }
    let matrix = world_matrix(world, entity);
    nalgebra_glm::vec3(matrix[(0, 3)], matrix[(1, 3)], matrix[(2, 3)])
}

pub(crate) fn local_matrix(transform: &LocalTransform) -> Mat4 {
    nalgebra_glm::translation(&transform.translation)
        * nalgebra_glm::quat_to_mat4(&transform.rotation)
        * nalgebra_glm::scaling(&transform.scale)
}

pub(crate) fn world_matrix(world: &World, entity: Entity) -> Mat4 {
    let matrix = world
        .get::<nightshade::ecs::transform::components::LocalTransform>(entity)
        .map(local_matrix)
        .unwrap_or_else(Mat4::identity);
    match world
        .get::<freecs::dynamic::ChildOf>(entity)
        .map(|child_of| child_of.0)
    {
        Some(parent_entity) => world_matrix(world, parent_entity) * matrix,
        None => matrix,
    }
}