Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add meshing for Cone #11820

Merged
merged 9 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/bevy_math/src/primitives/dim3.rs
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,16 @@ pub struct Cone {
}
impl Primitive3d for Cone {}

impl Default for Cone {
/// Returns the default [`Cone`] with a base radius of `0.5` and a height of `1.0`.
fn default() -> Self {
Self {
radius: 0.5,
height: 1.0,
}
}
}

impl Cone {
/// Get the base of the cone as a [`Circle`]
#[inline(always)]
Expand Down
138 changes: 138 additions & 0 deletions crates/bevy_render/src/mesh/primitives/dim3/cone.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
use bevy_math::primitives::Cone;
use wgpu::PrimitiveTopology;

use crate::{
mesh::{Indices, Mesh, Meshable},
render_asset::RenderAssetUsages,
};

/// A builder used for creating a [`Mesh`] with a [`Cone`] shape.
#[derive(Clone, Copy, Debug)]
pub struct ConeMeshBuilder {
/// The [`Cone`] shape.
pub cone: Cone,
/// The number of vertices used for the base of the cone.
///
/// The default is `32`.
pub resolution: u32,
}

impl Default for ConeMeshBuilder {
fn default() -> Self {
Self {
cone: Cone::default(),
resolution: 32,
}
}
}

impl ConeMeshBuilder {
/// Creates a new [`ConeMeshBuilder`] from a given radius, height,
/// and number of vertices used for the base of the cone.
#[inline]
pub const fn new(radius: f32, height: f32, resolution: u32) -> Self {
Self {
cone: Cone { radius, height },
resolution,
}
}

/// Sets the number of vertices used for the base of the cone.
#[inline]
pub const fn resolution(mut self, resolution: u32) -> Self {
self.resolution = resolution;
self
}

/// Builds a [`Mesh`] based on the configuration in `self`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Diagrams for positions, normals, and UVs would make the math easier to follow.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now I just added better comments explaining the math and logic. I can maybe try making some simple diagrams too if I can make clean ones, but personally I think text is probably enough here.

pub fn build(&self) -> Mesh {
let half_height = self.cone.height / 2.0;

let num_vertices = self.resolution as usize * 2 + 1;
let num_indices = self.resolution as usize * 3;
Jondolf marked this conversation as resolved.
Show resolved Hide resolved

let mut positions = Vec::with_capacity(num_vertices);
let mut normals = Vec::with_capacity(num_vertices);
let mut uvs = Vec::with_capacity(num_vertices);
let mut indices = Vec::with_capacity(num_indices);

// Tip
positions.push([0.0, half_height, 0.0]);

// The tip doesn't have a singular normal that works correctly.
// We use an invalid normal here so that it becomes NaN in the fragment shader
// and doesn't affect the overall shading. This might seem hacky, but it's one of
// the only ways to get perfectly smooth cones without creases or other shading artefacts.
//
// Note that this requires that normals are not normalized in the vertex shader,
// as that would make the entire triangle invalid and make the cone appear as black.
normals.push([0.0, 0.0, 0.0]);

uvs.push([0.5, 0.5]);

// Lateral surface, i.e. the side of the cone
let step_theta = std::f32::consts::TAU / self.resolution as f32;
for segment in 0..=self.resolution {
let theta = segment as f32 * step_theta;
let (sin, cos) = theta.sin_cos();

positions.push([self.cone.radius * cos, -half_height, self.cone.radius * sin]);
normals.push([cos, 0., sin]);
Jondolf marked this conversation as resolved.
Show resolved Hide resolved
uvs.push([0.5 + cos * 0.5, 0.5 + sin * 0.5]);
}

for j in 0..self.resolution {
indices.extend_from_slice(&[0, j + 1, j]);
}

indices.extend(&[0, positions.len() as u32 - 1, positions.len() as u32 - 2]);

// Base
let index_offset = positions.len() as u32;
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved

for i in 0..self.resolution {
let theta = i as f32 * step_theta;
let (sin, cos) = theta.sin_cos();

positions.push([cos * self.cone.radius, -half_height, sin * self.cone.radius]);
normals.push([0.0, -1.0, 0.0]);
uvs.push([0.5 * (cos + 1.0), 1.0 - 0.5 * (sin + 1.0)]);
}

for i in 1..(self.resolution - 1) {
indices.extend_from_slice(&[index_offset, index_offset + i, index_offset + i + 1]);
}

Mesh::new(
PrimitiveTopology::TriangleList,
RenderAssetUsages::default(),
)
.with_inserted_indices(Indices::U32(indices))
.with_inserted_attribute(Mesh::ATTRIBUTE_POSITION, positions)
.with_inserted_attribute(Mesh::ATTRIBUTE_NORMAL, normals)
.with_inserted_attribute(Mesh::ATTRIBUTE_UV_0, uvs)
}
}

impl Meshable for Cone {
type Output = ConeMeshBuilder;

fn mesh(&self) -> Self::Output {
ConeMeshBuilder {
cone: *self,
..Default::default()
}
}
}

impl From<Cone> for Mesh {
fn from(cone: Cone) -> Self {
cone.mesh().build()
}
}

impl From<ConeMeshBuilder> for Mesh {
fn from(cone: ConeMeshBuilder) -> Self {
cone.build()
}
}
2 changes: 2 additions & 0 deletions crates/bevy_render/src/mesh/primitives/dim3/mod.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
mod capsule;
mod cone;
mod cuboid;
mod cylinder;
mod plane;
mod sphere;
mod torus;

pub use capsule::*;
pub use cone::*;
pub use cylinder::*;
pub use plane::*;
pub use sphere::*;
Expand Down
1 change: 1 addition & 0 deletions examples/3d/3d_shapes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ fn setup(
meshes.add(Capsule3d::default()),
meshes.add(Torus::default()),
meshes.add(Cylinder::default()),
meshes.add(Cone::default()),
meshes.add(Sphere::default().mesh().ico(5).unwrap()),
meshes.add(Sphere::default().mesh().uv(32, 18)),
];
Expand Down