devela 0.28.0

A development substrate of coherence.
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

// devela::geom::dir::orientation
//
//! Defines [`Orientation`][1|2|3].
//

#[cfg(doc)]
use crate::{Distance, Position};

#[doc = crate::_tags!(geom dir)]
/// A unitless directional vector in `D`-dimensional space.
#[doc = crate::_doc_meta!{location("geom/dir")}]
///
/// Represents **only the direction of movement**, without an absolute
/// reference point or inherent magnitude. It is **typically normalized**
/// to remove scale dependence.
///
/// - Unlike [`Position`], `Orientation` **does not describe a fixed location**.
/// - Unlike [`Distance`], `Orientation` **does not measure separation**.
///
/// This type does **not enforce normalization**, but it is expected
/// to be normalized in most use cases.
///
/// See also: [`Orientation1`], [`Orientation2`], [`Orientation3`], [`ori!`][crate::ori].
#[must_use]
#[repr(transparent)]
pub struct Orientation<T, const D: usize> {
    /// The directional components in `D`-dimensional space.
    pub dim: [T; D],
}

#[doc = crate::_tags!(geom dir)]
/// A 1-dimensional [`Orientation`].
#[doc = crate::_doc_meta!{location("geom/dir")}]
pub type Orientation1<T> = Orientation<T, 1>;

#[doc = crate::_tags!(geom dir)]
/// A 2-dimensional [`Orientation`].
#[doc = crate::_doc_meta!{location("geom/dir")}]
pub type Orientation2<T> = Orientation<T, 2>;

#[doc = crate::_tags!(geom dir)]
/// A 3-dimensional [`Orientation`].
#[doc = crate::_doc_meta!{location("geom/dir")}]
pub type Orientation3<T> = Orientation<T, 3>;

crate::_geom_dim_impl_common![common_methods: Orientation];
crate::_geom_dim_impl_common![common_traits: Orientation];