.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.floatcanvas.Utilities.BBox

.. highlight:: python



.. _wx.lib.floatcanvas.Utilities.BBox.RectBBox:

==========================================================================================================================================
|phoenix_title|  **wx.lib.floatcanvas.Utilities.BBox.RectBBox**
==========================================================================================================================================

subclass of a BBox that can be used for a rotated Rectangle

contributed by MArco Oster (marco.oster@bioquant.uni-heidelberg.de)



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>RectBBox</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.floatcanvas.Utilities.BBox.RectBBox_inheritance.svg" alt="Inheritance diagram of RectBBox" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.floatcanvas.Utilities.BBox.RectBBox.html" title="subclass of a BBox that can be used for a rotated Rectangle" alt="" coords="5,159,336,188"/> <area shape="rect" id="node2" href="wx.lib.floatcanvas.Utilities.BBox.BBox.html" title="A Bounding Box object:" alt="" coords="22,82,320,111"/> <area shape="rect" id="node3" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" alt="" coords="104,5,238,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.floatcanvas.Utilities.BBox.BBox`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.Utilities.BBox.RectBBox.__init__`                     assume edgepoints are ordered such you can walk along all edges with left rotation sense
:meth:`~wx.lib.floatcanvas.Utilities.BBox.RectBBox.ac_leftOf_ab`                 
:meth:`~wx.lib.floatcanvas.Utilities.BBox.RectBBox.PointInside`                  Inside(BB)
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: RectBBox(BBox)

   subclass of a BBox that can be used for a rotated Rectangle
   
   contributed by MArco Oster (marco.oster@bioquant.uni-heidelberg.de)

   .. method:: __init__(self, data, edges=None)

      assume edgepoints are ordered such you can walk along all edges with left rotation sense
      This may be:
      left-top
      left-bottom
      right-bottom
      right-top
      
      or any rotation.


   .. method:: ac_leftOf_ab(self, a, b, c)


   .. method:: PointInside(self, point)

      Inside(BB):
      
      Tests if the given Point is entirely inside this one.
      
      Returns ``True`` if it is entirely inside, or touching the
      border.
      
      Returns ``False`` otherwise
      
      Point is any length-2 sequence (tuple, list, array) or two numbers