Struct bevy_fast_tilemap::map::Map

pub struct Map<UserData = DefaultUserData>
where
    UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,
{
    pub user_data: UserData,
    /* private fields */
}

Map, holding handles to a map texture with the tile data and an atlas texture with the tile renderings.

Fields

user_data: UserData

Implementations

impl<UserData> Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,

pub fn builder( map_size: UVec2, atlas_texture: Handle<Image>, tile_size: Vec2 ) -> MapBuilder<UserData>

Create a MapBuilder for configuring your map.

pub fn indexer_mut(&mut self) -> MapIndexer<'_, UserData>

pub fn map_size(&self) -> UVec2

Dimensions of this map in tiles.

pub fn world_size(&self) -> Vec2

Size of the map contents bounding box in world coordinates

pub fn map_to_local(&self, map_position: Vec2) -> Vec2

Convert map position in [(0.0, 0.0) .. self.size) to local world position (before this entities transform). E.g. map position (0.5, 0.5) is in the center of the tile at index (0, 0).

pub fn map_to_local_3d(&self, map_position: Vec3) -> Vec3

Same as Self::map_to_local, but return a 3d coordinate, z-value is the logical “depth” of the map position (for eg axonometric projection). Not generally consistent with actual z-position of the mesh.

pub fn map_to_world_3d(&self, map_position: Vec3) -> Vec3

pub fn world_to_map(&self, world: Vec2) -> Vec2

Convert world position to map position.

pub fn world_to_map_3d(&self, world: Vec3) -> Vec3

pub fn is_loaded(&self, images: &Assets<Image>) -> bool

pub fn update(&mut self, images: &Assets<Image>) -> bool

Update internal state. Call this when map size changed or assets may have become available. Should not be necessary to call this if only map contents changed.

Trait Implementations

impl<UserData> AsBindGroup for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,

type Data = MapKey

Data that will be stored alongside the “prepared” bind group.

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

label

fn unprepared_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, images: &RenderAssets<Image>, fallback_image: &FallbackImage ) -> Result<UnpreparedBindGroup<Self::Data>, AsBindGroupError>

Returns a vec of (binding index, OwnedBindingResource). In cases where OwnedBindingResource is not available (as for bindless texture arrays currently), an implementor may define as_bind_group directly. This may prevent certain features from working correctly.

fn bind_group_layout_entries( render_device: &RenderDevice ) -> Vec<BindGroupLayoutEntry>

Returns a vec of bind group layout entries

fn as_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, images: &RenderAssets<Image>, fallback_image: &FallbackImage ) -> Result<PreparedBindGroup<Self::Data>, AsBindGroupError>

Creates a bind group for self matching the layout defined in AsBindGroup::bind_group_layout.

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

where Self: Sized,

Creates the bind group layout matching all bind groups returned by AsBindGroup::as_bind_group

impl<UserData> Clone for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + Clone,

fn clone(&self) -> Map<UserData>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UserData> Debug for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + Debug,

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

Formats the value using the given formatter.

impl<UserData> Default for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + Default,

fn default() -> Map<UserData>

Returns the “default value” for a type.

impl<UserData> From<&Map<UserData>> for MapKey

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,

fn from(map: &Map<UserData>) -> Self

Converts to this type from the input type.

impl<UserData> FromReflect for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath + FromReflect, MapUniform: FromReflect + TypePath, Vec<u32>: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, Vec<String>: FromReflect + TypePath, bool: FromReflect + TypePath, Vec<Vec2>: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

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<UserData> GetTypeRegistration for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath + FromReflect, MapUniform: FromReflect + TypePath, Vec<u32>: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, Vec<String>: FromReflect + TypePath, bool: FromReflect + TypePath, Vec<Vec2>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl<UserData> Material2d for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,

fn vertex_shader() -> ShaderRef

Returns this material’s vertex shader. If ShaderRef::Default is returned, the default mesh vertex shader will be used.

fn fragment_shader() -> ShaderRef

Returns this material’s fragment shader. If ShaderRef::Default is returned, the default mesh fragment shader will be used.

fn specialize( descriptor: &mut RenderPipelineDescriptor, layout: &MeshVertexBufferLayout, key: Material2dKey<Self> ) -> Result<(), SpecializedMeshPipelineError>

Customizes the default RenderPipelineDescriptor.

fn depth_bias(&self) -> f32

Add a bias to the view depth of the mesh which can be used to force a specific render order.

impl<UserData> Reflect for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath + FromReflect, MapUniform: FromReflect + TypePath, Vec<u32>: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, Vec<String>: FromReflect + TypePath, bool: FromReflect + TypePath, Vec<Vec2>: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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 apply(&mut self, value: &dyn Reflect)

Applies 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

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<UserData> Struct for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath + FromReflect, MapUniform: FromReflect + TypePath, Vec<u32>: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, Vec<String>: FromReflect + TypePath, bool: FromReflect + TypePath, Vec<Vec2>: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

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

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

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

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl<UserData> TypePath for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath,

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<UserData> Typed for Map<UserData>

where Self: Any + Send + Sync, UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize + TypePath + FromReflect, MapUniform: FromReflect + TypePath, Vec<u32>: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, Vec<String>: FromReflect + TypePath, bool: FromReflect + TypePath, Vec<Vec2>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<UserData> VisitAssetDependencies for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl<UserData> Asset for Map<UserData>

where UserData: AsBindGroup + Reflect + Clone + Default + TypePath + ShaderType + WriteInto + ShaderSize,