*********
wx.Rect2D
*********

Inheritance diagram for `wx.Rect2D`:

|

.. inheritance-diagram:: wx.Rect2D

|

Description
===========

`wx.Rect2D` is a rectangle, with position and size, in a 2D coordinate system with floating point component values.


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `ConstrainTo <#ConstrainTo>`_ 
* `Contains <#Contains>`_ 
* `ContainsRect <#ContainsRect>`_ 
* `CreateIntersection <#CreateIntersection>`_ 
* `CreateUnion <#CreateUnion>`_ 
* `Get <#Get>`_ 
* `GetBottom <#GetBottom>`_ 
* `GetCentre <#GetCentre>`_ 
* `GetLeft <#GetLeft>`_ 
* `GetLeftBottom <#GetLeftBottom>`_ 
* `GetLeftTop <#GetLeftTop>`_ 
* `GetOutcode <#GetOutcode>`_ 
* `GetPosition <#GetPosition>`_ 
* `GetRight <#GetRight>`_ 
* `GetRightBottom <#GetRightBottom>`_ 
* `GetRightTop <#GetRightTop>`_ 
* `GetSize <#GetSize>`_ 
* `GetTop <#GetTop>`_ 
* `HaveEqualSize <#HaveEqualSize>`_ 
* `Inset <#Inset>`_ 
* `Interpolate <#Interpolate>`_ 
* `Intersect <#Intersect>`_ 
* `Intersects <#Intersects>`_ 
* `IsEmpty <#IsEmpty>`_ 
* `MoveBottomTo <#MoveBottomTo>`_ 
* `MoveCentreTo <#MoveCentreTo>`_ 
* `MoveLeftBottomTo <#MoveLeftBottomTo>`_ 
* `MoveLeftTo <#MoveLeftTo>`_ 
* `MoveLeftTopTo <#MoveLeftTopTo>`_ 
* `MoveRightBottomTo <#MoveRightBottomTo>`_ 
* `MoveRightTo <#MoveRightTo>`_ 
* `MoveRightTopTo <#MoveRightTopTo>`_ 
* `MoveTopTo <#MoveTopTo>`_ 
* `Offset <#Offset>`_ 
* `Scale <#Scale>`_ 
* `Set <#Set>`_ 
* `SetBottom <#SetBottom>`_ 
* `SetCentre <#SetCentre>`_ 
* `SetLeft <#SetLeft>`_ 
* `SetLeftBottom <#SetLeftBottom>`_ 
* `SetLeftTop <#SetLeftTop>`_ 
* `SetRight <#SetRight>`_ 
* `SetRightBottom <#SetRightBottom>`_ 
* `SetRightTop <#SetRightTop>`_ 
* `SetTop <#SetTop>`_ 
* `Union <#Union>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `height <#height>`_ 
* `width <#width>`_ 
* `x <#x>`_ 
* `y <#y>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(x=0.0, y=0.0, w=0.0, h=0.0)

   `wx.Rect2D` is a rectangle, with position and size, in a 2D coordinate system with floating point component values.

   **Parameters:**

   * `x` (double)
   * `y` (double)
   * `w` (double)
   * `h` (double)

   |

   **Returns:**

   `wx.Rect2D <wx.Rect2D.html>`_
 

--------

.. method:: ConstrainTo(rect)

   |

   **Parameters:**

   * `rect` (`wx.Rect2D <wx.Rect2D.html>`_)


--------

.. method:: Contains(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)

   |

   **Returns:**

   `bool` 

--------

.. method:: ContainsRect(rect)

   |

   **Parameters:**

   * `rect` (`wx.Rect2D <wx.Rect2D.html>`_)

   |

   **Returns:**

   `bool` 

--------

.. method:: CreateIntersection(otherRect)

   |

   **Parameters:**

   * `otherRect` (`wx.Rect2D <wx.Rect2D.html>`_)

   |

   **Returns:**

   `wx.Rect2D <wx.Rect2D.html>`_
 

--------

.. method:: CreateUnion(otherRect)

   |

   **Parameters:**

   * `otherRect` (`wx.Rect2D <wx.Rect2D.html>`_)

   |

   **Returns:**

   `wx.Rect2D <wx.Rect2D.html>`_
 

--------

.. method:: Get()

   Return `x`, `y`, `width` and `height` properties as a tuple.

   |

   **Returns:**

   `(x, y, width, height)` 

--------

.. method:: GetBottom()

   `No docstrings available for this method.` 

--------


.. method:: GetCentre()

   `No docstrings available for this method.` 

--------


.. method:: GetLeft()

   `No docstrings available for this method.` 

--------


.. method:: GetLeftBottom()

   `No docstrings available for this method.` 

--------


.. method:: GetLeftTop()

   `No docstrings available for this method.` 

--------


.. method:: GetOutcode(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)

   |

   **Returns:**

   `int` 

--------

.. method:: GetPosition()

   `No docstrings available for this method.` 

--------


.. method:: GetRight()

   `No docstrings available for this method.` 

--------


.. method:: GetRightBottom()

   `No docstrings available for this method.` 

--------


.. method:: GetRightTop()

   `No docstrings available for this method.` 

--------


.. method:: GetSize()

   `No docstrings available for this method.` 

--------


.. method:: GetTop()

   `No docstrings available for this method.` 

--------


.. method:: HaveEqualSize(rect)

   |

   **Parameters:**

   * `rect` (`wx.Rect2D <wx.Rect2D.html>`_)

   |

   **Returns:**

   `bool` 

--------

.. method:: Inset(x, y)

   Alternative signature:

   `Inset(self, Double left, Double top, Double right, Double bottom)`


   **Parameters:**

   * `x` (double)
   * `y` (double)


--------

.. method:: Interpolate(widthfactor, heightfactor)

   |

   **Parameters:**

   * `widthfactor` (int)
   * `heightfactor` (int)

   |

   **Returns:**

   `wx.Point2D <wx.Point2D.html>`_
 

--------

.. method:: Intersect(otherRect)

   |

   **Parameters:**

   * `otherRect` (`wx.Rect2D <wx.Rect2D.html>`_)


--------

.. method:: Intersects(rect)

   |

   **Parameters:**

   * `rect` (`wx.Rect2D <wx.Rect2D.html>`_)

   |

   **Returns:**

   `bool` 

--------

.. method:: IsEmpty()

   `No docstrings available for this method.` 

--------


.. method:: MoveBottomTo(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: MoveCentreTo(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: MoveLeftBottomTo(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: MoveLeftTo(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: MoveLeftTopTo(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: MoveRightBottomTo(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: MoveRightTo(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: MoveRightTopTo(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: MoveTopTo(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: Offset(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: Scale(f)

   Alternative signature:

   `Scale(self, int num, int denum)`


   **Parameters:**

   * `f` (double)


--------

.. method:: Set(x=0, y=0, width=0, height=0)

   |

   **Parameters:**

   * `x` (double)
   * `y` (double)
   * `width` (double)
   * `height` (double)


--------

.. method:: SetBottom(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: SetCentre(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: SetLeft(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: SetLeftBottom(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: SetLeftTop(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: SetRight(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: SetRightBottom(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: SetRightTop(pt)

   |

   **Parameters:**

   * `pt` (`wx.Point2D <wx.Point2D.html>`_)


--------

.. method:: SetTop(n)

   |

   **Parameters:**

   * `n` (double)


--------

.. method:: Union(otherRect)

   |

   **Parameters:**

   * `otherRect` (`wx.Rect2D <wx.Rect2D.html>`_)


--------

Properties
^^^^^^^^^^


.. attribute:: height



.. attribute:: width



.. attribute:: x



.. attribute:: y