Struct PlaneMeshBuilder

Source
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>,
}
Expand description

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

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§

Source§

impl<'l> PlaneMeshBuilder<'l>

Source

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

Setup a new builder using the given layout

Source

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

Source

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

Source

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

Specify a custom rotation for the whole mesh

Source

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

Specify a custom offset for the whole mesh

Source

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

Specify a custom scale factor for the whole mesh

Source

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

Specify custom UV mapping options

Source

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

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

Source

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

Specify insetting option for the hexagonal face

Source

pub fn build(self) -> MeshInfo

Comsumes the builder to return the computed mesh data

Trait Implementations§

Source§

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

Source§

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

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
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'l> Freeze for PlaneMeshBuilder<'l>

§

impl<'l> RefUnwindSafe for PlaneMeshBuilder<'l>

§

impl<'l> Send for PlaneMeshBuilder<'l>

§

impl<'l> Sync for PlaneMeshBuilder<'l>

§

impl<'l> Unpin for PlaneMeshBuilder<'l>

§

impl<'l> UnwindSafe for PlaneMeshBuilder<'l>

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, dest: *mut u8)

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

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

Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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

Source§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,