Struct bevy_render::mesh::primitives::PlaneMeshBuilder

pub struct PlaneMeshBuilder {
    pub plane: Plane3d,
    pub subdivisions: u32,
}

A builder used for creating a Mesh with a Plane3d shape.

Fields

plane: Plane3d

The Plane3d shape.

subdivisions: u32

The number of subdivisions in the mesh.

0 - is the original plane geometry, the 4 points in the XZ plane.

1 - is split by 1 line in the middle of the plane on both the X axis and the Z axis, resulting in a plane with 4 quads / 8 triangles.

2 - is a plane split by 2 lines on both the X and Z axes, subdividing the plane into 3 equal sections along each axis, resulting in a plane with 9 quads / 18 triangles.

and so on…

Implementations

impl PlaneMeshBuilder

pub fn new(normal: Dir3, size: Vec2) -> Self

Creates a new PlaneMeshBuilder from a given normal and size.

pub fn from_size(size: Vec2) -> Self

Creates a new PlaneMeshBuilder from the given size, with the normal pointing upwards.

pub fn from_length(length: f32) -> Self

Creates a new PlaneMeshBuilder from the given length, with the normal pointing upwards, and the resulting PlaneMeshBuilder being a square.

pub fn normal(self, normal: Dir3) -> Self

Sets the normal of the plane, aka the direction the plane is facing.

pub fn size(self, width: f32, height: f32) -> Self

Sets the size of the plane mesh.

pub fn subdivisions(self, subdivisions: u32) -> Self

Sets the subdivisions of the plane mesh.

0 - is the original plane geometry, the 4 points in the XZ plane.

1 - is split by 1 line in the middle of the plane on both the X axis and the Z axis, resulting in a plane with 4 quads / 8 triangles.

2 - is a plane split by 2 lines on both the X and Z axes, subdividing the plane into 3 equal sections along each axis, resulting in a plane with 9 quads / 18 triangles.

Trait Implementations

impl Clone for PlaneMeshBuilder

fn clone(&self) -> PlaneMeshBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaneMeshBuilder

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

Formats the value using the given formatter.

impl Default for PlaneMeshBuilder

fn default() -> PlaneMeshBuilder

Returns the “default value” for a type.

impl MeshBuilder for PlaneMeshBuilder

fn build(&self) -> Mesh

Builds a Mesh based on the configuration in self.

impl Copy for PlaneMeshBuilder