#!/usr/bin/env python3
"""
The "3D" axes class.
"""
from . import base, shared
try:
from mpl_toolkits.mplot3d import Axes3D
except ImportError:
Axes3D = object
[docs]
class ThreeAxes(shared._SharedAxes, base.Axes, Axes3D):
"""
Simple mix-in of `ultraplot.axes.Axes` with `~mpl_toolkits.mplot3d.axes3d.Axes3D`.
Important
---------
Note that this subclass does *not* implement the :class:`~ultraplot.axes.PlotAxes`
plotting overrides. This axes subclass can be used by passing ``proj='3d'`` or
``proj='three'`` to axes-creation commands like `~ultraplot.figure.Figure.add_axes`,
`~ultraplot.figure.Figure.add_subplot`, and `~ultraplot.figure.Figure.subplots`.
"""
# TODO: Figure out a way to have internal Axes3D calls to plotting commands
# access the overrides rather than the originals? May be impossible.
_name = "three"
_name_aliases = ("3d",)
def __init__(self, *args, **kwargs):
import mpl_toolkits.mplot3d # noqa: F401 verify package is available
kwargs.setdefault("alpha", 0.0)
super().__init__(*args, **kwargs)
[docs]
def graph(self, *args, **kwargs):
"""
Draw network graphs on 3D projections.
"""
from .plot import PlotAxes
return PlotAxes.graph(self, *args, **kwargs)
[docs]
def draw(self, renderer):
"""Draw while suppressing exact surfaces replaced by navigation proxies."""
from .._interaction import _prepare_surface_preview
hidden = tuple(
artist
for artist in self.collections
if getattr(artist, "_ultraplot_navigation_hidden", False)
and _prepare_surface_preview(artist)
)
draw_grid = self._draw_grid
try:
for artist in hidden:
artist.set_visible(False)
if getattr(self, "_ultraplot_navigation_hide_grid", False):
self._draw_grid = False
super().draw(renderer)
finally:
self._draw_grid = draw_grid
for artist in hidden:
artist.set_visible(True)
[docs]
def plot_surface(self, X, Y, Z, *args, **kwargs):
"""Plot a surface and register a lazy private interaction preview."""
surface = super().plot_surface(X, Y, Z, *args, **kwargs)
from .._interaction import _register_surface_preview
_register_surface_preview(surface, X, Y, Z, args, kwargs)
return surface
