Struct bevy_math::primitives::Direction2d

pub struct Direction2d(/* private fields */);

A normalized vector pointing in a direction in 2D space

Implementations

impl Direction2d

pub const X: Self = _

A unit vector pointing along the positive X axis.

pub const Y: Self = _

A unit vector pointing along the positive Y axis.

pub const NEG_X: Self = _

A unit vector pointing along the negative X axis.

pub const NEG_Y: Self = _

A unit vector pointing along the negative Y axis.

pub fn new(value: Vec2) -> Result<Self, InvalidDirectionError>

Create a direction from a finite, nonzero Vec2.

Returns Err(InvalidDirectionError) if the length of the given vector is zero (or very close to zero), infinite, or NaN.

pub fn new_unchecked(value: Vec2) -> Self

Create a Direction2d from a Vec2 that is already normalized.

Warning

value must be normalized, i.e it’s length must be 1.0.

pub fn new_and_length(value: Vec2) -> Result<(Self, f32), InvalidDirectionError>

Create a direction from a finite, nonzero Vec2, also returning its original length.

Returns Err(InvalidDirectionError) if the length of the given vector is zero (or very close to zero), infinite, or NaN.

pub fn from_xy(x: f32, y: f32) -> Result<Self, InvalidDirectionError>

Create a direction from its x and y components.

Returns Err(InvalidDirectionError) if the length of the vector formed by the components is zero (or very close to zero), infinite, or NaN.

Methods from Deref<Target = Vec2>

pub const ZERO: Vec2 = _

pub const ONE: Vec2 = _

pub const NEG_ONE: Vec2 = _

pub const MIN: Vec2 = _

pub const MAX: Vec2 = _

pub const NAN: Vec2 = _

pub const INFINITY: Vec2 = _

pub const NEG_INFINITY: Vec2 = _

pub const X: Vec2 = _

pub const Y: Vec2 = _

pub const NEG_X: Vec2 = _

pub const NEG_Y: Vec2 = _

pub const AXES: [Vec2; 2] = _

pub fn to_array(&self) -> [f32; 2]

[x, y]

pub fn as_dvec2(&self) -> DVec2

Casts all elements of self to f64.

pub fn as_i16vec2(&self) -> I16Vec2

Casts all elements of self to i16.

pub fn as_u16vec2(&self) -> U16Vec2

Casts all elements of self to u16.

pub fn as_ivec2(&self) -> IVec2

Casts all elements of self to i32.

pub fn as_uvec2(&self) -> UVec2

Casts all elements of self to u32.

pub fn as_i64vec2(&self) -> I64Vec2

Casts all elements of self to i64.

pub fn as_u64vec2(&self) -> U64Vec2

Casts all elements of self to u64.

Trait Implementations

impl Clone for Direction2d

fn clone(&self) -> Direction2d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Direction2d

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

Formats the value using the given formatter.

impl Deref for Direction2d

type Target = Vec2

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Direction2d

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Neg for Direction2d

type Output = Direction2d

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Direction2d

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

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

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

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

impl Serialize for Direction2d

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec2> for Direction2d

type Error = InvalidDirectionError

The type returned in the event of a conversion error.

fn try_from(value: Vec2) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Direction2d

impl Primitive2d for Direction2d

impl StructuralPartialEq for Direction2d