Struct GridDescriptor

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

Available on crate feature utils only.

Grid description used to generate maps via the map builder.

The user must specify two out of these three characteristics:

• 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 dimensions of the grid per axis

Generics

• T: CoordsFloat – Generic type of the future map object.

Implementations

impl<T: CoordsFloat> GridDescriptor<T>

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

Set values for all dimensions

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

Set x-axis value

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

Set y-axis value

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

Set z-axis value

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

Set values for all dimensions

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

Set x-axis value

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

Set y-axis value

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

Set z-axis value

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

Set values for all dimensions

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

Set x-axis value

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

Set y-axis value

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

Set z-axis value

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

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

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

Indicate whether to split quads of the grid

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> GridDescriptor<T>

Returns the “default value” for a type.

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

Create a CMapBuilder from a GridDescriptor.

This implementation is roughly equivalent to the following:

// setup grid descriptor
let gridd = GridDescriptor::default();
// ...

// `CMapBuilder::from(gridd)`, or:
let builder = CMapBuilder::<f64>::default().grid_descriptor(gridd);

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

Converts to this type from the input type.