Add units kwarg to 3D (x,y,z)lim

dstansby · dstansby · commit ec80e48bd6a0 · 2018-09-26T12:48:29.000+01:00
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -769,8 +769,12 @@ def set_zlim3d(self, bottom=None, top=None, emit=True, auto=False,
         return bottom, top
     set_zlim = set_zlim3d
 
-    def get_xlim3d(self):
+    def get_xlim3d(self, units=True):
+        if units:
+            return self._convert_back_lim(
+                self.xy_viewLim.intervalx, self.xaxis)
         return tuple(self.xy_viewLim.intervalx)
+
     get_xlim3d.__doc__ = maxes.Axes.get_xlim.__doc__
     get_xlim = get_xlim3d
     if get_xlim.__doc__ is not None:
@@ -779,8 +783,12 @@ def get_xlim3d(self):
             This function now correctly refers to the 3D x-limits
         """
 
-    def get_ylim3d(self):
+    def get_ylim3d(self, units=True):
+        if units:
+            return self._convert_back_lim(
+                self.xy_viewLim.intervaly, self.yaxis)
         return tuple(self.xy_viewLim.intervaly)
+
     get_ylim3d.__doc__ = maxes.Axes.get_ylim.__doc__
     get_ylim = get_ylim3d
     if get_ylim.__doc__ is not None:
@@ -789,8 +797,24 @@ def get_ylim3d(self):
             This function now correctly refers to the 3D y-limits.
         """
 
-    def get_zlim3d(self):
-        '''Get 3D z limits.'''
+    def get_zlim3d(self, units=True):
+        '''
+        Get 3D z limits.
+
+        Parameters
+        ----------
+        units : bool, optional
+            If *True*, return limits with units attached.
+
+        Returns
+        -------
+        zlimits : tuple
+            Returns the current z-axis limits as the tuple
+            ``(z0, z1)``.
+        '''
+        if units:
+            return self._convert_back_lim(
+                self.zz_viewLim.intervalx, self.zaxis)
         return tuple(self.zz_viewLim.intervalx)
     get_zlim = get_zlim3d
 
