Tracking Issue: Primitive Shapes #10572

Jondolf · 2023-11-15T21:26:07Z

# Add and implement constructors for Primitives - Adds more Primitive types and adds a constructor for almost all of them - Works towards finishing #10572 ## Solution - Created new primitives - Torus - Conical Frustum - Cone - Ellipse - Implemented constructors (`Primitive::new`) for almost every single other primitive. --------- Co-authored-by: Joona Aalto <[email protected]> Co-authored-by: Alice Cecile <[email protected]>

…10856) # Objective A better alternative version of #10843. Currently, Bevy has a single `Ray` struct for 3D. To allow better interoperability with Bevy's primitive shapes (#10572) and some third party crates (that handle e.g. spatial queries), it would be very useful to have separate versions for 2D and 3D respectively. ## Solution Separate `Ray` into `Ray2d` and `Ray3d`. These new structs also take advantage of the new primitives by using `Direction2d`/`Direction3d` for the direction: ```rust pub struct Ray2d { pub origin: Vec2, pub direction: Direction2d, } pub struct Ray3d { pub origin: Vec3, pub direction: Direction3d, } ``` and by using `Plane2d`/`Plane3d` in `intersect_plane`: ```rust impl Ray2d { // ... pub fn intersect_plane(&self, plane_origin: Vec2, plane: Plane2d) -> Option<f32> { // ... } } ``` --- ## Changelog ### Added - `Ray2d` and `Ray3d` - `Ray2d::new` and `Ray3d::new` constructors - `Plane2d::new` and `Plane3d::new` constructors ### Removed - Removed `Ray` in favor of `Ray3d` ### Changed - `direction` is now a `Direction2d`/`Direction3d` instead of a vector, which provides guaranteed normalization - `intersect_plane` now takes a `Plane2d`/`Plane3d` instead of just a vector for the plane normal - `Direction2d` and `Direction3d` now derive `Serialize` and `Deserialize` to preserve ray (de)serialization ## Migration Guide `Ray` has been renamed to `Ray3d`. ### Ray creation Before: ```rust Ray { origin: Vec3::ZERO, direction: Vec3::new(0.5, 0.6, 0.2).normalize(), } ``` After: ```rust // Option 1: Ray3d { origin: Vec3::ZERO, direction: Direction3d::new(Vec3::new(0.5, 0.6, 0.2)).unwrap(), } // Option 2: Ray3d::new(Vec3::ZERO, Vec3::new(0.5, 0.6, 0.2)) ``` ### Plane intersections Before: ```rust let result = ray.intersect_plane(Vec2::X, Vec2::Y); ``` After: ```rust let result = ray.intersect_plane(Vec2::X, Plane2d::new(Vec2::Y)); ```

# Add and implement constructors for Primitives - Adds more Primitive types and adds a constructor for almost all of them - Works towards finishing bevyengine#10572 ## Solution - Created new primitives - Torus - Conical Frustum - Cone - Ellipse - Implemented constructors (`Primitive::new`) for almost every single other primitive. --------- Co-authored-by: Joona Aalto <[email protected]> Co-authored-by: Alice Cecile <[email protected]>

# Objective Working towards finishing a part of #10572, this PR adds a ton of math helpers and useful constructors for primitive shapes. I also tried fixing some naming inconsistencies. ## Solution - Add mathematical helpers like `area`, `volume`, `perimeter`, `RegularPolygon::inradius` and so on, trying to cover all core mathematical properties of each shape - Add some constructors like `Rectangle::from_corners`, `Cuboid::from_corners` and `Plane3d::from_points` I also derived `PartialEq` for the shapes where it's trivial. Primitives like `Line2d` and `Segment2d` are not trivial because you could argue that they would be equal if they had an opposite direction. All mathematical methods have tests with reference values computed by hand or with external tools. ## Todo - [x] Add tests to verify that the values from mathematical helpers are correct --------- Co-authored-by: IQuick 143 <[email protected]>

…ne#10632) # Objective Working towards finishing a part of bevyengine#10572, this PR adds a ton of math helpers and useful constructors for primitive shapes. I also tried fixing some naming inconsistencies. ## Solution - Add mathematical helpers like `area`, `volume`, `perimeter`, `RegularPolygon::inradius` and so on, trying to cover all core mathematical properties of each shape - Add some constructors like `Rectangle::from_corners`, `Cuboid::from_corners` and `Plane3d::from_points` I also derived `PartialEq` for the shapes where it's trivial. Primitives like `Line2d` and `Segment2d` are not trivial because you could argue that they would be equal if they had an opposite direction. All mathematical methods have tests with reference values computed by hand or with external tools. ## Todo - [x] Add tests to verify that the values from mathematical helpers are correct --------- Co-authored-by: IQuick 143 <[email protected]>

rparrett · 2024-03-01T23:00:05Z

Is this tracking issue still being utilized?

Can we add any of

Note that some shapes have behavior that can't be exactly reproduced with the new primitives yet:

Box is more of an AABB with min/max extents

Plane supports a subdivision count

Quad has a flipped property (also tracked in Rectangle missing flip use case from deprecated shape Quad #11996)

From #11773 to the list, if still applicable? Plane subdivision, specifically was a hot topic in Discord recently.

Jondolf · 2024-03-02T10:26:49Z

I added the plane subdivision count to the list. The other two aren't as applicable in my opinion; we have AABB types and don't need a Box with min/max extents, and the rectangle flipping is perhaps more of a documentation issue than a separate property that we'd need for the mesh.

# Objective - #10572 There is no 2D primitive available for the common shape of an annulus (ring). ## Solution This PR introduces a new type to the existing math primitives: - `Annulus`: the region between two concentric circles --- ## Changelog ### Added - `Annulus` primitive to the `bevy_math` crate - `Annulus` tests (`diameter`, `thickness`, `area`, `perimeter` and `closest_point` methods) --------- Co-authored-by: Joona Aalto <[email protected]>

bugsweeper · 2024-03-28T10:28:55Z

Support subdivision for the Plane3d mesh

I think subdivision param for Meshable trait (maybe optional, or maybe in different MeshableExt trait) would be rich feature. It nice to provide not only for Plane3d

# Objective - #10572 There is no 3D primitive available for the common shape of a tetrahedron (3-simplex). ## Solution This PR introduces a new type to the existing math primitives: - `Tetrahedron`: a polyhedron composed of four triangular faces, six straight edges, and four vertices --- ## Changelog ### Added - `Tetrahedron` primitive to the `bevy_math` crate - `Tetrahedron` tests (`area`, `volume` methods) - `impl_reflect!` declaration for `Tetrahedron` in the `bevy_reflect` crate

# Objective Related to #10572 Allow the `Annulus` primitive to be meshed. ## Solution We introduce a `Meshable` structure, `AnnulusMeshBuilder`, which allows the `Annulus` primitive to be meshed, leaving optional configuration of the number of angular sudivisions to the user. Here is a picture of the annulus's UV-mapping: <img width="1440" alt="Screenshot 2024-03-26 at 10 39 48 AM" src="https://github.com/bevyengine/bevy/assets/2975848/b170291d-cba7-441b-90ee-2ad6841eaedb"> Other features are essentially identical to the implementations for `Circle`/`Ellipse`. --- ## Changelog - Introduced `AnnulusMeshBuilder` - Implemented `Meshable` for `Annulus` with `Output = AnnulusMeshBuilder` - Implemented `From<Annulus>` and `From<AnnulusMeshBuilder>` for `Mesh` - Added `impl_reflect!` declaration for `Annulus` and `Triangle3d` in `bevy_reflect` --- ## Discussion ### Design considerations The only interesting wrinkle here is that the existing UV-mapping of `Ellipse` (and hence of `Circle` and `RegularPolygon`) is non-radial (it's skew-free, created by situating the mesh in a bounding rectangle), so the UV-mapping of `Annulus` doesn't limit to that of `Circle` as its inner radius tends to zero, for instance. I don't see this as a real issue for `Annulus`, which should almost certainly have this kind of UV-mapping, but I think we ought to at least consider allowing mesh configuration for `Circle`/`Ellipse` that performs radial UV-mapping instead. (In these cases in particular, it would be especially easy, since we wouldn't need a different parameter set in the builder.) --------- Co-authored-by: Alice Cecile <[email protected]>

) # Objective - bevyengine#10572 There is no 3D primitive available for the common shape of a tetrahedron (3-simplex). ## Solution This PR introduces a new type to the existing math primitives: - `Tetrahedron`: a polyhedron composed of four triangular faces, six straight edges, and four vertices --- ## Changelog ### Added - `Tetrahedron` primitive to the `bevy_math` crate - `Tetrahedron` tests (`area`, `volume` methods) - `impl_reflect!` declaration for `Tetrahedron` in the `bevy_reflect` crate

# Objective Related to bevyengine#10572 Allow the `Annulus` primitive to be meshed. ## Solution We introduce a `Meshable` structure, `AnnulusMeshBuilder`, which allows the `Annulus` primitive to be meshed, leaving optional configuration of the number of angular sudivisions to the user. Here is a picture of the annulus's UV-mapping: <img width="1440" alt="Screenshot 2024-03-26 at 10 39 48 AM" src="https://github.com/bevyengine/bevy/assets/2975848/b170291d-cba7-441b-90ee-2ad6841eaedb"> Other features are essentially identical to the implementations for `Circle`/`Ellipse`. --- ## Changelog - Introduced `AnnulusMeshBuilder` - Implemented `Meshable` for `Annulus` with `Output = AnnulusMeshBuilder` - Implemented `From<Annulus>` and `From<AnnulusMeshBuilder>` for `Mesh` - Added `impl_reflect!` declaration for `Annulus` and `Triangle3d` in `bevy_reflect` --- ## Discussion ### Design considerations The only interesting wrinkle here is that the existing UV-mapping of `Ellipse` (and hence of `Circle` and `RegularPolygon`) is non-radial (it's skew-free, created by situating the mesh in a bounding rectangle), so the UV-mapping of `Annulus` doesn't limit to that of `Circle` as its inner radius tends to zero, for instance. I don't see this as a real issue for `Annulus`, which should almost certainly have this kind of UV-mapping, but I think we ought to at least consider allowing mesh configuration for `Circle`/`Ellipse` that performs radial UV-mapping instead. (In these cases in particular, it would be especially easy, since we wouldn't need a different parameter set in the builder.) --------- Co-authored-by: Alice Cecile <[email protected]>

# Objective - Ongoing work for #10572 - Implement the `Meshable` trait for `Triangle3d`, allowing 3d triangle primitives to produce meshes. ## Solution The `Meshable` trait for `Triangle3d` directly produces a `Mesh`, much like that of `Triangle2d`. The mesh consists only of a single triangle (the triangle itself), and its vertex data consists of: - Vertex positions, which are the triangle's vertices themselves (i.e. the triangle provides its own coordinates in mesh space directly) - Normals, which are all the normal of the triangle itself - Indices, which are directly inferred from the vertex order (note that this is slightly different than `Triangle2d` which, because of its lower dimension, has an orientation which can be corrected for so that it always faces "the right way") - UV coordinates, which are produced as follows: 1. The first coordinate is coincident with the `ab` direction of the triangle. 2. The second coordinate maps to be perpendicular to the first in mesh space, so that the UV-mapping is skew-free. 3. The UV-coordinates map to the smallest rectangle possible containing the triangle, given the preceding constraints. Here is a visual demonstration; here, the `ab` direction of the triangle is horizontal, left to right — the point `c` moves, expanding the bounding rectangle of the triangle when it pushes past `a` or `b`: <img width="1440" alt="Screenshot 2024-03-23 at 5 36 01 PM" src="https://github.com/bevyengine/bevy/assets/2975848/bef4d786-7b82-4207-abd4-ac4557d0f8b8"> <img width="1440" alt="Screenshot 2024-03-23 at 5 38 12 PM" src="https://github.com/bevyengine/bevy/assets/2975848/c0f72b8f-8e70-46fa-a750-2041ba6dfb78"> <img width="1440" alt="Screenshot 2024-03-23 at 5 37 15 PM" src="https://github.com/bevyengine/bevy/assets/2975848/db287e4f-2b0b-4fd4-8d71-88f4e7a03b7c"> The UV-mapping of `Triangle2d` has also been changed to use the same logic. --- ## Changelog - Implemented `Meshable` for `Triangle3d`. - Changed UV-mapping of `Triangle2d` to match that of `Triangle3d`. ## Migration Guide The UV-mapping of `Triangle2d` has changed with this PR; the main difference is that the UVs are no longer dependent on the triangle's absolute coordinates, but instead follow translations of the triangle itself in its definition. If you depended on the old UV-coordinates for `Triangle2d`, then you will have to update affected areas to use the new ones which, briefly, can be described as follows: - The first coordinate is parallel to the line between the first two vertices of the triangle. - The second coordinate is orthogonal to this, pointing in the direction of the third point. Generally speaking, this means that the first two points will have coordinates `[_, 0.]`, while the third coordinate will be `[_, 1.]`, with the exact values depending on the position of the third point relative to the first two. For acute triangles, the first two vertices always have UV-coordinates `[0., 0.]` and `[1., 0.]` respectively. For obtuse triangles, the third point will have coordinate `[0., 1.]` or `[1., 1.]`, with the coordinate of one of the two other points shifting to maintain proportionality. For example: - The default `Triangle2d` has UV-coordinates `[0., 0.]`, `[0., 1.]`, [`0.5, 1.]`. - The triangle with vertices `vec2(0., 0.)`, `vec2(1., 0.)`, `vec2(2., 1.)` has UV-coordinates `[0., 0.]`, `[0.5, 0.]`, `[1., 1.]`. - The triangle with vertices `vec2(0., 0.)`, `vec2(1., 0.)`, `vec2(-2., 1.)` has UV-coordinates `[2./3., 0.]`, `[1., 0.]`, `[0., 1.]`. ## Discussion ### Design considerations 1. There are a number of ways to UV-map a triangle (at least two of which are fairly natural); for instance, we could instead declare the second axis to be essentially `bc` so that the vertices are always `[0., 0.]`, `[0., 1.]`, and `[1., 0.]`. I chose this method instead because it is skew-free, so that the sampling from textures has only bilinear scaling. I think this is better for cases where a relatively "uniform" texture is mapped to the triangle, but it's possible that we might want to support the other thing in the future. Thankfully, we already have the capability of easily expanding to do that with Builders if the need arises. This could also allow us to provide things like barycentric subdivision. 2. Presently, the mesh-creation code for `Triangle3d` is set up to never fail, even in the case that the triangle is degenerate. I have mixed feelings about this, but none of our other primitive meshes fail, so I decided to take the same approach. Maybe this is something that could be worth revisiting in the future across the board. --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: Jakub Marcowski <[email protected]>

lynn-lumen · 2024-05-03T15:55:16Z

I don't understand what is meant by

Prism

Considering there already is

support converting 2D shapes to 3D shapes (i.e. extrude circle to get cylinder and so on)

which would basically produce a bunch of prisms. In addition, Ramps already cover (at least some) triangular prisms

# Objective - Adds a basic `Extrusion<T: Primitive2d>` shape, suggestion of #10572 ## Solution - Adds `Measured2d` and `Measured3d` traits for getting the perimeter/area or area/volume of shapes. This allows implementing `.volume()` and `.area()` for all extrusions `Extrusion<T: Primitive2d + Measured2d>` within `bevy_math` - All existing perimeter, area and volume implementations for primitves have been moved into implementations of `Measured2d` and `Measured3d` - Shapes should be extruded along the Z-axis since an extrusion of depth `0.` should be equivalent in everything but name to the base shape ## Caviats - I am not sure about the naming. `Extrusion<T>` could also be `Prism<T>` and the `MeasuredNd` could also be something like `MeasuredPrimitiveNd`. If you have any other suggestions, please fell free to share them :) ## Future work This PR adds a basic `Extrusion` shape and does not implement a lot of things you might want it to. Some of the future possibilities include: - [ ] bounding for extrusions - [ ] making extrusions work with gizmos - [ ] meshing --------- Co-authored-by: Alice Cecile <[email protected]>

bugsweeper · 2024-06-11T08:12:21Z

Support subdivisions

Looks like #13719 and #13580 both relates to subdivisions

bytemunch · 2024-06-29T16:16:30Z

I've got a naive ellipsoid implementation working but it produces meshes identical to a scaled UV sphere, as it uses the sphere UV code with sectors and stacks, substituting variables for a, b, and c where relevant. Is this desirable behaviour or should we strive for a better ellipsoid meshing function?

2024-06-29_164446.mp4

Scaled spheres in the back, ellipsoids in the front

Also the area calculation uses the approximate formula which could be a problem, the maths for integrating everything and getting a closer answer is too much for my brain 🤯

rparrett · 2024-12-10T14:53:40Z

Any plans for an "annular segment" / should that be added to the list?

RobWalt · 2025-02-02T09:33:39Z

Any plans for an "annular segment" / should that be added to the list?

Sounds good to me. Shouldn't be too diffivult either. I'll glady help with PRs regarding that!

Maybe open a separate issue and link to that one here if you have a need for it!

Jondolf added C-Feature A new feature, making something new possible S-Needs-Triage This issue needs to be labelled labels Nov 15, 2023

Aztro-dev mentioned this issue Nov 16, 2023

Add and impl Primitives #10580

Merged

nicopap added C-Tracking-Issue An issue that collects information about a broad development initiative A-Rendering Drawing game state to the screen and removed S-Needs-Triage This issue needs to be labelled labels Nov 16, 2023

Jondolf mentioned this issue Nov 18, 2023

Add more constructors and math helpers for primitive shapes #10632

Merged

1 task

Jondolf added the A-Math Fundamental domain-agnostic mathematical operations label Nov 19, 2023

Jondolf mentioned this issue Nov 20, 2023

serde Serialize and Deserialise on shape types #10626

Closed

This was referenced Dec 2, 2023

Add Ray2d and Ray3d primitives #10843

Closed

Split Ray into Ray2d and Ray3d and simplify plane construction #10856

Merged

This was referenced Dec 17, 2023

Mesh creation from primitive shapes #11007

Closed

Define a basic set of Primitives #10466

Merged

mweatherley mentioned this issue Mar 24, 2024

Meshing for Triangle3d primitive #12686

Merged

This was referenced Mar 24, 2024

Add Tetrahedron primitive to bevy_math::primitives #12688

Merged

Add Annulus primitive to bevy_math::primitives #12706

Merged

mweatherley mentioned this issue Mar 26, 2024

Meshing for Annulus primitive #12734

Merged

lynn-lumen mentioned this issue Apr 18, 2024

Add ramp primitive #11790

Closed

EmiOnGit mentioned this issue May 6, 2024

PlaneMeshBuilder should include a configurable amount of subdivision for the mesh #13258

Closed

lynn-lumen mentioned this issue May 7, 2024

Extrusion #13270

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracking Issue: Primitive Shapes #10572

Tracking Issue: Primitive Shapes #10572

Jondolf commented Nov 15, 2023 •

edited

Loading

rparrett commented Mar 1, 2024

Jondolf commented Mar 2, 2024

bugsweeper commented Mar 28, 2024 •

edited

Loading

lynn-lumen commented May 3, 2024

bugsweeper commented Jun 11, 2024 •

edited

Loading

bytemunch commented Jun 29, 2024 •

edited

Loading

rparrett commented Dec 10, 2024

RobWalt commented Feb 2, 2025 •

edited

Loading

Tracking Issue: Primitive Shapes #10572

Tracking Issue: Primitive Shapes #10572

Comments

Jondolf commented Nov 15, 2023 • edited Loading

Meshing #10569

Gizmos #10571

Bounding volumes #10570

List of primitives

Remove bounding volumes from bevy_render

Misc

Long-term possibilities

rparrett commented Mar 1, 2024

Jondolf commented Mar 2, 2024

bugsweeper commented Mar 28, 2024 • edited Loading

lynn-lumen commented May 3, 2024

bugsweeper commented Jun 11, 2024 • edited Loading

bytemunch commented Jun 29, 2024 • edited Loading

rparrett commented Dec 10, 2024

RobWalt commented Feb 2, 2025 • edited Loading

Jondolf commented Nov 15, 2023 •

edited

Loading

Remove bounding volumes from `bevy_render`

bugsweeper commented Mar 28, 2024 •

edited

Loading

bugsweeper commented Jun 11, 2024 •

edited

Loading

bytemunch commented Jun 29, 2024 •

edited

Loading

RobWalt commented Feb 2, 2025 •

edited

Loading