Struct bevy::math::prelude::Direction2d

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

A normalized vector pointing in a direction in 2D space

Implementations

impl Direction2d

pub const X: Direction2d = _

A unit vector pointing along the positive X axis.

pub const Y: Direction2d = _

A unit vector pointing along the positive Y axis.

pub const NEG_X: Direction2d = _

A unit vector pointing along the negative X axis.

pub const NEG_Y: Direction2d = _

A unit vector pointing along the negative Y axis.

pub fn new(value: Vec2) -> Result<Direction2d, 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) -> Direction2d

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<(Direction2d, 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<Direction2d, 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<(), Error>

Formats the value using the given formatter.

impl Deref for Direction2d

type Target = Vec2

The resulting type after dereferencing.

fn deref(&self) -> &<Direction2d as Deref>::Target

Dereferences the value.

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

fn deserialize<__D>( __deserializer: __D ) -> Result<Direction2d, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for Direction2d

where Direction2d: Any + Send + Sync,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Direction2d>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Direction2d

where Direction2d: Any + Send + Sync,

fn get_type_registration() -> TypeRegistration

impl<'w, 's, T> GizmoPrimitive2d<Direction2d> for Gizmos<'w, 's, T>

where T: GizmoConfigGroup,

type Output<'a> = () where Gizmos<'w, 's, T>: 'a

The output of primitive_2d. This is a builder to set non-default values.

fn primitive_2d( &mut self, primitive: Direction2d, position: Vec2, angle: f32, color: Color ) -> <Gizmos<'w, 's, T> as GizmoPrimitive2d<Direction2d>>::Output<'_>

Renders a 2D primitive with its associated details.

impl Neg for Direction2d

type Output = Direction2d

The resulting type after applying the - operator.

fn neg(self) -> <Direction2d as Neg>::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 Reflect for Direction2d

where Direction2d: Any + Send + Sync,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Direction2d>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Direction2d>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Direction2d>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for Direction2d

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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<Direction2d, <Direction2d as TryFrom<Vec2>>::Error>

Performs the conversion.

impl TypePath for Direction2d

where Direction2d: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Direction2d

where Direction2d: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Direction2d

impl Primitive2d for Direction2d

impl StructuralPartialEq for Direction2d