wip: update argument of enumerate from frame_current to frame_current…

…_init to avoid confussion of input argument and yield value

examples/camera_movement.py

@@ -44,7 +44,7 @@ def main(
     bsr.frame_manager.frame_start = frame_start
 
     for frame_current, angle in bsr.frame_manager.enumerate(
-        angles, frame_current=frame_start
+        angles, frame_current_init=frame_start
     ):
 
         # Set the camera location

examples/pose_demo.py

@@ -74,7 +74,7 @@ def main(
     bsr.frame_manager.frame_start = frame_start
 
     for frame_current, angle in bsr.frame_manager.enumerate(
-        angles, frame_current=frame_start
+        angles, frame_current_init=frame_start
     ):
 
         # Define path of of motion for positions of pose object

src/bsr/frame.py

@@ -72,7 +72,7 @@ def frame_start(self, frame: int) -> None:
         """
         assert (
             isinstance(frame, int) and frame >= 0
-        ), "frame must be a positive integer or 0"
+        ), "frame must be a nonnegative integer"
         bpy.context.scene.frame_start = frame
 
     @property
@@ -100,7 +100,7 @@ def frame_end(self, frame: int) -> None:
         """
         assert (
             isinstance(frame, int) and frame >= 0
-        ), "frame must be a positive integer or 0"
+        ), "frame must be a nonnegative integer"
         bpy.context.scene.frame_end = frame
 
     @property
@@ -134,7 +134,7 @@ def frame_rate(self, fps: int | float) -> None:
         bpy.context.scene.render.fps_base = int(fps) / fps
 
     def enumerate(
-        self, iterable: Iterable, frame_current: Optional[int] = None
+        self, iterable: Iterable, frame_current_init: Optional[int] = None
     ) -> Iterable:
         """
         Enumerate through the frames of the scene.
@@ -143,12 +143,15 @@ def enumerate(
         ----------
         iterable : Iterable
             An iterable object to enumerate.
-        frame_current : int, optional
-            The current frame number of the scene. The default is None.
+        frame_current_init : int, optional
+            The initial current frame number of the scene. The default is None.
             If None, the number self.frame_current is used.
         """
-        if frame_current is not None:
-            self.frame_current = frame_current
+        if frame_current_init is not None:
+            assert (
+                isinstance(frame_current_init, int) and frame_current_init >= 0
+            ), "frame_current_init must be a nonnegative integer"
+            self.frame_current = frame_current_init
         for item in iterable:
             yield self.frame_current, item
             self.update()  # Update the frame number

tests/test_frame.py

@@ -76,7 +76,7 @@ def test_frame_manager_enumerate(self):
         frame_manager = FrameManager()
         frame_start = 10
         for frame_current, frame in frame_manager.enumerate(
-            range(5), frame_current=frame_start
+            range(5), frame_current_init=frame_start
         ):
             assert frame_current == (frame + frame_start)
             assert frame_manager.frame_current == frame_current