Struct MapScale 

pub struct MapScale { /* private fields */ }

World units per raw unit of a campaign map, horizontally and vertically.

Implementations

impl MapScale

pub fn x(&self) -> f32

World units per raw unit, horizontally.

pub fn y(&self) -> f32

World units per raw unit, vertically.

pub fn cell_width(&self) -> f32

World units per cell, horizontally.

impl MapScale

pub fn new(cells: (u32, u32), world_size: (f32, f32)) -> Self

Returns the scale of a map.

Arguments

• cells - Columns and rows of the map’s hex grid.
• world_size - Size of the map in world units.

pub fn cell_at(&self, x: f32, y: f32) -> HexCell

Returns the cell containing a world position, as the game finds it.

Odd columns are shifted half a cell down, so their rows start half a cell height later. Cells are hexagons wider than their column: the first third of a column holds the slanted edges shared with the previous column, where positions above or below the edge belong to the previous column’s cells.

pub fn world_position(&self, cell: HexCell) -> (f32, f32)

Returns the world position of a cell’s top-left corner, where the game places characters given by cell.

The game multiplies in double precision by single precision scales, and adds the half-cell shift of odd columns as a separate single precision term, so the position is computed the same way.

pub fn world_to_raw(&self, x: f32, y: f32) -> (f32, f32)

Converts a world position to raw map units.

pub fn raw_to_world(&self, x: f32, y: f32) -> (f32, f32)

Converts raw map units to a world position.

pub fn raw_offset_to_world(&self, x: i16, y: i16) -> (f32, f32)

Converts a raw offset (a vector, no translation) to world units.

Map files store offsets at 100 times the raw scale.

Trait Implementations

impl Clone for MapScale

fn clone(&self) -> MapScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MapScale

impl Debug for MapScale

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

Formats the value using the given formatter.

impl PartialEq for MapScale

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MapScale