Enum TileBook

pub enum TileBook {
    Empty,
    TileSet(TileSetResource),
    Brush(TileMapBrushResource),
}

Abstract source of tiles, which can either be a tile set or a brush. It is called a “book” because each of these tile resources contains pages of tiles.

Variants

Empty

A tile resource containing no tiles.

TileSet(TileSetResource)

Getting tiles from a tile set

Brush(TileMapBrushResource)

Getting tiles from a brush

Implementations

impl TileBook

pub const TILE_SET_F_0: &'static str = "TileSet@0"

pub const BRUSH_F_0: &'static str = "Brush@0"

impl TileBook

pub fn page_icon(&self, position: Vector2<i32>) -> Option<TileDefinitionHandle>

The TileDefinitionHandle of the icon that represents the page at the given position.

pub fn is_tile_set(&self) -> bool

Returns true if this resource is a tile set.

pub fn is_brush(&self) -> bool

Returns true if this resource is a brush.

pub fn is_empty(&self) -> bool

Returns true if this contains no resource.

pub fn name(&self) -> String

Return the path of the resource as a String.

pub fn path(&self) -> Option<PathBuf>

Return the path of the resource.

pub fn needs_save(&self) -> bool

True if the resource is external and its change_count is not zero.

pub fn save(&self) -> Result<(), Box<dyn Error>>

Attempt to save the resource to its file, if it has one and if change_count not zero. Otherwise do nothing and return Ok to indicate success.

pub fn tile_set_ref(&self) -> Option<&TileSetResource>

A reference to the TileSetResource, if this is a TileSetResource.

pub fn get_tile_set(&self) -> Option<TileSetResource>

Returns the tile set associated with this resource. If the resource is a tile set, the return that tile set. If the resource is a brush, then return the tile set used by that brush.

pub fn get_all_tile_positions(&self, page: Vector2<i32>) -> Vec<Vector2<i32>>

Build a list of the positions of all tiles on the given page.

pub fn get_all_page_positions(&self) -> Vec<Vector2<i32>>

Build a list of the posiitons of all pages.

pub fn has_page_at(&self, position: Vector2<i32>) -> bool

True if there is a page at the given position.

pub fn page_type(&self, position: Vector2<i32>) -> Option<PageType>

The type of the page at the given position, if there is one.

pub fn is_atlas_page(&self, position: Vector2<i32>) -> bool

True if there is a atlas page at the given coordinates.

pub fn is_free_page(&self, position: Vector2<i32>) -> bool

True if there is a free tile page at the given coordinates.

pub fn is_transform_page(&self, position: Vector2<i32>) -> bool

True if there is a transform page at the given coordinates.

pub fn is_animation_page(&self, position: Vector2<i32>) -> bool

True if there is a transform page at the given coordinates.

pub fn is_brush_page(&self, position: Vector2<i32>) -> bool

True if there is a brush page at the given coordinates.

pub fn has_tile_at(&self, page: Vector2<i32>, tile: Vector2<i32>) -> bool

Return true if there is a tile at the given position on the page at the given position.

pub fn get_tile_handle( &self, position: ResourceTilePosition, ) -> Option<TileDefinitionHandle>

Returns the TileDefinitionHandle that points to the data in the tile set that represents this tile. Even if this resource is actually a brush, the handle returned still refers to some page and position in the brush’s tile set.

pub fn get_tile_iter<I: Iterator<Item = Vector2<i32>>>( &self, stage: TilePaletteStage, page: Vector2<i32>, positions: I, ) -> TileIter<I>

Returns an iterator over (Vector2<i32>, TileDefinitionHandle) where the first member of the pair is the position of the tile on the page as provided by positions and the second member is the handle that would be returned from get_tile_handle.

pub fn get_tiles<I: Iterator<Item = Vector2<i32>>>( &self, stage: TilePaletteStage, page: Vector2<i32>, iter: I, tiles: &mut Tiles, )

Construct a Tiles object holding the tile definition handles for the tiles at the given positions on the given page.

pub fn is_missing_tile_set(&self) -> bool

Returns true if the resource is a brush that has no tile set.

pub fn get_tile_render_data( &self, position: ResourceTilePosition, ) -> Option<TileRenderData>

Return the TileRenderData needed to render the tile at the given position on the given page. If there is no tile at that position or the tile set is missing or not loaded, then None is returned. If there is a tile and a tile set, but the handle of the tile does not exist in the tile set, then the rendering data for an error tile is returned using TileRenderData::missing_tile().

Beware that this method is slow. Like most methods in TileBook, this method involves locking a resource, so none of them should be called many times per frame, as one might be tempted to do with this method. Do not render a TileBook by repeatedly calling this method. Use tile_render_loop instead.

pub fn tile_render_loop<F>( &self, stage: TilePaletteStage, page: Vector2<i32>, func: F, )

where F: FnMut(Vector2<i32>, TileRenderData),

Repeatedly call the given function with each tile for the given stage and page. The function is given the position of the tile within the palette and the data for rendering the tile.

pub fn tile_collider_loop<F>(&self, page: Vector2<i32>, func: F)

where F: FnMut(Vector2<i32>, Uuid, Color, &TileCollider),

Repeatedly call the given function with each collider for each tile on the given page. The function is given the position of the tile

pub fn get_tile_bounds( &self, position: ResourceTilePosition, ) -> Option<TileMaterialBounds>

Returns the rectangle within a material that a tile should show at the given stage and handle.

pub fn tiles_bounds( &self, stage: TilePaletteStage, page: Vector2<i32>, ) -> OptionTileRect

The bounds of the tiles on the given page.

Trait Implementations

impl Clone for TileBook

fn clone(&self) -> TileBook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TileBook

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

Formats the value using the given formatter.

impl Default for TileBook

fn default() -> TileBook

Returns the “default value” for a type.

impl PartialEq for TileBook

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for TileBook

where Self: 'static, TileSetResource: Reflect, TileMapBrushResource: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

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

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for TileBook

where TileSetResource: Visit, TileMapBrushResource: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl StructuralPartialEq for TileBook