aerosandbox.visualization.plotly_Figure3D
=========================================

.. py:module:: aerosandbox.visualization.plotly_Figure3D


Attributes
----------

.. autoapisummary::

   aerosandbox.visualization.plotly_Figure3D.fig


Classes
-------

.. autoapisummary::

   aerosandbox.visualization.plotly_Figure3D.Figure3D


Functions
---------

.. autoapisummary::

   aerosandbox.visualization.plotly_Figure3D.reflect_over_XZ_plane


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

.. py:function:: reflect_over_XZ_plane(input_vector)

   Takes in a vector or an array and flips the y-coordinates.
   :param input_vector: A vector or list of vectors to flip.
   :return: Vector with flipped sign on y-coordinate.


.. py:class:: Figure3D

   .. py:attribute:: fig


   .. py:attribute:: x_face
      :value: []



   .. py:attribute:: y_face
      :value: []



   .. py:attribute:: z_face
      :value: []



   .. py:attribute:: i_face
      :value: []



   .. py:attribute:: j_face
      :value: []



   .. py:attribute:: k_face
      :value: []



   .. py:attribute:: intensity_face
      :value: []



   .. py:attribute:: x_line
      :value: []



   .. py:attribute:: y_line
      :value: []



   .. py:attribute:: z_line
      :value: []



   .. py:attribute:: x_streamline
      :value: []



   .. py:attribute:: y_streamline
      :value: []



   .. py:attribute:: z_streamline
      :value: []



   .. py:method:: add_line(points, mirror=False)

      Adds a line (or series of lines) to draw.
      :param points: an iterable with an arbitrary number of items. Each item is a 3D point, represented as an iterable of length 3.
      :param mirror: Should we also draw a version that's mirrored over the XZ plane? [boolean]
      :return: None

      E.g. add_line([(0, 0, 0), (1, 0, 0)])



   .. py:method:: add_streamline(points, mirror=False)

      Adds a line (or series of lines) to draw.
      :param points: an iterable with an arbitrary number of items. Each item is a 3D point, represented as an iterable of length 3.
      :param mirror: Should we also draw a version that's mirrored over the XZ plane? [boolean]
      :return: None

      E.g. add_line([(0, 0, 0), (1, 0, 0)])



   .. py:method:: add_tri(points, intensity=0, outline=False, mirror=False)

      Adds a triangular face to draw.
      :param points: an iterable with 3 items. Each item is a 3D point, represented as an iterable of length 3.
      :param intensity: Intensity associated with this face
      :param outline: Do you want to outline this triangle? [boolean]
      :param mirror: Should we also draw a version that's mirrored over the XZ plane? [boolean]
      :return: None

      E.g. add_face([(0, 0, 0), (1, 0, 0), (0, 1, 0)])



   .. py:method:: add_quad(points, intensity=0, outline=True, mirror=False)

      Adds a quadrilateral face to draw. All points should be (approximately) coplanar if you want it to look right.
      :param points: an iterable with 4 items. Each item is a 3D point, represented as an iterable of length 3. Points should be given in sequential order.
      :param intensity: Intensity associated with this face
      :param outline: Do you want to outline this quad? [boolean]
      :param mirror: Should we also draw a version that's mirrored over the XZ plane? [boolean]
      :return: None

      E.g. add_face([(0, 0, 0), (1, 0, 0), (0, 1, 0)])



   .. py:method:: draw(show=True, title='', colorbar_title='', colorscale='viridis')


.. py:data:: fig