bevy icon indicating copy to clipboard operation
bevy copied to clipboard

More gizmos builders

Open lynn-lumen opened this issue 1 year ago • 1 comments

Objective

  • Add GizmoBuilders for some primitives as discussed in #13233

Solution

  • gizmos.primitive_2d(CIRCLE) and gizmos.primitive_2d(ELLIPSE) now return Ellipse2dBuilder aswell.
  • gizmos.primitive_3d(SPHERE) and gizmos.sphere() now return the same SphereBuilder.
    • the .circle_segments method on the SphereBuilder that used to be returned by .sphere() is now called .segments
    • the sphere primitive gizmo now matches the gizmos.sphere gizmo
  • gizmos.primitive_2d(ANNULUS) now returns a Annulus2dBuilder allowing the configuration of the segments
  • gizmos cylinders and capsules now have only 1 line per axis, similar to gizmos.sphere

Migration Guide

  • Some gizmos.primitive_nd methods now return some or different builders. You may need to adjust types and match statements

lynn-lumen avatar May 06 '24 13:05 lynn-lumen

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy? It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

github-actions[bot] avatar May 06 '24 14:05 github-actions[bot]

@lynn-lumen once CI is green and merge conflicts are resolved I'll merge this in.

alice-i-cecile avatar Jun 03 '24 12:06 alice-i-cecile