Struct Vec3

pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

Three-dimensional single-precision vector used by the XR geometry helpers.

Coordinates use the caller’s space and units; runtime modules conventionally use metres for world-space vectors.

Examples

use ailloli_ui_openxr::math::Vec3;

let vector = Vec3::new(1.0, 2.0, 3.0);
assert_eq!((vector.x, vector.y, vector.z), (1.0, 2.0, 3.0));

Fields

x: f32

X component.

y: f32

Y component.

z: f32

Z component.

Implementations

impl Vec3

pub const fn new(x: f32, y: f32, z: f32) -> Self

Creates a vector from its three components.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(4.0, 5.0, 6.0).z, 6.0);

pub fn dot(self, rhs: Self) -> f32

Returns the scalar dot product.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(1.0, 2.0, 3.0).dot(Vec3::new(4.0, 5.0, 6.0)), 32.0);

pub fn cross(self, rhs: Self) -> Self

Returns the right-handed cross product.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(1.0, 0.0, 0.0).cross(Vec3::new(0.0, 1.0, 0.0)), Vec3::new(0.0, 0.0, 1.0));

pub fn len_sq(self) -> f32

Returns the squared Euclidean length without a square root.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(2.0, 3.0, 6.0).len_sq(), 49.0);

pub fn len(self) -> f32

Returns the Euclidean length.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(3.0, 4.0, 0.0).len(), 5.0);

pub fn normalize_or(self, fallback: Self) -> Self

Normalizes the vector, returning fallback only for exact zero length.

Examples

use ailloli_ui_openxr::math::Vec3;
let fallback = Vec3::new(0.0, 0.0, -1.0);
assert_eq!(Vec3::default().normalize_or(fallback), fallback);

pub fn normalize(self) -> Option<Self>

Returns a unit vector, or None when the length is at most 1e-6.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::default().normalize(), None);
assert_eq!(Vec3::new(0.0, 3.0, 0.0).normalize(), Some(Vec3::new(0.0, 1.0, 0.0)));

pub fn scale(self, s: f32) -> Self

Multiplies every component by s.

Examples

use ailloli_ui_openxr::math::Vec3;
assert_eq!(Vec3::new(1.0, -2.0, 3.0).scale(2.0), Vec3::new(2.0, -4.0, 6.0));

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Vec3

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Vec3

Returns the “default value” for a type.

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl Mul<Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3) -> Vec3

Performs the * operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl PartialEq for Vec3

fn eq(&self, other: &Vec3) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Copy for Vec3

impl StructuralPartialEq for Vec3