honeycomb_core::cmap

Struct GridDescriptor

Source 
pub struct GridDescriptor<T: CoordsFloat> { /* private fields */ }
Expand description

§Grid description used by the map builder

The user must specify two out of these three characteristics (third is deduced):

  • n_cells: [usize; 3] – The number of cells per axis
  • len_per_cell: [T; 3] – The dimensions of cells per axis
  • lens: [T; 3] – The total dimensions of the grid per axis

§Generics

  • T: CoordsFloat – Generic FP type that will be used by the map’s vertices.

Implementations§

Source§

impl<T: CoordsFloat> GridDescriptor<T>

Source

pub fn n_cells(self, n_cells: [usize; 3]) -> Self

Set values for all dimensions

Source

pub fn n_cells_x(self, n_cells: usize) -> Self

Set x-axis value

Source

pub fn n_cells_y(self, n_cells: usize) -> Self

Set y-axis value

Source

pub fn n_cells_z(self, n_cells: usize) -> Self

Set z-axis value

Source

pub fn len_per_cell(self, len_per_cell: [T; 3]) -> Self

Set values for all dimensions

Source

pub fn len_per_cell_x(self, len_per_cell: T) -> Self

Set x-axis value

Source

pub fn len_per_cell_y(self, len_per_cell: T) -> Self

Set y-axis value

Source

pub fn len_per_cell_z(self, len_per_cell: T) -> Self

Set z-axis value

Source

pub fn lens(self, lens: [T; 3]) -> Self

Set values for all dimensions

Source

pub fn lens_x(self, lens: T) -> Self

Set x-axis value

Source

pub fn lens_y(self, lens: T) -> Self

Set y-axis value

Source

pub fn lens_z(self, lens: T) -> Self

Set z-axis value

Source

pub fn origin(self, origin: Vertex2<T>) -> Self

Set origin (most bottom-left vertex) of the grid

Source

pub fn split_quads(self, split: bool) -> Self

Indicate whether to split quads of the grid

Trait Implementations§

Source§

impl<T: Clone + CoordsFloat> Clone for GridDescriptor<T>

Source§

fn clone(&self) -> GridDescriptor<T>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Default + CoordsFloat> Default for GridDescriptor<T>

Source§

fn default() -> GridDescriptor<T>

Returns the “default value” for a type. Read more
Source§

impl<T: CoordsFloat> From<GridDescriptor<T>> for CMapBuilder<T>

Source§

fn from(value: GridDescriptor<T>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> Freeze for GridDescriptor<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for GridDescriptor<T>
where T: RefUnwindSafe,

§

impl<T> Send for GridDescriptor<T>

§

impl<T> Sync for GridDescriptor<T>

§

impl<T> Unpin for GridDescriptor<T>
where T: Unpin,

§

impl<T> UnwindSafe for GridDescriptor<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Downcast for T
where T: Any,

§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.