irsim.env.env_plot3d
====================

.. py:module:: irsim.env.env_plot3d


Classes
-------

.. autoapisummary::

   irsim.env.env_plot3d.EnvPlot3D


Module Contents
---------------

.. py:class:: EnvPlot3D(world: Any, objects: list[Any] | None = None, **kwargs: Any)

   Bases: :py:obj:`irsim.env.env_plot.EnvPlot`


   EnvPlot class for visualizing the environment.

   :param world: The world object with ranges and a ``plot_parse`` dictionary that
                 configures plotting (e.g., saved_figure, figure_pixels, show_title,
                 no_axis, tight).
   :param objects: Initial objects to draw. Default is ``[]``.
   :type objects: list, optional
   :param kwargs: Plot overrides that update ``world.plot_parse`` at runtime
                  (e.g., ``saved_figure``, ``figure_pixels``, ``show_title``,
                  ``no_axis``, ``tight``).

   Create a 3D plot for the environment.

   :param world: World-like object that provides ranges and grid map.
   :param objects: Objects to initialize on the plot.
   :type objects: list | None
   :param saved_figure: Savefig keyword arguments.
   :type saved_figure: dict | None
   :param figure_pixels: Figure size in pixels [w, h].
   :type figure_pixels: list[int] | None
   :param show_title: Whether to show the title.
   :type show_title: bool
   :param \*\*kwargs: Additional drawing options passed downstream.


   .. py:attribute:: ax


   .. py:method:: draw_points(points: list | numpy.ndarray | None, s: int = 10, c: str = 'm', refresh: bool = True, **kwargs: Any) -> None

      Draw points on the plot.

      :param points: List of points, each point as [x, y, z].
      :type points: list
      :param s: Size of the points.
      :type s: int
      :param c: Color of the points.
      :type c: str
      :param refresh: Whether to refresh the plot.
      :type refresh: bool
      :param kwargs: Additional plotting options.



   .. py:method:: draw_quiver(point: numpy.ndarray | None, refresh: bool = False, **kwargs: Any) -> None

      Draw a quiver plot on the plot.

      :param points: List of points, each point as [x, y, z, u, v, w]. u, v, w are the components of the vector.
      :type points: 6*1 np.ndarray
      :param kwargs: Additional plotting options.



   .. py:method:: draw_quivers(points: list | numpy.ndarray, refresh: bool = False, **kwargs: Any) -> None

      Draw a series of quiver plot on the plot.

      :param points: List of points, each point as [x, y, z, u, v, w]. u, v, w are the components of the vector.
      :type points: list or np.ndarray



   .. py:method:: draw_trajectory(traj: list | numpy.ndarray, traj_type: str = 'g-', label: str = 'trajectory', show_direction: bool = False, refresh: bool = False, **kwargs: Any) -> None

      Draw a trajectory on the plot.

      :param traj: List of points or array of points [x, y, z].
      :type traj: list or np.ndarray
      :param traj_type: Type of trajectory line (e.g., 'g-').
                        See https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.pyplot.plot.html for details.
      :type traj_type: str
      :param label: Label for the trajectory.
      :type label: str
      :param show_direction: Whether to show the direction of the trajectory.
      :type show_direction: bool
      :param refresh: Whether to refresh the plot.
      :type refresh: bool
      :param kwargs: Additional plotting options for ax.plot()



   .. py:method:: update_title() -> None

      Override the parent's update_title method to handle 3D plots properly.