Skip to main content

HexGridHomography

projective_grid::hex::rectify

Struct HexGridHomography

pub struct HexGridHomography {
    pub h_img_from_rect: Homography,
    pub h_rect_from_img: Homography,
    pub min_q: i32,
    pub min_r: i32,
    pub max_q: i32,
    pub max_r: i32,
    pub px_per_cell: f32,
    pub rect_width: usize,
    pub rect_height: usize,
    /* private fields */
}

Expand description

A global homography mapping between rectified hex grid space and image space.

Rectified coordinates map axial (q, r) to 2D using:

x = px_per_cell * (q + r * 0.5)
y = px_per_cell * (r * sqrt(3) / 2)

Fields§

§h_img_from_rect: Homography

Maps rectified coordinates to image coordinates.

§h_rect_from_img: Homography

Maps image coordinates to rectified coordinates.

§min_q: i32

Axial bounding box (with margin).

§min_r: i32§max_q: i32§max_r: i32§px_per_cell: f32

Rectified pixels per grid cell edge.

§rect_width: usize

Rectified image dimensions.

§rect_height: usize

Implementations§

impl HexGridHomography

pub fn from_corners( corners: &HashMap<GridIndex, Point2<f32>>, px_per_cell: f32, margin_cells: f32, ) -> Result<Self, HexRectifyError>

Compute a global homography from hex grid corners to a rectified coordinate system.

corners: map from axial grid index (q=i, r=j) to image position.
px_per_cell: rectified pixels per grid cell edge.
margin_cells: extra margin around the grid bounding box (in cell units).

pub fn rect_to_img(&self, p_rect: Point2<f32>) -> Point2<f32>

Map a point from rectified space to image space.

pub fn img_to_rect(&self, p_img: Point2<f32>) -> Point2<f32>

Map a point from image space to rectified space.

pub fn axial_to_rect(&self, q: f64, r: f64) -> Point2<f64>

Convert axial coordinates (q, r) to rectified pixel coordinates.

This does not apply the homography — it maps grid indices to the rectified coordinate system directly. The result is in the same shifted frame used by the stored homography, so it can be passed to rect_to_img.

Trait Implementations§

impl Clone for HexGridHomography

fn clone(&self) -> HexGridHomography

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for HexGridHomography

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for HexGridHomography

impl RefUnwindSafe for HexGridHomography

impl Send for HexGridHomography

impl Sync for HexGridHomography

impl Unpin for HexGridHomography

impl UnsafeUnpin for HexGridHomography

impl UnwindSafe for HexGridHomography

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> StrictAs for T

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

fn strict_cast_from(src: Src) -> Dst

Casts the value.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.