Struct Vector3 

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

A vector with three single-precision components.

The layout is the one of the reference runtime and is relied on when the value is passed to a graphics API by address (as a vertex attribute, for example): three consecutive singles, x, y, z.

Fields

x: f32

The X component of the vector.

y: f32

The Y component of the vector.

z: f32

The Z component of the vector.

Implementations

impl Vector3

pub const ZERO: Vector3

The vector (0, 0, 0).

pub const ONE: Vector3

The vector (1, 1, 1).

pub const UNIT_X: Vector3

The vector (1, 0, 0).

pub const UNIT_Y: Vector3

The vector (0, 1, 0).

pub const UNIT_Z: Vector3

The vector (0, 0, 1).

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

Creates a vector from its components.

pub const fn from_value(value: f32) -> Self

Creates a vector whose components all have the same value.

pub const fn from_vector2(value: Vector2, z: f32) -> Self

Creates a vector from a Vector2 and a Z component.

pub fn abs(value: Vector3) -> Vector3

Returns a vector whose elements are the absolute values of each of the specified vector’s elements.

pub fn clamp(value1: Vector3, min: Vector3, max: Vector3) -> Vector3

Restricts a vector between a minimum and a maximum value (min(max(value, min), max), so max wins when the bounds are inverted).

pub fn cross(vector1: Vector3, vector2: Vector3) -> Vector3

Computes the cross product of two vectors.

pub fn distance(value1: Vector3, value2: Vector3) -> f32

Computes the Euclidean distance between the two given points.

pub fn distance_squared(value1: Vector3, value2: Vector3) -> f32

Returns the Euclidean distance squared between two specified points.

pub fn dot(vector1: Vector3, vector2: Vector3) -> f32

Returns the dot product of two vectors.

pub fn length(&self) -> f32

Returns the length of the vector.

pub fn length_squared(&self) -> f32

Returns the length of the vector squared.

pub fn lerp(value1: Vector3, value2: Vector3, amount: f32) -> Vector3

Performs a linear interpolation between two vectors based on the given weighting.

pub fn max(value1: Vector3, value2: Vector3) -> Vector3

Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors.

pub fn min(value1: Vector3, value2: Vector3) -> Vector3

Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors.

pub fn normalize(value: Vector3) -> Vector3

Returns a vector with the same direction as the specified vector, but with a length of one (NaN components for a zero-length vector).

pub fn square_root(value: Vector3) -> Vector3

Returns a vector whose elements are the square root of each of a specified vector’s elements.

pub fn transform(position: Vector3, matrix: Matrix4x4) -> Vector3

Transforms a vector by a specified 4x4 matrix.

pub fn transform_quaternion(value: Vector3, rotation: Quaternion) -> Vector3

Transforms a vector by the specified rotation.

pub fn transform_normal(normal: Vector3, matrix: Matrix4x4) -> Vector3

Transforms a vector normal by the given 4x4 matrix.

Trait Implementations

impl Add for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, right: Vector3) -> Vector3

Performs the + operation.

impl AddAssign for Vector3

fn add_assign(&mut self, right: Vector3)

Performs the += operation.

impl BatchValue for Vector3

fn write_to(&self, out: &mut Vec<u8>)

fn read_from(input: &mut BatchValueReader<'_>) -> Self

impl Clone for Vector3

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vector3

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Default for Vector3

fn default() -> Self

Returns the “default value” for a type.

impl Display for Vector3

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

Formats the value using the given formatter.

impl Div for Vector3

type Output = Vector3

The resulting type after applying the / operator.

fn div(self, right: Vector3) -> Vector3

Performs the / operation.

impl Div<f32> for Vector3

type Output = Vector3

The resulting type after applying the / operator.

fn div(self, right: f32) -> Vector3

Performs the / operation.

impl DivAssign for Vector3

fn div_assign(&mut self, right: Vector3)

Performs the /= operation.

impl DivAssign<f32> for Vector3

fn div_assign(&mut self, right: f32)

Performs the /= operation.

impl ExpressionVariantValue for Vector3

const FFI_VARIANT_TYPE: Option<VariantType>

The variant type a foreign function parameter of this type is matched against, or None when the type cannot be a foreign function parameter.

fn try_from_variant(v: &ExpressionVariant) -> Option<Self>

See ExpressionVariant::try_cast.

fn into_variant(self) -> ExpressionVariant

See ExpressionVariant::create.

impl From<Vector3> for Vector3D

The widening conversion to the double-precision vector.

fn from(value: Vector3) -> Vector3D

Converts to this type from the input type.

impl From<Vector3> for ExpressionVariant

fn from(value: Vector3) -> ExpressionVariant

Converts to this type from the input type.

impl From<Vector3D> for Vector3

The narrowing conversion of the double-precision vector.

fn from(value: Vector3D) -> Vector3

Converts to this type from the input type.

impl IInterpolator<Vector3> for Vector3Interpolator

fn interpolate(&self, from: Vector3, to: Vector3, progress: f32) -> Vector3

impl Mul for Vector3

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, right: Vector3) -> Vector3

Performs the * operation.

impl Mul<Vector3> for f32

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, right: Vector3) -> Vector3

Performs the * operation.

impl Mul<f32> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, right: f32) -> Vector3

Performs the * operation.

impl MulAssign for Vector3

fn mul_assign(&mut self, right: Vector3)

Performs the *= operation.

impl MulAssign<f32> for Vector3

fn mul_assign(&mut self, right: f32)

Performs the *= operation.

impl Neg for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn neg(self) -> Vector3

Performs the unary - operation.

impl PartialEq for Vector3

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Vector3

impl Sub for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, right: Vector3) -> Vector3

Performs the - operation.

impl SubAssign for Vector3

fn sub_assign(&mut self, right: Vector3)

Performs the -= operation.