Struct bevy::render::mesh::TorusMeshBuilder

pub struct TorusMeshBuilder {
    pub torus: Torus,
    pub minor_resolution: usize,
    pub major_resolution: usize,
}

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.

Implementations

impl TorusMeshBuilder

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

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) -> TorusMeshBuilder

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) -> TorusMeshBuilder

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 fn build(&self) -> Mesh

Builds a Mesh according to the configuration in self.

Examples found in repository

examples/math/render_primitives.rs (line 524)

fn spawn_primitive_3d(
    mut commands: Commands,
    mut materials: ResMut<Assets<StandardMaterial>>,
    mut meshes: ResMut<Assets<Mesh>>,
) {
    const POSITION: Vec3 = Vec3::new(-LEFT_RIGHT_OFFSET_3D, 0.0, 0.0);
    let material: Handle<StandardMaterial> = materials.add(Color::WHITE);
    let camera_mode = CameraActive::Dim3;
    [
        Some(CUBOID.mesh()),
        Some(SPHERE.mesh().build()),
        None, // ellipse
        None, // triangle
        Some(PLANE_3D.mesh().build()),
        None, // line
        None, // segment
        None, // polyline
        None, // polygon
        None, // regular polygon
        Some(CAPSULE_3D.mesh().build()),
        Some(CYLINDER.mesh().build()),
        None, // cone
        None, // conical frustrum
        Some(TORUS.mesh().build()),
    ]
    .into_iter()
    .zip(PrimitiveSelected::ALL)
    .for_each(|(maybe_mesh, state)| {
        if let Some(mesh) = maybe_mesh {
            commands.spawn((
                MeshDim3,
                PrimitiveData {
                    camera_mode,
                    primitive_state: state,
                },
                PbrBundle {
                    mesh: meshes.add(mesh),
                    material: material.clone(),
                    transform: Transform::from_translation(POSITION),
                    ..Default::default()
                },
            ));
        }
    });
}

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<(), Error>

Formats the value using the given formatter.

impl Default for TorusMeshBuilder

fn default() -> TorusMeshBuilder

Returns the “default value” for a type.

impl From<TorusMeshBuilder> for Mesh

fn from(torus: TorusMeshBuilder) -> Mesh

Converts to this type from the input type.

impl Copy for TorusMeshBuilder