Struct bevy_math::Vec3AMask

#[repr(C)]pub struct Vec3AMask(_);

A 3-dimensional vector mask.

This type is typically created by comparison methods on Vec3A. It is essentially a vector of three boolean values.

Implementations

impl Vec3AMask

pub fn new(x: bool, y: bool, z: bool) -> Vec3AMask

Creates a new Vec3AMask.

pub fn bitmask(&self) -> u32

Returns a bitmask with the lowest three bits set from the elements of the Vec3AMask.

A true element results in a 1 bit and a false element in a 0 bit. Element x goes into the first lowest bit, element y into the second, etc.

pub fn any(&self) -> bool

Returns true if any of the elements are true, false otherwise.

In other words: x || y || z.

pub fn all(&self) -> bool

Returns true if all the elements are true, false otherwise.

In other words: x && y && z.

pub fn select(self, if_true: Vec3A, if_false: Vec3A) -> Vec3A

Creates a new Vec3A from the elements in if_true and if_false, selecting which to use for each element based on the Vec3AMask.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

Trait Implementations

impl AsRef<[u32; 3]> for Vec3AMask

fn as_ref(&self) -> &[u32; 3]

Performs the conversion.

impl BitAnd<Vec3AMask> for Vec3AMask

type Output = Vec3AMask

The resulting type after applying the & operator.

fn bitand(self, other: Vec3AMask) -> Vec3AMask

Performs the & operation.

impl BitAndAssign<Vec3AMask> for Vec3AMask

fn bitand_assign(&mut self, other: Vec3AMask)

Performs the &= operation.

impl BitOr<Vec3AMask> for Vec3AMask

type Output = Vec3AMask

The resulting type after applying the | operator.

fn bitor(self, other: Vec3AMask) -> Vec3AMask

Performs the | operation.

impl BitOrAssign<Vec3AMask> for Vec3AMask

fn bitor_assign(&mut self, other: Vec3AMask)

Performs the |= operation.

impl Clone for Vec3AMask

fn clone(&self) -> Vec3AMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3AMask

impl Debug for Vec3AMask

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

Formats the value using the given formatter.

impl Default for Vec3AMask

fn default() -> Vec3AMask

Returns the "default value" for a type.

impl Display for Vec3AMask

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

Formats the value using the given formatter.

impl Eq for Vec3AMask

impl Hash for Vec3AMask

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Not for Vec3AMask

type Output = Vec3AMask

The resulting type after applying the ! operator.

fn not(self) -> Vec3AMask

Performs the unary ! operation.

impl Ord for Vec3AMask

fn cmp(&self, other: &Vec3AMask) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Vec3AMask> for Vec3AMask

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Vec3AMask> for Vec3AMask

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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