forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more documentation

Browse Source
This commit is contained in:
Lynn Büttgenbach 2025-07-09 02:03:54 +02:00
parent 040ac67651
commit eaa38a8971
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
crates/bevy_gizmos/src/primitives/dim3.rs
View File

@ -18,17 +18,24 @@ const DEFAULT_RESOLUTION: u32 = 5;
const INFINITE_LEN: f32 = 10_000.0; const INFINITE_LEN: f32 = 10_000.0;
/// A trait for rendering 3D geometric primitives (`P`) with [`GizmoBuffer`]. /// A trait for rendering 3D geometric primitives (`P`) with [`GizmoBuffer`].
pub trait GizmoPrimitive3d<Config, Clear> : Primitive3d ///
/// This trait is used internally when calling [`gizmos.primitive_3d`].
///
/// If you want to implement gizmos support for a custom primitive you should
/// implement this trait.
pub trait GizmoPrimitive3d<Config, Clear>: Primitive3d
where where
Config: GizmoConfigGroup, Config: GizmoConfigGroup,
Clear: 'static + Send + Sync Clear: 'static + Send + Sync,
{ {
/// The output of `primitive_3d`. This is a builder to set non-default values. /// The output of `gizmos.primitive_3d` and `self.gizmos`. This is a builder to set non-default values.
type Output<'a> type Output<'a>
where where
Self: 'a; Self: 'a;
/// Renders a 3D primitive with its associated details. /// Renders a 3D primitive with its associated details.
///
/// This is identical to `gizmos.primitive_3d`.
fn gizmos<'a, 'b: 'a>( fn gizmos<'a, 'b: 'a>(
&'a self, &'a self,
gizmos: &'b mut GizmoBuffer<Config, Clear>, gizmos: &'b mut GizmoBuffer<Config, Clear>,
@ -303,11 +310,7 @@ where
let isometry = isometry.into(); let isometry = isometry.into();
gizmos.linestrip( gizmos.linestrip(
self self.vertices.iter().copied().map(|vec3| isometry * vec3),
.vertices
.iter()
.copied()
.map(|vec3| isometry * vec3),
color, color,
); );
} }