Make some internal types private

Author: merwaaan

src/animator.rs

@@ -1,4 +1,4 @@
-pub mod cache;
+pub(crate) mod cache;
 mod iterator;
 
 use std::{collections::HashMap, time::Duration};
@@ -45,7 +45,7 @@ struct AnimationInstance {
 /// The animator is responsible for playing animations as time advances.
 #[derive(Resource, Debug, Default, Reflect)]
 #[reflect(Resource, Debug, Default)]
-pub struct Animator {
+pub(crate) struct Animator {
     /// Instances of animations currently being played.
     /// Each animation instance is associated to an entity with a [SpritesheetAnimation] component.
     animation_instances: HashMap<Entity, AnimationInstance>,
@@ -54,7 +54,7 @@ pub struct Animator {
 /// A query data type for the [`Animator::update`] system.
 #[derive(QueryData)]
 #[query_data(mutable, derive(Debug))]
-pub struct SpritesheetAnimationQuery {
+pub(crate) struct SpritesheetAnimationQuery {
     entity: Entity,
     spritesheet_animation: &'static mut SpritesheetAnimation,
     sprite: Option<&'static mut Sprite>,

src/animator/cache.rs

@@ -14,7 +14,7 @@ use crate::{
 /// A pre-computed frame of animation, ready to be played back.
 #[derive(Debug, Clone, Reflect)]
 #[reflect(Debug)]
-pub struct CacheFrame {
+pub(crate) struct CacheFrame {
     pub atlas_index: usize,
     pub duration: Duration,
     pub clip_id: ClipId,
@@ -32,7 +32,7 @@ pub struct CacheFrame {
 ///  - AnimationEnd after the last frame
 #[derive(Debug, Clone, PartialEq, Eq, Hash, Reflect)]
 #[reflect(Debug, PartialEq, Hash)]
-pub enum AnimationCacheEvent {
+pub(crate) enum AnimationCacheEvent {
     MarkerHit {
         marker_id: AnimationMarkerId,
         clip_id: ClipId,
@@ -54,7 +54,7 @@ pub enum AnimationCacheEvent {
 /// The idea is to cache for each frame its atlas index, duration and emitted events
 /// so that playing an animation becomes just a matter of iterating over this cache
 /// without re-evaluating all the animation  parameters.
-pub struct AnimationCache {
+pub(crate) struct AnimationCache {
     /// All the frames
     pub frames: Vec<CacheFrame>,
 

src/animator/iterator.rs

@@ -14,7 +14,7 @@ use crate::{
 /// Same as [CacheFrame] but with `animation_repetition`
 #[derive(Debug, Clone, Reflect)]
 #[reflect(Debug)]
-pub struct IteratorFrame {
+pub(crate) struct IteratorFrame {
     pub atlas_index: usize,
     pub duration: Duration,
     pub clip_id: ClipId,
@@ -28,7 +28,7 @@ pub struct IteratorFrame {
 /// The animation will promote them to regular AnimationEvents and add the information available at its level.
 #[derive(Debug, Clone, PartialEq, Eq, Hash, Reflect)]
 #[reflect(Debug, PartialEq, Hash)]
-pub enum AnimationIteratorEvent {
+pub(crate) enum AnimationIteratorEvent {
     MarkerHit {
         marker_id: AnimationMarkerId,
         animation_repetition: usize,
@@ -52,7 +52,7 @@ pub enum AnimationIteratorEvent {
 /// An iterator that advances an animation frame by frame.
 ///
 /// `next()` will produce frames until the end of the animation.
-pub struct AnimationIterator {
+pub(crate) struct AnimationIterator {
     /// Reference to the animation cache that contains all the frames for one repetition of the animation
     cache: Arc<AnimationCache>,
 

src/lib.rs

@@ -74,7 +74,6 @@
 //! ```
 
 pub mod animation;
-pub mod animator;
 pub mod clip;
 pub mod components;
 pub mod easing;
@@ -83,6 +82,7 @@ pub mod library;
 pub mod plugin;
 pub mod spritesheet;
 
+mod animator;
 mod systems;
 
 pub mod prelude {

src/plugin.rs

@@ -12,11 +12,11 @@ use crate::{
     systems::{sprite3d, spritesheet_animation},
 };
 
-/// Set for systems that update the animation state.
+/// Set for systems that update animations
 #[derive(Debug, PartialEq, Eq, Clone, Hash, SystemSet)]
 pub struct AnimationSystemSet;
 
-/// Set for systems that update the sprite state.
+/// Set for systems that manage 3D sprites
 #[derive(Debug, PartialEq, Eq, Clone, Hash, SystemSet)]
 pub struct Sprite3dSystemSet;