.. include:: headings.inc



.. _Rect2DDouble:

==========================================================================================================================================
|phoenix_title|  **Rect2DDouble**
==========================================================================================================================================





|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Rect2DDouble**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/Rect2DDouble_inheritance.png" alt="Inheritance diagram of Rect2DDouble" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Rect2DDouble.html" title="Rect2DDouble" alt="" coords="7,5,132,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~Rect2DDouble.__init__`                                                   
:meth:`~Rect2DDouble.ConstrainTo`                                                
:meth:`~Rect2DDouble.Contains`                                                   
:meth:`~Rect2DDouble.CreateIntersection`                                         
:meth:`~Rect2DDouble.CreateUnion`                                                
:meth:`~Rect2DDouble.Get`                                                        Get() -> (x, y, width, height)
:meth:`~Rect2DDouble.GetBottom`                                                  
:meth:`~Rect2DDouble.GetCentre`                                                  
:meth:`~Rect2DDouble.GetLeft`                                                    
:meth:`~Rect2DDouble.GetLeftBottom`                                              
:meth:`~Rect2DDouble.GetLeftTop`                                                 
:meth:`~Rect2DDouble.GetOutCode`                                                 
:meth:`~Rect2DDouble.GetOutcode`                                                 
:meth:`~Rect2DDouble.GetPosition`                                                
:meth:`~Rect2DDouble.GetRight`                                                   
:meth:`~Rect2DDouble.GetRightBottom`                                             
:meth:`~Rect2DDouble.GetRightTop`                                                
:meth:`~Rect2DDouble.GetSize`                                                    
:meth:`~Rect2DDouble.GetTop`                                                     
:meth:`~Rect2DDouble.HaveEqualSize`                                              
:meth:`~Rect2DDouble.Inset`                                                      
:meth:`~Rect2DDouble.Interpolate`                                                
:meth:`~Rect2DDouble.Intersect`                                                  
:meth:`~Rect2DDouble.Intersects`                                                 
:meth:`~Rect2DDouble.IsEmpty`                                                    
:meth:`~Rect2DDouble.MoveBottomTo`                                               
:meth:`~Rect2DDouble.MoveCentreTo`                                               
:meth:`~Rect2DDouble.MoveLeftBottomTo`                                           
:meth:`~Rect2DDouble.MoveLeftTo`                                                 
:meth:`~Rect2DDouble.MoveLeftTopTo`                                              
:meth:`~Rect2DDouble.MoveRightBottomTo`                                          
:meth:`~Rect2DDouble.MoveRightTo`                                                
:meth:`~Rect2DDouble.MoveRightTopTo`                                             
:meth:`~Rect2DDouble.MoveTopTo`                                                  
:meth:`~Rect2DDouble.Offset`                                                     
:meth:`~Rect2DDouble.Scale`                                                      
:meth:`~Rect2DDouble.SetBottom`                                                  
:meth:`~Rect2DDouble.SetCentre`                                                  
:meth:`~Rect2DDouble.SetLeft`                                                    
:meth:`~Rect2DDouble.SetLeftBottom`                                              
:meth:`~Rect2DDouble.SetLeftTop`                                                 
:meth:`~Rect2DDouble.SetRight`                                                   
:meth:`~Rect2DDouble.SetRightBottom`                                             
:meth:`~Rect2DDouble.SetRightTop`                                                
:meth:`~Rect2DDouble.SetTop`                                                     
:meth:`~Rect2DDouble.Union`                                                      
:meth:`~Rect2DDouble.__getitem__`                                                
:meth:`~Rect2DDouble.__len__`                                                    
:meth:`~Rect2DDouble.__nonzero__`                                                
:meth:`~Rect2DDouble.__reduce__`                                                 
:meth:`~Rect2DDouble.__repr__`                                                   
:meth:`~Rect2DDouble.__setitem__`                                                
:meth:`~Rect2DDouble.__str__`                                                    
:meth:`~Rect2DDouble.__ne__`                                                     
:meth:`~Rect2DDouble.__eq__`                                                     
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~Rect2DDouble.Bottom`                                                     See :meth:`~Rect2DDouble.GetBottom` and :meth:`~Rect2DDouble.SetBottom`
:attr:`~Rect2DDouble.Centre`                                                     See :meth:`~Rect2DDouble.GetCentre` and :meth:`~Rect2DDouble.SetCentre`
:attr:`~Rect2DDouble.Left`                                                       See :meth:`~Rect2DDouble.GetLeft` and :meth:`~Rect2DDouble.SetLeft`
:attr:`~Rect2DDouble.LeftBottom`                                                 See :meth:`~Rect2DDouble.GetLeftBottom` and :meth:`~Rect2DDouble.SetLeftBottom`
:attr:`~Rect2DDouble.LeftTop`                                                    See :meth:`~Rect2DDouble.GetLeftTop` and :meth:`~Rect2DDouble.SetLeftTop`
:attr:`~Rect2DDouble.Position`                                                   See :meth:`~Rect2DDouble.GetPosition`
:attr:`~Rect2DDouble.Right`                                                      See :meth:`~Rect2DDouble.GetRight` and :meth:`~Rect2DDouble.SetRight`
:attr:`~Rect2DDouble.RightBottom`                                                See :meth:`~Rect2DDouble.GetRightBottom` and :meth:`~Rect2DDouble.SetRightBottom`
:attr:`~Rect2DDouble.RightTop`                                                   See :meth:`~Rect2DDouble.GetRightTop` and :meth:`~Rect2DDouble.SetRightTop`
:attr:`~Rect2DDouble.Size`                                                       See :meth:`~Rect2DDouble.GetSize`
:attr:`~Rect2DDouble.Top`                                                        See :meth:`~Rect2DDouble.GetTop` and :meth:`~Rect2DDouble.SetTop`
================================================================================ ================================================================================


|


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

.. class:: Rect2DDouble(object)

   
   
   **Possible constructors**::

       Rect2DDouble()
       
       Rect2DDouble(x, y, w, h)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, x, y, w, h)`
      
      
      
      
      :param `x`: 
      :type `x`: float
      :param `y`: 
      :type `y`: float
      :param `w`: 
      :type `w`: float
      :param `h`: 
      :type `h`: float
      
      
      
      
      
      
      **~~~**






   .. method:: ConstrainTo(self, rect)




      :param `rect`: 
      :type `rect`: Rect2DDouble







   .. method:: Contains(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **Contains** `(self, pt)`
      
      
      
      
      :param `pt`: 
      :type `pt`: Point2DDouble
      
      
      
      
      :rtype: `bool`
      
      
      
      
      
      
      
      **~~~**

      
      **Contains** `(self, rect)`
      
      
      
      
      :param `rect`: 
      :type `rect`: Rect2DDouble
      
      
      
      
      :rtype: `bool`
      
      
      
      
      
      
      
      **~~~**






   .. method:: CreateIntersection(self, otherRect)




      :param `otherRect`: 
      :type `otherRect`: Rect2DDouble




      :rtype: :ref:`Rect2DDouble`








   .. method:: CreateUnion(self, otherRect)




      :param `otherRect`: 
      :type `otherRect`: Rect2DDouble




      :rtype: :ref:`Rect2DDouble`








   .. method:: Get(self)

                      Get() -> (x, y, width, height)
        
                      Return the rectangle's properties as a tuple. 

      :rtype: `PyObject`








   .. method:: GetBottom(self)



      :rtype: `float`








   .. method:: GetCentre(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetLeft(self)



      :rtype: `float`








   .. method:: GetLeftBottom(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetLeftTop(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetOutCode(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble




      :rtype: :ref:`OutCode`








   .. method:: GetOutcode(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble




      :rtype: :ref:`OutCode`








   .. method:: GetPosition(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetRight(self)



      :rtype: `float`








   .. method:: GetRightBottom(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetRightTop(self)



      :rtype: :ref:`Point2DDouble`








   .. method:: GetSize(self)



      :rtype: :ref:`Size`








   .. method:: GetTop(self)



      :rtype: `float`








   .. method:: HaveEqualSize(self, rect)




      :param `rect`: 
      :type `rect`: Rect2DDouble




      :rtype: `bool`








   .. method:: Inset(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **Inset** `(self, x, y)`
      
      
      
      
      :param `x`: 
      :type `x`: float
      :param `y`: 
      :type `y`: float
      
      
      
      
      
      
      **~~~**

      
      **Inset** `(self, left, top, right, bottom)`
      
      
      
      
      :param `left`: 
      :type `left`: float
      :param `top`: 
      :type `top`: float
      :param `right`: 
      :type `right`: float
      :param `bottom`: 
      :type `bottom`: float
      
      
      
      
      
      
      **~~~**






   .. method:: Interpolate(self, widthfactor, heightfactor)




      :param `widthfactor`: 
      :type `widthfactor`: int
      :param `heightfactor`: 
      :type `heightfactor`: int




      :rtype: :ref:`Point2DDouble`








   .. method:: Intersect(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **Intersect** `(self, otherRect)`
      
      
      
      
      :param `otherRect`: 
      :type `otherRect`: Rect2DDouble
      
      
      
      
      
      
      **~~~**

      
      **Intersect** `(src1, src2, dest)`
      
      
      
      
      :param `src1`: 
      :type `src1`: Rect2DDouble
      :param `src2`: 
      :type `src2`: Rect2DDouble
      :param `dest`: 
      :type `dest`: Rect2DDouble
      
      
      
      
      
      
      **~~~**






   .. method:: Intersects(self, rect)




      :param `rect`: 
      :type `rect`: Rect2DDouble




      :rtype: `bool`








   .. method:: IsEmpty(self)



      :rtype: `bool`








   .. method:: MoveBottomTo(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: MoveCentreTo(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: MoveLeftBottomTo(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: MoveLeftTo(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: MoveLeftTopTo(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: MoveRightBottomTo(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: MoveRightTo(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: MoveRightTopTo(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: MoveTopTo(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: Offset(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: Scale(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **Scale** `(self, f)`
      
      
      
      
      :param `f`: 
      :type `f`: float
      
      
      
      
      
      
      **~~~**

      
      **Scale** `(self, num, denum)`
      
      
      
      
      :param `num`: 
      :type `num`: int
      :param `denum`: 
      :type `denum`: int
      
      
      
      
      
      
      **~~~**






   .. method:: SetBottom(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: SetCentre(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: SetLeft(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: SetLeftBottom(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: SetLeftTop(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: SetRight(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: SetRightBottom(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: SetRightTop(self, pt)




      :param `pt`: 
      :type `pt`: Point2DDouble







   .. method:: SetTop(self, n)




      :param `n`: 
      :type `n`: float







   .. method:: Union(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **Union** `(self, otherRect)`
      
      
      
      
      :param `otherRect`: 
      :type `otherRect`: Rect2DDouble
      
      
      
      
      
      
      **~~~**

      
      **Union** `(self, pt)`
      
      
      
      
      :param `pt`: 
      :type `pt`: Point2DDouble
      
      
      
      
      
      
      **~~~**

      
      **Union** `(src1, src2, dest)`
      
      
      
      
      :param `src1`: 
      :type `src1`: Rect2DDouble
      :param `src2`: 
      :type `src2`: Rect2DDouble
      :param `dest`: 
      :type `dest`: Rect2DDouble
      
      
      
      
      
      
      **~~~**






   .. method:: __getitem__(self, idx)




   .. method:: __len__(self)




   .. method:: __nonzero__(self)




   .. method:: __reduce__(self)




   .. method:: __repr__(self)




   .. method:: __setitem__(self, idx, val)




   .. method:: __str__(self)




   .. method:: __ne__(self)




      :param `rect`: 
      :type `rect`: Rect2DDouble







   .. method:: __eq__(self)




      :param `rect`: 
      :type `rect`: Rect2DDouble







   .. attribute:: Bottom

      See :meth:`~Rect2DDouble.GetBottom` and :meth:`~Rect2DDouble.SetBottom`


   .. attribute:: Centre

      See :meth:`~Rect2DDouble.GetCentre` and :meth:`~Rect2DDouble.SetCentre`


   .. attribute:: Left

      See :meth:`~Rect2DDouble.GetLeft` and :meth:`~Rect2DDouble.SetLeft`


   .. attribute:: LeftBottom

      See :meth:`~Rect2DDouble.GetLeftBottom` and :meth:`~Rect2DDouble.SetLeftBottom`


   .. attribute:: LeftTop

      See :meth:`~Rect2DDouble.GetLeftTop` and :meth:`~Rect2DDouble.SetLeftTop`


   .. attribute:: Position

      See :meth:`~Rect2DDouble.GetPosition`


   .. attribute:: Right

      See :meth:`~Rect2DDouble.GetRight` and :meth:`~Rect2DDouble.SetRight`


   .. attribute:: RightBottom

      See :meth:`~Rect2DDouble.GetRightBottom` and :meth:`~Rect2DDouble.SetRightBottom`


   .. attribute:: RightTop

      See :meth:`~Rect2DDouble.GetRightTop` and :meth:`~Rect2DDouble.SetRightTop`


   .. attribute:: Size

      See :meth:`~Rect2DDouble.GetSize`


   .. attribute:: Top

      See :meth:`~Rect2DDouble.GetTop` and :meth:`~Rect2DDouble.SetTop`