Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-23 13:13:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

Extend docs with more details about animation

Browse source
This commit is contained in:
aviac 2024-08-11 17:09:07 +02:00
parent 6779961982
commit a30e167e97
No known key found for this signature in database
GPG key ID: 644781002BDEA982
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
crates/bevy_gizmos/src/animated/mod.rs
View file

@ -1,4 +1,12 @@
//! A module for the [`AnimatedGizmos`] [`SystemParam`].
//!
//! These are gizmos which render non-static line segments. Instead the segments are moving along
//! the line in a primitive based direction. The rules for the direction of the animation are
//! listed below
//!
//! - lines: from `start` to `end`
// when implemented:
// - primitices: counter clockwise when the primitive's normal is pointing towards the camera
use std::ops::{Deref, DerefMut};
@ -9,7 +17,10 @@ use bevy_time::Time;
use crate::prelude::{DefaultGizmoConfigGroup, GizmoConfigGroup, Gizmos};
/// A [`SystemParam`] for drawing animated gizmos.
/// A [`SystemParam`] for drawing animated gizmos, whose segments cycle along the line in a
/// primitive based direction. The rules for the direction of the animation are listed below
///
/// - lines: from `start` to `end`
///
/// This is essentially a utility wrapper for [`Gizmos`]. For additional information about the
/// [`Gizmos`] themselves, please refer to the linked documentation.