Refactor: remove simulation UI display calls from environment classes

[ll7]

Remove unnecessary simulation UI display calls from environment classes to streamline the code and improve performance.

Fixes #91

Summary by CodeRabbit

Release Notes

• New Features

  • Updated reset method in PedestrianEnv and RobotEnv to return additional information alongside the initial observation.

• Changes

  • Removed automatic display of the simulation UI in EmptyRobotEnv, PedestrianEnv, and RobotEnv, requiring users to invoke rendering explicitly.

• Bug Fixes

  • Clarified handling of the truncated variable in the PedestrianEnv class.

These changes enhance control over the simulation environment and improve the clarity of method outputs.

[coderabbitai]

Walkthrough

The changes involve modifications to the EmptyRobotEnv, PedestrianEnv, and RobotEnv classes, primarily focusing on the removal of automatic simulation UI displays during initialization. The reset methods in PedestrianEnv and RobotEnv have been updated to return additional information, while the visualize_states function in playback_recording.py has had its UI display call removed. These alterations streamline the initialization process and adjust the return structures of specific methods, maintaining core functionality.

Changes

File Path	Change Summary
robot_sf/gym_env/empty_robot_env.py	Removed automatic UI display in EmptyRobotEnv constructor.
robot_sf/gym_env/pedestrian_env.py	Commented out UI display in PedestrianEnv, updated reset method to return a dictionary.
robot_sf/gym_env/robot_env.py	Removed UI display in RobotEnv constructor, updated reset method to include an info dictionary.
robot_sf/render/playback_recording.py	Removed call to sim_view.show() in visualize_states function.

Assessment against linked issues

Objective	Addressed	Explanation
Remove SimulationView.show() method from repository	✅

Possibly related PRs

• Fix demos + QoL change #68: The changes in PedestrianEnv regarding the reset method and the handling of simulation UI are related to the modifications in the EmptyRobotEnv class, which also involve changes to the UI display logic.
• Add video recording functionality with moviepy support #75: The updates to the RobotEnv class, particularly the removal of the automatic UI display in debug mode, directly relate to the changes made in the EmptyRobotEnv class regarding the simulation UI.
• Refactor PedestrianEnv and enable robot focus in SimulationView #90: The modifications in SimulationView to focus on the robot and the changes in PedestrianEnv for managing the simulation UI are connected to the changes in EmptyRobotEnv, which also involve UI display logic.

Suggested labels

enhancement

Poem

🐇 In the world of code, where rabbits hop,
The UI's now silent, no more pop!
With resets returning a message so clear,
Our environments thrive, let’s give a cheer!
Hopping through changes, we dance with delight,
In the realm of robots, all feels just right! 🌟

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9203fd6 and dc1ccd5.

📒 Files selected for processing (4)

• robot_sf/gym_env/empty_robot_env.py (0 hunks)
• robot_sf/gym_env/pedestrian_env.py (0 hunks)
• robot_sf/gym_env/robot_env.py (0 hunks)
• robot_sf/render/playback_recording.py (0 hunks)

💤 Files with no reviewable changes (4)

• robot_sf/render/playback_recording.py
• robot_sf/gym_env/empty_robot_env.py
• robot_sf/gym_env/pedestrian_env.py
• robot_sf/gym_env/robot_env.py

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.