Struct Dir2 

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

A normalized vector pointing in a direction in 2D space

Implementations

impl Dir2

pub const X: Dir2

A unit vector pointing along the positive X axis.

pub const Y: Dir2

A unit vector pointing along the positive Y axis.

pub const NEG_X: Dir2

A unit vector pointing along the negative X axis.

pub const NEG_Y: Dir2

A unit vector pointing along the negative Y axis.

pub const AXES: [Dir2; 2]

The directional axes.

pub const CARDINALS: [Dir2; 4]

The cardinal directions.

pub const NORTH: Dir2

The “north” direction, equivalent to Dir2::Y.

pub const SOUTH: Dir2

The “south” direction, equivalent to Dir2::NEG_Y.

pub const EAST: Dir2

The “east” direction, equivalent to Dir2::X.

pub const WEST: Dir2

The “west” direction, equivalent to Dir2::NEG_X.

pub const NORTH_EAST: Dir2

The “north-east” direction, between Dir2::NORTH and Dir2::EAST.

pub const NORTH_WEST: Dir2

The “north-west” direction, between Dir2::NORTH and Dir2::WEST.

pub const SOUTH_EAST: Dir2

The “south-east” direction, between Dir2::SOUTH and Dir2::EAST.

pub const SOUTH_WEST: Dir2

The “south-west” direction, between Dir2::SOUTH and Dir2::WEST.

pub const DIAGONALS: [Dir2; 4]

The diagonals between the cardinal directions.

pub const ALL_NEIGHBORS: [Dir2; 8]

All neighbors of a tile on a square grid in a 3x3 neighborhood. A combination of Self::CARDINALS and Self::DIAGONALS

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

Create a direction from a finite, nonzero Vec2, normalizing it.

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) -> Dir2

Create a Dir2 from a Vec2 that is already normalized.

Warning

value must be normalized, i.e its length must be 1.0.

Examples found in repository

examples/math/bounding_2d.rs (line 291)

fn get_and_draw_ray(gizmos: &mut Gizmos, time: &Time) -> RayCast2d {
    let ray = Vec2::new(ops::cos(time.elapsed_secs()), ops::sin(time.elapsed_secs()));
    let dist = 150. + ops::sin(0.5 * time.elapsed_secs()).abs() * 500.;

    let aabb_ray = Ray2d {
        origin: ray * 250.,
        direction: Dir2::new_unchecked(-ray),
    };
    let ray_cast = RayCast2d::from_ray(aabb_ray, dist - 20.);

    draw_ray(gizmos, &ray_cast);
    ray_cast
}

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

Create a direction from a finite, nonzero Vec2, normalizing it and 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<Dir2, 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.

Examples found in repository

examples/ui/navigation/directional_navigation.rs (line 371)

fn navigate(
    action_state: Res<ActionState>,
    mut auto_directional_navigator: AutoDirectionalNavigator,
) {
    let net_east_west = action_state
        .pressed_actions
        .contains(&DirectionalNavigationAction::Right) as i8
        - action_state
            .pressed_actions
            .contains(&DirectionalNavigationAction::Left) as i8;

    let net_north_south = action_state
        .pressed_actions
        .contains(&DirectionalNavigationAction::Up) as i8
        - action_state
            .pressed_actions
            .contains(&DirectionalNavigationAction::Down) as i8;

    // Use Dir2::from_xy to convert input to direction, then convert to CompassOctant
    let maybe_direction = Dir2::from_xy(net_east_west as f32, net_north_south as f32)
        .ok()
        .map(CompassOctant::from);

    if let Some(direction) = maybe_direction {
        match auto_directional_navigator.navigate(direction) {
            Ok(_entity) => {
                // Successfully navigated
            }
            Err(_e) => {
                // Navigation failed (no neighbor in that direction)
            }
        }
    }
}

examples/math/bounding_2d.rs (line 235)

fn setup(mut commands: Commands) {
    commands.spawn(Camera2d);

    commands.spawn((
        Transform::from_xyz(-OFFSET_X, OFFSET_Y, 0.),
        Shape::Circle(Circle::new(45.)),
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(0., OFFSET_Y, 0.),
        Shape::Rectangle(Rectangle::new(80., 80.)),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(OFFSET_X, OFFSET_Y, 0.),
        Shape::Triangle(Triangle2d::new(
            Vec2::new(-40., -40.),
            Vec2::new(-20., 40.),
            Vec2::new(40., 50.),
        )),
        Spin,
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(-OFFSET_X, -OFFSET_Y, 0.),
        Shape::Line(Segment2d::from_direction_and_length(
            Dir2::from_xy(1., 0.3).unwrap(),
            90.,
        )),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(0., -OFFSET_Y, 0.),
        Shape::Capsule(Capsule2d::new(25., 50.)),
        Spin,
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(OFFSET_X, -OFFSET_Y, 0.),
        Shape::Polygon(RegularPolygon::new(50., 6)),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Text::default(),
        Node {
            position_type: PositionType::Absolute,
            top: px(12),
            left: px(12),
            ..default()
        },
    ));
}

examples/ui/navigation/directional_navigation_overrides.rs (line 695)

fn navigate(
    action_state: Res<ActionState>,
    parent_query: Query<&ChildOf>,
    mut visibility_query: Query<&mut Visibility>,
    mut auto_directional_navigator: AutoDirectionalNavigator,
) {
    let net_east_west = action_state
        .pressed_actions
        .contains(&DirectionalNavigationAction::Right) as i8
        - action_state
            .pressed_actions
            .contains(&DirectionalNavigationAction::Left) as i8;

    let net_north_south = action_state
        .pressed_actions
        .contains(&DirectionalNavigationAction::Up) as i8
        - action_state
            .pressed_actions
            .contains(&DirectionalNavigationAction::Down) as i8;

    // Use Dir2::from_xy to convert input to direction, then convert to CompassOctant
    let maybe_direction = Dir2::from_xy(net_east_west as f32, net_north_south as f32)
        .ok()
        .map(CompassOctant::from);

    // Store the previous focus in case navigation switches pages.
    let previous_focus = auto_directional_navigator.input_focus();
    if let Some(direction) = maybe_direction {
        match auto_directional_navigator.navigate(direction) {
            Ok(new_focus) => {
                // Successfully navigated!

                // If navigation switches between pages, change the visibilities of pages
                if let Ok(current_child_of) = parent_query.get(new_focus)
                    && let Ok(mut current_page_visibility) =
                        visibility_query.get_mut(current_child_of.parent())
                {
                    *current_page_visibility = Visibility::Inherited;

                    if let Some(previous_focus_entity) = previous_focus
                        && let Ok(previous_child_of) = parent_query.get(previous_focus_entity)
                        && previous_child_of.parent() != current_child_of.parent()
                        && let Ok(mut previous_page_visibility) =
                            visibility_query.get_mut(previous_child_of.parent())
                    {
                        *previous_page_visibility = Visibility::Hidden;
                    }
                }
            }
            Err(_e) => {
                // Navigation failed (no neighbor in that direction)
            }
        }
    }
}

pub fn from_xy_unchecked(x: f32, y: f32) -> Dir2

Create a direction from its x and y components, assuming the resulting vector is normalized.

Warning

The vector produced from x and y must be normalized, i.e its length must be 1.0.

pub fn from_angle(angle: f32) -> Dir2

Creates a 2D direction containing [angle.cos(), angle.sin()].

pub const fn as_vec2(&self) -> Vec2

Returns the inner Vec2

pub fn slerp(self, rhs: Dir2, s: f32) -> Dir2

Performs a spherical linear interpolation between self and rhs based on the value s.

This corresponds to interpolating between the two directions at a constant angular velocity.

When s == 0.0, the result will be equal to self. When s == 1.0, the result will be equal to rhs.

Example

let dir1 = Dir2::X;
let dir2 = Dir2::Y;

let result1 = dir1.slerp(dir2, 1.0 / 3.0);
#[cfg(feature = "approx")]
assert_relative_eq!(result1, Dir2::from_xy(0.75_f32.sqrt(), 0.5).unwrap());

let result2 = dir1.slerp(dir2, 0.5);
#[cfg(feature = "approx")]
assert_relative_eq!(result2, Dir2::from_xy(0.5_f32.sqrt(), 0.5_f32.sqrt()).unwrap());

pub fn rotation_to(self, other: Dir2) -> Rot2

Get the rotation that rotates this direction to other.

pub fn rotation_from(self, other: Dir2) -> Rot2

Get the rotation that rotates other to this direction.

pub fn rotation_from_x(self) -> Rot2

Get the rotation that rotates the X-axis to this direction.

pub fn rotation_to_x(self) -> Rot2

Get the rotation that rotates this direction to the X-axis.

pub fn rotation_from_y(self) -> Rot2

Get the rotation that rotates the Y-axis to this direction.

pub fn rotation_to_y(self) -> Rot2

Get the rotation that rotates this direction to the Y-axis.

pub fn fast_renormalize(self) -> Dir2

Returns self after an approximate normalization, assuming the value is already nearly normalized. Useful for preventing numerical error accumulation. See Dir3::fast_renormalize for an example of when such error accumulation might occur.

pub fn perpendicular(self) -> Dir2

Returns the perpendicular vector rotated to 90 degrees counterclockwise.

Methods from Deref<Target = Vec2>

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

Converts self to [x, y]

Trait Implementations

impl AbsDiffEq for Dir2

Available on crate features approx only.

type Epsilon = f32

Used for specifying relative comparisons.

fn default_epsilon() -> f32

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Dir2, epsilon: f32) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for Dir2

fn clone(&self) -> Dir2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Dir2

impl Debug for Dir2

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

Formats the value using the given formatter.

impl Deref for Dir2

type Target = Vec2

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Dir2

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dir2

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

Formats the value using the given formatter.

impl Ease for Dir2

fn interpolating_curve_unbounded(start: Dir2, end: Dir2) -> impl Curve<Dir2>

Given start and end values, produce a curve with unlimited domain that:

impl From<CompassOctant> for Dir2

fn from(o: CompassOctant) -> Dir2

Converts to this type from the input type.

impl From<CompassQuadrant> for Dir2

fn from(q: CompassQuadrant) -> Dir2

Converts to this type from the input type.

impl From<Dir2> for CompassQuadrant

fn from(dir: Dir2) -> CompassQuadrant

Converts a Dir2 to a CompassQuadrant in a lossy manner. Converting back to a Dir2 is not guaranteed to yield the same value.

impl From<Dir2> for CompassOctant

fn from(dir: Dir2) -> CompassOctant

Converts a Dir2 to a CompassOctant in a lossy manner. Converting back to a Dir2 is not guaranteed to yield the same value.

impl From<Dir2> for Vec2

fn from(value: Dir2) -> Vec2

Converts to this type from the input type.

impl FromArg for Dir2

type This<'from_arg> = Dir2

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Dir2 as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Dir2

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Dir2>

Constructs a concrete instance of Self from a reflected value.

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

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

impl FromRng for Dir2

fn from_rng<R>(rng: &mut R) -> Self

where R: RngExt + ?Sized,

Construct a value of this type uniformly at random using rng as the source of randomness.

impl GetOwnership for Dir2

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Dir2

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<Config, Clear> GizmoPrimitive2d<Dir2> for GizmoBuffer<Config, Clear>

where Config: GizmoConfigGroup, Clear: 'static + Send + Sync,

type Output<'a> = () where GizmoBuffer<Config, Clear>: 'a

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

fn primitive_2d( &mut self, primitive: &Dir2, isometry: impl Into<Isometry2d>, color: impl Into<Color>, ) -> <GizmoBuffer<Config, Clear> as GizmoPrimitive2d<Dir2>>::Output<'_>

Renders a 2D primitive with its associated details.

impl IntoReturn for Dir2

fn into_return<'into_return>(self) -> Return<'into_return>

where Dir2: 'into_return,

Converts Self into a Return value.

impl Mul<Dir2> for Rot2

fn mul(self, direction: Dir2) -> <Rot2 as Mul<Dir2>>::Output

Rotates the Dir2 using a Rot2.

type Output = Dir2

The resulting type after applying the * operator.

impl Mul<Dir2> for Isometry2d

type Output = Dir2

The resulting type after applying the * operator.

fn mul(self, rhs: Dir2) -> <Isometry2d as Mul<Dir2>>::Output

Performs the * operation.

impl Mul<f32> for Dir2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Dir2 as Mul<f32>>::Output

Performs the * operation.

impl Neg for Dir2

type Output = Dir2

The resulting type after applying the - operator.

fn neg(self) -> <Dir2 as Neg>::Output

Performs the unary - operation.

impl PartialEq for Dir2

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

Equality operator ==.

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

Inequality operator !=.

impl PartialReflect for Dir2

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

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply 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<Dir2>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Dir2>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Dir2>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

fn to_dynamic(&self) -> Result<Box<dyn PartialReflect>, ReflectCloneError>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Primitive2d for Dir2

impl Reflect for Dir2

fn into_any(self: Box<Dir2>) -> 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<Dir2>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

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

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected 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.

impl RelativeEq for Dir2

Available on crate features approx only.

fn default_max_relative() -> f32

The default relative tolerance for testing values that are far-apart.

fn relative_eq(&self, other: &Dir2, epsilon: f32, max_relative: f32) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for Dir2

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 StableInterpolate for Dir2

fn interpolate_stable(&self, other: &Dir2, t: f32) -> Dir2

Interpolate between this value and the other given value using the parameter t. At t = 0.0, a value equivalent to self is recovered, while t = 1.0 recovers a value equivalent to other, with intermediate values interpolating between the two. See the trait-level documentation for details.

fn interpolate_stable_assign(&mut self, other: &Self, t: f32)

A version of interpolate_stable that assigns the result to self for convenience.

fn smooth_nudge(&mut self, target: &Self, decay_rate: f32, delta: f32)

Smoothly nudge this value towards the target at a given decay rate. The decay_rate parameter controls how fast the distance between self and target decays relative to the units of delta; the intended usage is for decay_rate to generally remain fixed, while delta is something like delta_time from an updating system. This produces a smooth following of the target that is independent of framerate.

impl StructuralPartialEq for Dir2

impl TryFrom<Vec2> for Dir2

type Error = InvalidDirectionError

The type returned in the event of a conversion error.

fn try_from(value: Vec2) -> Result<Dir2, <Dir2 as TryFrom<Vec2>>::Error>

Performs the conversion.

impl TupleStruct for Dir2

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct( &self, ) -> Result<DynamicTupleStruct, ReflectCloneError>

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Dir2

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 Dir2

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UlpsEq for Dir2

Available on crate features approx only.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Dir2, epsilon: f32, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.