Struct SpriteSkin 

pub struct SpriteSkin { /* private fields */ }

A grid map’s ground painted from terrain tiles.

Implementations

impl SpriteSkin

pub const fn new( terrain: Option<TerrainTiles>, glyph: GlyphSkin, walk: WalkSpeeds, ) -> Self

The skin of terrain at the art’s own size, with glyph’s colors (and its ground, without terrain tiles), showing a walk at walk.

pub fn with_zooms(self, levels: &[i32]) -> Self

The same skin, offering levels as its zoom_levels when its terrain tiles paint the ground: sorted, each once, those below 1 left out.

pub fn zoomed(self, zoom: i32) -> Self

The same skin drawn zoom times the art’s size (at least once).

pub const fn terrain(&self) -> Option<&TerrainTiles>

Its terrain tiles, if it has them.

pub const fn zoom(&self) -> i32

The zoom it was given: console pixels per pixel of the art, when it has terrain tiles.

pub fn tile_size(&self) -> (i32, i32)

A map tile’s size on screen, across × down, in console pixels: the tiles’ times the zoom, or the glyph skin’s without terrain tiles. Everything that depends on the tile size goes through this.

pub fn view_tiles(&self, area: Rect) -> (i32, i32)

The area’s pixels divided by the tile size, rounded down; without terrain tiles, what the glyph skin fits.

pub fn grid<U>(&self, scene: &MapScene<U>, area: Rect) -> Grid

Where scene’s tiles go in area: as many as fit, the pixels left over split evenly around them; without terrain tiles, where the glyph skin puts them.

Trait Implementations

impl Clone for SpriteSkin

fn clone(&self) -> SpriteSkin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSkin

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

Formats the value using the given formatter.

impl<U> GridSkin<U> for SpriteSkin

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

"sprite" when the tiles paint the ground, "sprite_units" on the glyph skin’s ground.

fn zoom_levels(&self) -> &[i32]

The levels it was given (SpriteSkin::with_zooms), with terrain tiles; none without.

fn paint( &self, looks: &Looks<'_>, scene: &MapScene<U>, area: Rect, units: &dyn UnitPainter<U>, buf: &mut GlyphBuffer, )

The ground (terrain tinted by flashes and ranges), what lies under the units (UnitPainter::paint_under), the path’s line, the units, the path’s arrowhead, what lies over them (UnitPainter::paint_over), then the cursor; over them all, the threat arrows and marks.

fn tile_size(&self) -> (i32, i32)

A map tile’s size on screen, across × down, in console pixels.

fn view_tiles(&self, area: Rect) -> (i32, i32)

How many tiles, across × down, fit in a map area of area cells.

fn grid(&self, scene: &MapScene<U>, area: Rect) -> Grid

Where scene’s tiles go when it is painted into area.

fn walk(&self) -> WalkSpeeds

How fast a unit’s walk is shown under this skin.

fn zoom(&self) -> Option<i32>

The zoom it draws at, or None if it can’t zoom.

fn at_zoom(&self, zoom: i32) -> Option<Rc<dyn GridSkin<U>>>

The same skin drawing at zoom, or None if zoom isn’t one of its zoom_levels.

fn tile_px(&self, scene: &MapScene<U>, area: Rect, tile: Pos) -> Option<PxRect>

The console pixels of tile when scene is painted into area, or None if it isn’t visible. Menus and popups go beside it.

fn tile_cells(&self, scene: &MapScene<U>, area: Rect, tile: Pos) -> Option<Rect>

The cells tile_px touches.

impl PartialEq for SpriteSkin

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SpriteSkin