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

// devela::geom::metric::position
//
//! Defines [`Position`][1|2|3].
//!
//! > A geometrical position.
//

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

#[doc = crate::_tags!(geom)]
/// A location in `D`-dimensional space.
#[doc = crate::_doc_meta!{location("geom/metric")}]
///
/// Represents an absolute position in a coordinate system.
///
/// - Unlike [`Distance`], `Position` is **not relative**, it describes
///   a fixed location rather than a displacement.
/// - Unlike [`Orientation`], `Position` is a **location**, not a direction.
///
/// See also: [`Position1`], [`Position2`], [`Position3`], [`pos!`][crate::pos].
#[must_use]
#[repr(transparent)]
pub struct Position<T, const D: usize> {
    /// The coordinate values in `D`-dimensional space.
    pub dim: [T; D],
}

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

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

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

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