Struct PlaneMeshBuilder 

pub struct PlaneMeshBuilder<'l> {
    pub layout: &'l HexLayout,
    pub pos: Hex,
    pub offset: Option<Vec3>,
    pub scale: Option<Vec3>,
    pub rotation: Option<Quat>,
    pub uv_options: UVOptions,
    pub center_aligned: bool,
    pub inset_options: Option<InsetOptions>,
}

Builder struct to customize hex plane mesh generation.

The mesh will be anchored at the center of the hexagon, use offsets to cutomize anchor/pivot position.

Note

Transform operations (Scale, Rotate, Translate) through the methods

• Scale: Self::with_scale
• Rotate: Self::with_rotation, Self::facing
• Translate: Self::with_offset, Self::at

Are executed in that order, or SRT

Fields

layout: &'l HexLayout

The hexagonal layout, used to compute vertex positions

pos: Hex

Custom hex position, will apply an offset if not Hex::ZERO

offset: Option<Vec3>

Optional custom offset for the mesh vertex positions

scale: Option<Vec3>

Optional custom scale factor for the mesh vertex positions

rotation: Option<Quat>

Optional custom rotation, useful to have the mesh already rotated

By default the mesh is facing up (Y axis)

uv_options: UVOptions

UV mapping options

center_aligned: bool

If set to true, the mesh will ignore HexLayout::origin

inset_options: Option<InsetOptions>

Optional inset options for the plane face

Implementations

impl<'l> PlaneMeshBuilder<'l>

pub const fn new(layout: &'l HexLayout) -> PlaneMeshBuilder<'l>

Setup a new builder using the given layout

pub const fn at(self, pos: Hex) -> PlaneMeshBuilder<'l>

Specifies a custom pos, which will apply an offset to the whole mesh.

Note

It might be more optimal to generate only one mesh at Hex::ZERO and offset it later than have one mesh per hex position

pub fn facing(self, facing: Vec3) -> PlaneMeshBuilder<'l>

Specify a custom facing direction for the mesh, by default the column is vertical (facing up)

Panics

Will panic if facing is zero length

pub const fn with_rotation(self, rotation: Quat) -> PlaneMeshBuilder<'l>

Specify a custom rotation for the whole mesh

pub const fn with_offset(self, offset: Vec3) -> PlaneMeshBuilder<'l>

Specify a custom offset for the whole mesh

pub const fn with_scale(self, scale: Vec3) -> PlaneMeshBuilder<'l>

Specify a custom scale factor for the whole mesh

pub const fn with_uv_options( self, uv_options: UVOptions, ) -> PlaneMeshBuilder<'l>

Specify custom UV mapping options

pub const fn center_aligned(self) -> PlaneMeshBuilder<'l>

Ignores the HexLayout::origin offset, generating a mesh centered around (0.0, 0.0).

pub const fn with_inset_options( self, opts: InsetOptions, ) -> PlaneMeshBuilder<'l>

Specify insetting option for the hexagonal face

pub fn build(self) -> MeshInfo

Comsumes the builder to return the computed mesh data

Trait Implementations

impl<'l> Clone for PlaneMeshBuilder<'l>

fn clone(&self) -> PlaneMeshBuilder<'l>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'l> Debug for PlaneMeshBuilder<'l>

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

Formats the value using the given formatter.