Enum veloren_world::site2::util::Dir

pub enum Dir {
    X,
    Y,
    NegX,
    NegY,
}

A 2d direction.

Variants

X

Y

NegX

NegY

Implementations

impl Dir

pub const ALL: [Dir; 4] = _

pub fn choose(rng: &mut impl Rng) -> Dir

pub fn from_vec2(vec: Vec2<i32>) -> Dir

pub fn opposite(self) -> Dir

pub fn rotated_ccw(self) -> Dir

Rotate the direction anti clock wise

pub fn rotated_cw(self) -> Dir

Rotate the direction clock wise

pub fn orthogonal(self) -> Dir

pub fn abs(self) -> Dir

pub fn signum(self) -> i32

pub fn to_vec2(self) -> Vec2<i32>

pub fn to_vec3(self) -> Vec3<i32>

pub fn vec2(self, x: i32, y: i32) -> Vec2<i32>

Create a vec2 where x is in the direction of self, and y is anti clockwise of self.

pub fn to_mat3(self) -> Mat3<i32>

Returns a 3x3 matrix that rotates Vec3(1, 0, 0) to the direction you get in to_vec3. Inteded to be used with Primitive::Rotate.

Example:

use vek::Vec3;
use veloren_world::site2::util::Dir;
let dir = Dir::X;

assert_eq!(dir.to_mat3() * Vec3::new(1, 0, 0), dir.to_vec3());

let dir = Dir::NegX;

assert_eq!(dir.to_mat3() * Vec3::new(1, 0, 0), dir.to_vec3());

let dir = Dir::Y;

assert_eq!(dir.to_mat3() * Vec3::new(1, 0, 0), dir.to_vec3());

let dir = Dir::NegY;

assert_eq!(dir.to_mat3() * Vec3::new(1, 0, 0), dir.to_vec3());

pub fn from_z_mat3(self) -> Mat3<i32>

Creates a matrix that tranforms an upwards facing vector to this direction.

pub fn relative_to(self, other: Dir) -> Dir

Translates this direction to worldspace as if it was relative to the other direction

pub fn is_x(self) -> bool

Is this direction parallel to x

pub fn is_y(self) -> bool

Is this direction parallel to y

pub fn select(self, vec: impl Into<Vec2<i32>>) -> i32

Returns the component that the direction is parallell to

pub fn select_with( self, vec: impl Into<Vec2<i32>>, other: impl Into<Vec2<i32>>, ) -> Vec2<i32>

Select one component the direction is parallel to from vec and select the other component from other

pub fn select_aabr<T>(self, aabr: Aabr<T>) -> T

Returns the side of an aabr that the direction is pointing to

pub fn select_aabr_with<T>( self, aabr: Aabr<T>, other: impl Into<Vec2<T>>, ) -> Vec2<T>

Select one component from the side the direction is pointing to from aabr and select the other component from other

pub fn sprite_ori(self) -> u8

The equivelant sprite direction of the direction

pub fn split_aabr_offset<T>(self, aabr: Aabr<T>, offset: T) -> [Aabr<T>; 2]

where T: Copy + PartialOrd + Add<T, Output = T> + Sub<T, Output = T>,

pub fn try_split_aabr<T>(self, aabr: Aabr<T>, sp: T) -> Option<[Aabr<T>; 2]>

where T: Copy + PartialOrd + Add<T, Output = T> + Sub<T, Output = T>,

Try to split an aabr in a certain direction

pub fn trim_aabr(self, aabr: Aabr<i32>, offset: i32) -> Aabr<i32>

pub fn extend_aabr(self, aabr: Aabr<i32>, amount: i32) -> Aabr<i32>

Trait Implementations

impl<O: Into<EnumSet<Dir>>> BitAnd<O> for Dir

type Output = EnumSet<Dir>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> Self::Output

Performs the & operation.

impl<O: Into<EnumSet<Dir>>> BitOr<O> for Dir

type Output = EnumSet<Dir>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> Self::Output

Performs the | operation.

impl<O: Into<EnumSet<Dir>>> BitXor<O> for Dir

type Output = EnumSet<Dir>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> Self::Output

Performs the ^ operation.

impl Clone for Dir

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir

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

Formats the value using the given formatter.

impl Enum for Dir

const LENGTH: usize = 4usize

Length of the enum.

fn from_usize(value: usize) -> Self

Takes an usize, and returns an element matching into_usize function.

fn into_usize(self) -> usize

Returns an unique identifier for a value within range of 0..Array::LENGTH.

impl<V> EnumArray<V> for Dir

type Array = [V; 4]

Representation of an enum map for type V.

impl EnumSetTypePrivate for Dir

type ConstHelper = __EnumSetConstHelper

A helper type used to implement the enum_set! macro among other things.

const CONST_HELPER_INSTANCE: __EnumSetConstHelper = __EnumSetConstHelper

The instance of the ConstHelper.

type Repr = u8

The underlying type used to store the bitset.

const ALL_BITS: Self::Repr = {transmute(0x0f): <site2::util::Dir as enumset::__internal::EnumSetTypePrivate>::Repr}

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 4u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 4u32

The number of variants in the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

impl IntoEnumIterator for Dir

type Iterator = DirIter

fn iter() -> DirIter

impl Neg for Dir

type Output = Dir

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for Dir

type Output = EnumSet<Dir>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<EnumSet<Dir>> for Dir

fn eq(&self, other: &EnumSet<Dir>) -> 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 PartialEq for Dir

fn eq(&self, other: &Self) -> 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<O: Into<EnumSet<Dir>>> Sub<O> for Dir

type Output = EnumSet<Dir>

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self::Output

Performs the - operation.

impl Copy for Dir

impl EnumSetType for Dir

impl Eq for Dir