Allow for geo-3d integration – Part 1: Refactor and Document

[TimTheBig]

This is part 1 of #36, it will:

• Document all modules and structs.
• Move main.rs to examples/, split for maximum usefulness. And the example shape functions to a mod behind a the shapes feature.
• Move shapes in readme to separate file
• Add error types and handling

[timschmidt]

Do you have Discord, Signal, IRC, or some other way to chat interactively? I'd like to discuss some of this.

[TimTheBig]

Do you have Discord, Signal, IRC, or some other way to chat interactively? I'd like to discuss some of this.

Signal not sure how to share it privately

[timschmidt]

my email is timschmidt at gmail. You can send it there.

[TimTheBig]

Remaining tasks:

• Document the rest of the data-structures and modules
• Move the rest of the examples
• Cleanup readme, moving some info to other files
• Make offset also act on projected 3d polygons

[timschmidt]

@timschmidt did you get the email I sent?

not yet

[TimTheBig]

I sent it to the wrong email, you should have it now

[timschmidt]

Received. Message sent.

[TimTheBig]

This ready the remaining tasks will be addressed in a future pr, please release a new version after this pr is merged.

[TimTheBig]

I will fix conflicts tomorrow

[timschmidt]

Please replace with csgrs-generated graphic or remove.

[timschmidt]

Please replace with csgrs-generated graphic or remove.

[timschmidt]

Please replace with csgrs-generated graphic or remove.

[TimTheBig]

I will leave it out for now, same for all above

[recurseml]

Review by RecurseML

🔍 Review performed on 85f0871..3dbadc3

Severity	Location	Issue	Delete
	src/shapes2d.rs:472	Inconsistent type conversion pattern

✅ Files analyzed, no issues (45)

• .gitignore
• Cargo.lock
• Cargo.toml
• docs/convex_hull.svg
• examples/basic2d_shapes_and_offsetting.rs
• examples/basic_shapes.rs
• examples/boolean_operations.rs
• examples/convex_hull.rs
• examples/extrude.rs
• examples/mass_properties.rs
• examples/metaballs.rs
• examples/metadata.rs
• examples/minkowski_sum.rs
• examples/polyhedron.rs
• examples/ray_intersection.rs
• examples/renormalize.rs
• examples/sdf.rs
• examples/subdivide_triangles.rs
• examples/text.rs
• examples/transformations.rs
• readme.md
• shapes.md
• src/bsp.rs
• src/convex_hull.rs
• src/csg.rs
• src/csg_io.rs
• src/errors.rs
• src/extrudes.rs
• src/flatten_slice.rs
• src/float_types.rs
• src/hershey.rs
• src/io/image.rs
• src/io/mod.rs
• src/io/svg.rs
• src/lib.rs
• src/main.rs
• src/metaballs.rs
• src/offset.rs
• src/plane.rs
• src/polygon.rs
• src/sdf.rs
• src/shapes3d.rs
• src/tests.rs
• src/truetype.rs
• typos.toml

[recurseml]

Inconsistent conversion pattern. On line 471, arc_segments_per_side is converted to usize via Into::<usize>::into(arc_segments_per_side), but on line 472, it uses .into(). While both work, this inconsistency suggests potential confusion about the type handling. More importantly, the loop range should use arc_segments_per_side.get() for clarity and to avoid unnecessary trait resolution.

---

React with 👍 to tell me that this comment was useful, or 👎 if not (and I'll stop posting more comments like this in the future)