Struct NiPoint3

#[repr(C)]
pub struct NiPoint3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

3D vector representation.

Fields

x: f32

y: f32

z: f32

Implementations

impl NiPoint3

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

Creates a new NiPoint3 from x, y, and z coordinates.

Example

let point = NiPoint3::new(1.0, 2.0, 3.0);
assert_eq!(point.x, 1.0);

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

Computes the dot product with another NiPoint3.

Example

let a = NiPoint3::new(1.0, 2.0, 3.0);
let b = NiPoint3::new(4.0, 5.0, 6.0);
assert_eq!(a.dot(&b), 32.0);

pub fn cross(&self, other: &Self) -> Self

Computes the cross product with another NiPoint3.

Example

let a = NiPoint3::new(1.0, 0.0, 0.0);
let b = NiPoint3::new(0.0, 1.0, 0.0);
let cross = a.cross(&b);
assert_eq!(cross, NiPoint3::new(0.0, 0.0, 1.0));

pub fn length(&self) -> f32

Computes the length (magnitude) of the vector.

Example

let v = NiPoint3::new(3.0, 4.0, 0.0);
assert_eq!(v.length(), 5.0);

pub fn sqr_length(&self) -> f32

Returns the squared length of the vector.

pub fn distance(&self, other: &Self) -> f32

Computes the distance to another NiPoint3.

Example

let a = NiPoint3::new(1.0, 2.0, 3.0);
let b = NiPoint3::new(4.0, 6.0, 3.0);
assert_eq!(a.distance(&b), 5.0);

pub fn squared_distance(&self, other: &Self) -> f32

Computes the squared distance to another NiPoint3.

pub fn unitize(&mut self) -> f32

Normalizes the vector in place and returns its original length.

Example

let mut v = NiPoint3::new(3.0, 4.0, 0.0);
let len = v.unitize();
assert_eq!(len, 5.0);
assert_eq!(v, NiPoint3::new(0.6, 0.8, 0.0));

pub fn unit_cross(&self, other: &Self) -> Self

Computes the unit cross product with another NiPoint3.

Example

let a = NiPoint3::new(1.0, 0.0, 0.0);
let b = NiPoint3::new(0.0, 1.0, 0.0);
let unit_cross = a.unit_cross(&b);
assert_eq!(unit_cross, NiPoint3::new(0.0, 0.0, 1.0));

pub const fn zero() -> Self

Returns the zero vector.

Example

let zero = NiPoint3::zero();
assert_eq!(zero, NiPoint3::new(0.0, 0.0, 0.0));

Trait Implementations

impl Add for NiPoint3

type Output = NiPoint3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for NiPoint3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for NiPoint3

fn clone(&self) -> NiPoint3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NiPoint3

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

Formats the value using the given formatter.

impl Default for NiPoint3

fn default() -> NiPoint3

Returns the “default value” for a type.

impl Display for NiPoint3

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

Formats the value using the given formatter.

impl Div<f32> for NiPoint3

type Output = NiPoint3

The resulting type after applying the / operator.

fn div(self, scalar: f32) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for NiPoint3

fn div_assign(&mut self, scalar: f32)

Performs the /= operation.

impl From<NiPoint3> for hkVector4

fn from(point: NiPoint3) -> Self

Converts to this type from the input type.

impl Index<usize> for NiPoint3

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for NiPoint3

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<NiPoint3> for NiMatrix3

type Output = NiPoint3

The resulting type after applying the * operator.

fn mul(self, rhs: NiPoint3) -> Self::Output

Performs the * operation.

impl Mul<NiPoint3> for NiTransform

type Output = NiPoint3

The resulting type after applying the * operator.

fn mul(self, rhs: NiPoint3) -> Self::Output

Performs the * operation.

impl Mul<f32> for NiPoint3

type Output = NiPoint3

The resulting type after applying the * operator.

fn mul(self, scalar: f32) -> Self::Output

Performs the * operation.

impl MulAssign<f32> for NiPoint3

fn mul_assign(&mut self, scalar: f32)

Performs the *= operation.

impl Neg for NiPoint3

type Output = NiPoint3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for NiPoint3

fn eq(&self, other: &NiPoint3) -> 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 PartialOrd for NiPoint3

fn partial_cmp(&self, other: &NiPoint3) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for NiPoint3

type Output = NiPoint3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for NiPoint3

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for NiPoint3

impl StructuralPartialEq for NiPoint3