Merge pull request #38 from GazzolaLab/feat/frame-for-loop

[Feat] frame for loop

Author: hanson-hschang

examples/br2/callbacks.py

@@ -142,9 +142,9 @@ def update_states(
         )
 
     def set_keyframe(self, keyframe: int) -> None:
-        self.bending_actuation.set_keyframe(keyframe)
-        self.rotation_CW_actuation.set_keyframe(keyframe)
-        self.rotation_CCW_actuation.set_keyframe(keyframe)
+        self.bending_actuation.update_keyframe(keyframe)
+        self.rotation_CW_actuation.update_keyframe(keyframe)
+        self.rotation_CCW_actuation.update_keyframe(keyframe)
 
 
 class BlenderBR2CallBack(BasicCallBackBaseClass):

examples/camera_movement.py

@@ -12,33 +12,40 @@ def main(
     camera_orbiting_radius: float = 1.0,
 ):
 
-    # Create a new scene
+    # Clear all mesh objects in the new scene
     bsr.clear_mesh_objects()
 
     # Set the camera film background to transparent
     bsr.camera.set_film_transparent()
 
+    # Set the render file path
+    bsr.camera.set_file_path(filename + "/frame")
+
+    # Set resolution
+    bsr.camera.set_resolution(1920, 1080)
+
     # Set the camera look at location
     bsr.camera.look_at = np.array([0.0, 0.0, 0.0])
 
-    # Set a frame at the origin
+    # Set a pose at the origin
     _ = Pose(
         positions=np.zeros(3),
         directors=np.identity(3),
         unit_length=0.25,
     )
 
-    # Set the current frame number
-    bsr.frame_manager.frame_current = 0
-
-    # Set the initial keyframe number
-    bsr.frame_manager.set_frame_start()
-
-    # Set the camera orbiting keyframes
+    # Set the camera orbiting angles
     angles = np.linspace(
         0.0, 360.0, int(frame_rate * total_time), endpoint=False
     )
-    for k, angle in enumerate(angles):
+
+    # Set the initial frame
+    frame_start = 0
+    bsr.frame_manager.frame_start = frame_start
+
+    for frame_current, angle in bsr.frame_manager.enumerate(
+        angles, frame_current_init=frame_start
+    ):
 
         # Set the camera location
         bsr.camera.location = np.array(
@@ -49,35 +56,22 @@ def main(
             ]
         )
 
-        # Update the keyframe
-        bsr.camera.set_keyframe(bsr.frame_manager.frame_current)
-
-        if k != len(angles) - 1:
-            # Update the keyframe number
-            bsr.frame_manager.update()
-        else:
-            # Set the final keyframe number
-            bsr.frame_manager.set_frame_end()
+        # Set and update the camera in current frame
+        bsr.camera.update_keyframe(frame_current)
 
     # Set the frame rate
-    bsr.frame_manager.set_frame_rate(fps=frame_rate)
+    bsr.frame_manager.frame_rate = frame_rate
 
     # Set the view distance
     bsr.set_view_distance(distance=5)
 
-    # Deslect all objects
+    # Deselect all objects
     bsr.deselect_all()
 
     # Select the camera object
     bsr.camera.select()
 
-    # Set the render file path
-    bsr.camera.set_file_path("render/" + filename)
-
-    # set resolution
-    bsr.camera.set_resolution(1920, 1080)
-
-    # render the scene
+    # Render the scene
     bsr.camera.render(
         frames=np.arange(
             bsr.frame_manager.frame_start, bsr.frame_manager.frame_end + 1
@@ -90,4 +84,7 @@ def main(
 
 if __name__ == "__main__":
     main()
-    # ffmpeg -threads 8 -r 60 -i render/camera_movement_%03d.png -b:v 90M -c:v prores -pix_fmt yuva444p10le camera_movement.mov
+    print("\n\nTo convert the frames into a video, run the following command:")
+    print(
+        r"ffmpeg -threads 8 -r 60 -i camera_movement/frame_%03d.png -b:v 90M -c:v prores -pix_fmt yuva444p10le camera_movement.mov"
+    )

examples/pose_demo.py

@@ -48,67 +48,61 @@ def angle_to_color(angle: float) -> np.ndarray:
     return np.array([r, g, b, 1.0])
 
 
-def main(filename: str = "pose_demo"):
+def main(
+    filename: str = "pose_demo",
+    frame_rate: int = 60,
+    total_time: float = 5.0,
+):
 
-    # initial values for frame rate and total time
-    frame_rate = 60
-    total_time = 5
-
-    # calculates total number of frames in the visualization
-    total_frames = frame_rate * total_time
-
-    # clears all mesh objects
+    # Clear all mesh objects in the new scene
     bsr.clear_mesh_objects()
 
-    # initializes pose instance
-    pose_object = Pose(
+    # Initialize pose instance
+    pose = Pose(
         positions=np.array([1, 0, 0]),
         directors=np.eye(3),
         thickness_ratio=0.1,
     )
 
-    # creates an array of angles from 0 to 360 degrees
-    angles = np.linspace(0, 360, total_frames)
+    # Create an array of angles from 0 to 360 degrees
+    angles = np.linspace(
+        0.0, 360.0, int(frame_rate * total_time), endpoint=False
+    )
 
-    # Set frame start
-    bsr.frame_manager.set_frame_start()
+    # Set the initial frame
+    frame_start = 0
+    bsr.frame_manager.frame_start = frame_start
 
-    # iterates through each angle
-    for angle in angles:
+    for frame_current, angle in bsr.frame_manager.enumerate(
+        angles, frame_current_init=frame_start
+    ):
 
-        # defines path of of motion for positions of pose object
+        # Define path of of motion for positions of pose object
         positions = [np.cos(np.radians(angle)), np.sin(np.radians(angle)), 0.0]
 
-        # defines directors of pose object
+        # Define directors of pose object
         d2 = [-np.sin(np.radians(angle)), np.cos(np.radians(angle)), 0.0]
         d3 = [0, 0, 1]
         d1 = np.cross(d2, d3)
         directors = np.column_stack((d1, d2, d3))
 
-        # updates positions and directors of pose object at each keyframe
-        pose_object.update_states(
+        # Update positions and directors of pose object at each keyframe
+        pose.update_states(
             positions=np.array(positions),
             directors=directors,
         )
 
-        # converts angle to rgb color value at each frame
+        # Convert angle to rgb color value at each frame
         color = angle_to_color(angle)
 
-        # updates pose object's colors
-        pose_object.update_material(color=color)
-
-        # sets and updates keyframes
-        pose_object.set_keyframe(bsr.frame_manager.frame_current)
+        # Update pose object's colors
+        pose.update_material(color=color)
 
-        if bsr.frame_manager.frame_current == total_frames - 1:
-            # Set the final keyframe
-            bsr.frame_manager.set_frame_end()
-        else:
-            # updates frame
-            bsr.frame_manager.update()
+        # Set and update the pose in current frame
+        pose.update_keyframe(frame_current)
 
     # Set the frame rate
-    bsr.frame_manager.set_frame_rate(fps=frame_rate)
+    bsr.frame_manager.frame_rate = frame_rate
 
     # Set the view distance
     bsr.set_view_distance(distance=5)

examples/single_rigid_rod_spring_action.py

@@ -61,7 +61,7 @@ def analytical_solution(t, y0: float, v0: float):
         # update the rod
         keyframe = int(time_index / simulation_ratio) + 1
         rod.update_states(positions=positions, radii=radii)
-        rod.set_keyframe(keyframe)
+        rod.update_keyframe(keyframe)
 
 bsr.save("single_rigid_rod_spring_action.blend")
 

src/bsr/_camera.py

@@ -39,7 +39,7 @@ def select(self) -> None:
         """
         bpy.context.view_layer.objects.active = self._camera
 
-    def set_keyframe(self, keyframe: int) -> None:
+    def update_keyframe(self, keyframe: int) -> None:
         """
         Sets a keyframe at the given frame.
 

src/bsr/_light.py

@@ -46,7 +46,7 @@ def location(self, location: np.ndarray) -> None:
         """
         self._light.location = location
 
-    def set_keyframe(self, keyframe: int) -> None:
+    def update_keyframe(self, keyframe: int) -> None:
         """
         Sets a keyframe at the given frame.