Enum TileOrientation 

#[repr(u8)]
pub enum TileOrientation {
    Default = 0,
    Rotate90 = 3,
    Rotate180 = 6,
    Rotate270 = 5,
    MirrorH = 4,
    MirrorHRotate90 = 1,
    MirrorHRotate180 = 2,
    MirrorHRotate270 = 7,
}

The set of possible tile orientations. These represent all possible results of mirroring the tile horizontally and/or vertically, and/or rotation by 90 degree increments.

Rotation is measured counter-clockwise as elsewhere in Bevy.

The representation is a u8 value where the bits (from most significant to least significant), represent:

• Bit 2: Mirroring the tile horizontally (left and right sides are swapped)
• Bit 1: Mirroring the tile vertically (top and bottom are swapped)
• Bit 0: Mirroring the tile diagonally (top-right and bottom-left corners are swapped)

The order in which the mirroring is performed matters - the tile is first mirrored horizontally (if specified), then vertically, then finally diagonally, in the UV coordinate system.

Note that different coordinate systems are used for UV mapping and Bevy world coordinates (e.g. in UV maps, the y component increases towards the bottom of the tile, in Bevy it increases towards the top). This means that the ordering in which the mirroring is applied differs in different coordinate systems.

The ordering of the enum starts from the default orientation (no rotation or mirroring), then we have successive 90 degree counter-clockwise rotations. Then we have a tile mirrored horizontally, and then the results of successive 90 degree counter-clockwise rotations of the mirrored tile.

The enum values can be easily converted to the format used for tile indices in Tiled maps, where bits 31, 30 and 29 correspond to bits 2, 1 and 0 of this enum’s values. So for a given enum value, we can just use value << 29 to produce the bits required in a Tiled index.

Variants

Default = 0

Rotate90 = 3

Rotate180 = 6

Rotate270 = 5

MirrorH = 4

MirrorHRotate90 = 1

MirrorHRotate180 = 2

MirrorHRotate270 = 7

Implementations

impl TileOrientation

pub fn from_bools( mirror_h: bool, mirror_v: bool, mirror_d: bool, ) -> TileOrientation

Create a TileOrientation based on whether each mirror is applied

pub fn mirror_h(&self) -> bool

True if the tile is mirrored horizontally

pub fn mirror_v(&self) -> bool

True if the tile is mirrored vertically

pub fn mirror_d(&self) -> bool

True if the tile is mirrored diagonally

pub fn inverse(&self) -> TileOrientation

This method treats each TileOrientation as the transform from TileOrientation::Default to that orientation. Find the TileOrientation that when applied will undo the effect of this TileOrientation

pub fn apply_to_ivec2(&self, pos: &IVec2) -> IVec2

This method treats the TileOrientation as the transform from TileOrientation::Default to this orientation. Apply this transformation to an IVec2

pub fn and_then(&self, then: TileOrientation) -> TileOrientation

This method treats each TileOrientation as the transform from TileOrientation::Default to that orientation. Produce a TileOrientation that will give the same effect as applying this transform, then applying then.

Trait Implementations

impl Clone for TileOrientation

fn clone(&self) -> TileOrientation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TileOrientation

impl Debug for TileOrientation

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

Formats the value using the given formatter.

impl Default for TileOrientation

fn default() -> TileOrientation

Returns the “default value” for a type.

impl Display for TileOrientation

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

Formats the value using the given formatter.

impl Enum for TileOrientation

fn field(&self, __name_param: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize, ) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn to_dynamic_enum(&self) -> DynamicEnum

Creates a new DynamicEnum from this enum.

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl Eq for TileOrientation

impl FromReflect for TileOrientation

fn from_reflect(__param0: &dyn PartialReflect) -> Option<Self>

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 GetTypeRegistration for TileOrientation

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 Hash for TileOrientation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TileOrientation

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

Equality operator ==.

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

Inequality operator !=.

impl PartialReflect for TileOrientation

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_param: &dyn PartialReflect, ) -> 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> 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>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

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

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

Returns a “partial equality” comparison result.

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

Returns a “partial comparison” result.

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) -> Box<dyn PartialReflect>

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 debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for TileOrientation

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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 StructuralPartialEq for TileOrientation

impl TypePath for TileOrientation

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 TileOrientation

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.