Struct bevy_render::mesh::primitives::TorusMeshBuilder

pub struct TorusMeshBuilder {
    pub torus: Torus,
    pub minor_resolution: usize,
    pub major_resolution: usize,
    pub angle_range: RangeInclusive<f32>,
}

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

Fields

torus: Torus

The Torus shape.

minor_resolution: usize

The number of vertices used for each circular segment in the ring or tube of the torus.

The default is 24.

major_resolution: usize

The number of segments used for the main ring of the torus.

A resolution of 4 would make the torus appear rectangular, while a resolution of 32 resembles a circular ring.

The default is 32.

angle_range: RangeInclusive<f32>

Optional angle range in radians, defaults to a full circle (0.0..=2 * PI)

Implementations

impl TorusMeshBuilder

pub fn new(inner_radius: f32, outer_radius: f32) -> Self

Creates a new TorusMeshBuilder from an inner and outer radius.

The inner radius is the radius of the hole, and the outer radius is the radius of the entire object.

pub const fn minor_resolution(self, resolution: usize) -> Self

Sets the number of vertices used for each circular segment in the ring or tube of the torus.

pub const fn major_resolution(self, resolution: usize) -> Self

Sets the number of segments used for the main ring of the torus.

A resolution of 4 would make the torus appear rectangular, while a resolution of 32 resembles a circular ring.

pub const fn angle_range(self, range: RangeInclusive<f32>) -> Self

Sets a custom angle range in radians instead of a full circle

Trait Implementations

impl Clone for TorusMeshBuilder

fn clone(&self) -> TorusMeshBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TorusMeshBuilder

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

Formats the value using the given formatter.

impl Default for TorusMeshBuilder

fn default() -> Self

Returns the “default value” for a type.

impl MeshBuilder for TorusMeshBuilder

fn build(&self) -> Mesh

Builds a Mesh based on the configuration in self.