Struct RingMeshBuilder 

pub struct RingMeshBuilder<P>
where
    P: Primitive2d + Meshable,
{
    pub outer_shape_builder: <P as Meshable>::Output,
    pub inner_shape_builder: <P as Meshable>::Output,
}

Available on crate feature bevy_render only.

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

Fields

outer_shape_builder: <P as Meshable>::Output

inner_shape_builder: <P as Meshable>::Output

Implementations

impl<P> RingMeshBuilder<P>

where P: Primitive2d + Meshable,

pub fn new(ring: &Ring<P>) -> RingMeshBuilder<P>

Available on crate feature bevy_mesh only.

Create a new RingMeshBuilder<P> from a given Ring<P> shape.

pub fn with_inner( self, func: impl Fn(<P as Meshable>::Output) -> <P as Meshable>::Output, ) -> RingMeshBuilder<P>

Available on crate feature bevy_mesh only.

Apply a function to the inner builders

Examples found in repository

examples/math/custom_primitives.rs (line 192)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    // Spawn the camera
    commands.spawn((Camera3d::default(), TRANSFORM_2D, PROJECTION_2D));

    // Spawn the 2D heart
    commands.spawn((
        // We can use the methods defined on the `MeshBuilder` to customize the mesh.
        Mesh3d(meshes.add(HEART.mesh().resolution(50))),
        MeshMaterial3d(materials.add(StandardMaterial {
            emissive: RED.into(),
            base_color: RED.into(),
            ..Default::default()
        })),
        Transform::from_xyz(0.0, 0.0, 0.0),
        Shape2d,
        Visibility::Visible,
        ShapeActive::Heart,
    ));

    // Spawn the 2D heart ring
    commands.spawn((
        // We can use the methods defined on the `MeshBuilder` to customize the mesh.
        Mesh3d(meshes.add(RING.mesh().with_inner(|heart| heart.resolution(50)))),
        MeshMaterial3d(materials.add(StandardMaterial {
            emissive: RED.into(),
            base_color: RED.into(),
            ..Default::default()
        })),
        Transform::from_xyz(0.0, 0.0, 0.0),
        Shape2d,
        Visibility::Hidden,
        ShapeActive::Ring,
    ));

    // Spawn an extrusion of the heart
    commands.spawn((
        // We can set a custom resolution for the round parts of the extrusion as well.
        Mesh3d(meshes.add(EXTRUSION.mesh().resolution(50))),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.into(),
            ..Default::default()
        })),
        Transform::from_xyz(0., -3., -5.).with_rotation(Quat::from_rotation_x(-PI / 4.)),
        Shape3d,
        Visibility::Hidden,
        ShapeActive::Extrusion,
    ));

    // Spawn an extrusion of the heart ring
    commands.spawn((
        // We can set a custom resolution for the round parts of the extrusion as well.
        Mesh3d(
            meshes.add(
                RING_EXTRUSION
                    .mesh()
                    .with_inner(|ring| ring.with_inner(|heart| heart.resolution(50))),
            ),
        ),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.into(),
            ..Default::default()
        })),
        Transform::from_xyz(0., -3., -5.).with_rotation(Quat::from_rotation_x(-PI / 4.)),
        Shape3d,
        Visibility::Hidden,
        ShapeActive::RingExtrusion,
    ));

    // Point light for 3D
    commands.spawn((
        PointLight {
            shadow_maps_enabled: true,
            intensity: 10_000_000.,
            range: 100.0,
            shadow_depth_bias: 0.2,
            ..default()
        },
        Transform::from_xyz(8.0, 12.0, 1.0),
    ));

    let mut text = "\
        Press 'B' to cycle between no bounding shapes, bounding boxes (AABBs) and bounding spheres / circles\n\
        Press 'Tab' to cycle between 2D and 3D shapes\n\
        Press 'R' to pause/resume rotation".to_string();
    #[cfg(not(target_family = "wasm"))]
    text.push_str("\nPress 'Space' to toggle display of wireframes");
    // Example instructions
    commands.spawn((
        Text::new(text),
        Node {
            position_type: PositionType::Absolute,
            top: px(12),
            left: px(12),
            ..default()
        },
    ));
}

Trait Implementations

impl<P> Extrudable for RingMeshBuilder<P>

where P: Primitive2d + Meshable, <P as Meshable>::Output: Extrudable,

fn perimeter(&self) -> Vec<PerimeterSegment>

A list of the indices each representing a part of the perimeter of the mesh.

Panics

Panics if the following assumptions are not met.

It is assumed that the inner and outer meshes have the same number of vertices. If not, then the MeshBuilder of the underlying 2d primitive has generated a different number of vertices for the inner and outer instances of the primitive.

It is assumed that the primitive_topology of the mesh returned by the underlying builder is PrimitiveTopology::TriangleList and that the mesh has Mesh::ATTRIBUTE_POSITION, Mesh::ATTRIBUTE_NORMAL and Mesh::ATTRIBUTE_UV_0 attributes.

impl<P> MeshBuilder for RingMeshBuilder<P>

where P: Primitive2d + Meshable,

fn build(&self) -> Mesh

Builds a Mesh based on the configuration in self.

Panics

Panics if the following assumptions are not met.

It is assumed that the inner and outer meshes have the same number of vertices. If not, then the MeshBuilder of the underlying 2d primitive has generated a different number of vertices for the inner and outer instances of the primitive.

It is assumed that the primitive_topology of the mesh returned by the underlying builder is PrimitiveTopology::TriangleList and that the mesh has Mesh::ATTRIBUTE_POSITION, Mesh::ATTRIBUTE_NORMAL and Mesh::ATTRIBUTE_UV_0 attributes.