Struct leafwing_input_manager::orientation::Direction

pub struct Direction { /* private fields */ }

A 2D unit vector that represents a direction

Its magnitude is always one.

Example

use leafwing_input_manager::orientation::Direction;
use bevy_math::Vec2;

assert_eq!(Direction::NORTH.unit_vector(), Vec2::new(0.0, 1.0));
assert_eq!(Direction::try_from(Vec2::ONE), Ok(Direction::NORTHEAST));

assert_eq!(Direction::SOUTH * 3.0, Vec2::new(0.0, -3.0));
assert_eq!(Direction::EAST / 2.0, Vec2::new(0.5, 0.0));

Implementations

impl Direction

pub fn new(vec2: Vec2) -> Self

Creates a new Direction from a Vec2

The Vec2 will be normalized to have a magnitude of 1.

Panics

Panics if the supplied vector has length zero.

pub const fn unit_vector(&self) -> Vec2

Returns the raw underlying Vec2 unit vector of this direction

This will always have a magnitude of 1, unless it is [Direction::NEUTRAL]

impl Direction

pub const NORTH: Direction = Direction { unit_vector: const_vec2!([0.0, 1.0]), }

The direction that points straight up

pub const EAST: Direction = Direction { unit_vector: const_vec2!([1.0, 0.0]), }

The direction that points straight right

pub const SOUTH: Direction = Direction { unit_vector: const_vec2!([0.0, -1.0]), }

The direction that points straight down

pub const WEST: Direction = Direction { unit_vector: const_vec2!([-1.0, 0.0]), }

The direction that points straight left

pub const NORTHEAST: Direction = Direction { unit_vector: const_vec2!([SQRT_2 / 2.0, SQRT_2 / 2.0]), }

The direction that points halfway between up and right

pub const SOUTHEAST: Direction = Direction { unit_vector: const_vec2!([SQRT_2 / 2.0, -SQRT_2 / 2.0]), }

The direction that points halfway between down and right

pub const SOUTHWEST: Direction = Direction { unit_vector: const_vec2!([-SQRT_2 / 2.0, -SQRT_2 / 2.0]), }

The direction that points halfway between down and left

pub const NORTHWEST: Direction = Direction { unit_vector: const_vec2!([-SQRT_2 / 2.0, SQRT_2 / 2.0]), }

The direction that points halfway between left and up

Trait Implementations

impl Add<Direction> for Direction

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, other: Direction) -> Vec2

Performs the + operation.

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Direction where
    Self: Send + Sync + 'static, 

type Storage = TableStorage

impl Debug for Direction

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Direction

Direction::NORTH is the default direction, as it is consistent with the default [Rotation]

impl Display for Direction

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

Formats the value using the given formatter.

impl Div<Direction> for f32

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: Direction) -> Self::Output

Performs the / operation.

impl Div<f32> for Direction

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Direction> for Vec3

fn from(direction: Direction) -> Vec3

Converts to this type from the input type.

impl From<Direction> for Rotation

fn from(direction: Direction) -> Rotation

Converts to this type from the input type.

impl From<Direction> for Vec2

fn from(direction: Direction) -> Vec2

Converts to this type from the input type.

impl From<Direction> for Quat

fn from(direction: Direction) -> Quat

Converts to this type from the input type.

impl From<Direction> for Transform

fn from(direction: Direction) -> Self

Converts to this type from the input type.

impl From<Direction> for GlobalTransform

fn from(direction: Direction) -> Self

Converts to this type from the input type.

impl From<GlobalTransform> for Direction

fn from(transform: GlobalTransform) -> Self

Converts to this type from the input type.

impl From<Quat> for Direction

fn from(quaternion: Quat) -> Self

Converts to this type from the input type.

impl From<Rotation> for Direction

fn from(rotation: Rotation) -> Direction

Converts to this type from the input type.

impl From<Transform> for Direction

fn from(transform: Transform) -> Self

Converts to this type from the input type.

impl Mul<Direction> for f32

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Direction

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Direction

type Output = Direction

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Orientation for Direction

fn distance(&self, other: Direction) -> Rotation

Returns the absolute distance between self and other as a Rotation

fn assert_approx_eq(self, other: impl Orientation)

Asserts that self is approximately equal to other

fn rotation_direction(&self, target: Self) -> RotationDirection

Which RotationDirection is the shortest to rotate towards to reach target?

fn rotate_towards(
    &mut self,
    target_orientation: Self,
    max_rotation: Option<Rotation>
)

Rotates self towards target_orientation by up to max_rotation

impl PartialEq<Direction> for Direction

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

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

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

This method tests for !=.

impl Sub<Direction> for Direction

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: Direction) -> Vec2

Performs the - operation.

impl TryFrom<Vec2> for Direction

type Error = NearlySingularConversion

The type returned in the event of a conversion error.

fn try_from(vec2: Vec2) -> Result<Direction, NearlySingularConversion>

Performs the conversion.

impl Copy for Direction

impl StructuralPartialEq for Direction