dmsdk 0.2.0

Rust-friendly wrappers around the Defold dmSDK
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

//! Functions for manipulating game objects.

use crate::{dmvmath, ffi::dmGameObject};

/// Game object register.
pub type Register = dmGameObject::HRegister;
/// Game object instance.
pub type Instance = dmGameObject::HInstance;

const UNNAMED_IDENTIFIER: u64 = 12415623704795185700;

#[allow(missing_docs)]
pub enum Error {
    OutOfResources,
    AlreadyRegistered,
    IdentifierInUse,
    IdentifierAlreadySet,
    ComponentNotFound,
    MaximumHierarchicalDepth,
    InvalidOperation,
    ResourceTypeNotFound,
    BufferOverflow,
    Unknown,
}

impl From<i32> for Error {
    fn from(x: i32) -> Self {
        match x {
            -1 => Self::OutOfResources,
            -2 => Self::AlreadyRegistered,
            -3 => Self::IdentifierInUse,
            -4 => Self::IdentifierAlreadySet,
            -5 => Self::ComponentNotFound,
            -6 => Self::MaximumHierarchicalDepth,
            -7 => Self::InvalidOperation,
            -8 => Self::ResourceTypeNotFound,
            -9 => Self::BufferOverflow,
            _ => Self::Unknown,
        }
    }
}

/// [`Result`](core::result::Result) alias with an error type of [`Error`].
pub type Result<T> = core::result::Result<T, Error>;

/// Returns the ID of a game object if it has one.
///
/// # Safety
///
/// This function is safe as long as `instance` points to a valid game object.
pub unsafe fn get_identifier(instance: Instance) -> Option<u64> {
    let hash = dmGameObject::GetIdentifier(instance);
    if hash == UNNAMED_IDENTIFIER {
        None
    } else {
        Some(hash)
    }
}

/// Returns the position of a game object.
///
/// # Safety
///
/// This function is safe as long as `instance` points to a valid game object.
pub unsafe fn get_position(instance: Instance) -> dmvmath::Point3 {
    dmGameObject::GetPosition(instance).into()
}

/// Returns the rotation of a game object.
///
/// # Safety
///
/// This function is safe as long as `instance` points to a valid game object.
pub unsafe fn get_rotation(instance: Instance) -> dmvmath::Quat {
    dmGameObject::GetRotation(instance).into()
}

/// Returns the scale of a game object.
///
/// # Safety
///
/// This function is safe as long as `instance` points to a valid game object.
pub unsafe fn get_scale(instance: Instance) -> dmvmath::Vector3 {
    dmGameObject::GetScale(instance).into()
}

/// Sets the position of a game object.
///
/// # Safety
///
/// This function is safe as long as `instance` points to a valid game object.
pub unsafe fn set_position(instance: Instance, position: dmvmath::Point3) {
    dmGameObject::SetPosition(instance, position.into())
}