Struct MapTileDescriptor 

pub struct MapTileDescriptor { /* private fields */ }

describes a map tile

Implementations

impl MapTileDescriptor

pub fn new(zoom_level: ZoomLevel, grid_coordinates: GridCoordinates) -> Self

create a new MapTileDescriptor

this will automatically normalize the given GridCoordinates to the lower left corner of a map tile at that zoom level

pub const fn zoom_level(&self) -> &ZoomLevel

the ZoomLevel of the map tile

pub const fn lower_left_corner(&self) -> &GridCoordinates

the GridCoordinates of the lower left corner of this map tile

pub fn tile_size(&self) -> u16

the size of this map tile in regions

pub fn tile_size_in_pixels(&self) -> u32

the size of this map tile in pixels

pub fn grid_rectangle(&self) -> GridRectangle

the grid rectangle covered by this map tile

Trait Implementations

impl Clone for MapTileDescriptor

fn clone(&self) -> MapTileDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MapTileDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MapTileDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GridRectangleLike for MapTileDescriptor

fn grid_rectangle(&self) -> GridRectangle

the GridRectangle represented by this map like image

fn lower_left_corner(&self) -> GridCoordinates

returns the lower left corner of the rectangle

fn lower_right_corner(&self) -> GridCoordinates

returns the lower right corner of the rectangle

fn upper_left_corner(&self) -> GridCoordinates

returns the upper left corner of the rectangle

fn upper_right_corner(&self) -> GridCoordinates

returns the upper right corner of the rectangle

fn size_x(&self) -> u16

the size of the map like image in regions in the x direction (width)

fn size_y(&self) -> u16

the size of the map like image in regions in the y direction (width)

fn x_range(&self) -> RangeInclusive<u16>

returns a range for the region x coordinates of this rectangle

fn y_range(&self) -> RangeInclusive<u16>

returns a range for the region y coordinates of this rectangle

fn contains(&self, grid_coordinates: &GridCoordinates) -> bool

checks if a given set of GridCoordinates is within this GridRectangle

fn intersect<O>(&self, other: &O) -> Option<GridRectangle>

where O: GridRectangleLike,

returns a new GridRectangle which is the area where this GridRectangle and another intersect each other or None if there is no intersection

fn pps_hud_config(&self) -> String

returns a PPS HUD description string for this GridRectangle

impl Hash for MapTileDescriptor

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 MapTileDescriptor

fn eq(&self, other: &MapTileDescriptor) -> 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 Serialize for MapTileDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MapTileDescriptor

impl StructuralPartialEq for MapTileDescriptor