Utility class for manipulating 2D axis aligned rectangles. More...
#include <SFML/Graphics/Rect.hpp>
Public Member Functions  
Rect ()  
Default constructor.  
Rect (T rectLeft, T rectTop, T rectWidth, T rectHeight)  
Construct the rectangle from its coordinates.  
Rect (const Vector2< T > &position, const Vector2< T > &size)  
Construct the rectangle from position and size.  
template<typename U >  
Rect (const Rect< U > &rectangle)  
Construct the rectangle from another type of rectangle.  
bool  contains (T x, T y) const 
Check if a point is inside the rectangle's area.  
bool  contains (const Vector2< T > &point) const 
Check if a point is inside the rectangle's area.  
bool  intersects (const Rect< T > &rectangle) const 
Check the intersection between two rectangles.  
bool  intersects (const Rect< T > &rectangle, Rect< T > &intersection) const 
Check the intersection between two rectangles.  
sf::Vector2< T >  getPosition () const 
Get the position of the rectangle's topleft corner.  
sf::Vector2< T >  getSize () const 
Get the size of the rectangle.  
Public Attributes  
T  left 
Left coordinate of the rectangle.  
T  top 
Top coordinate of the rectangle.  
T  width 
Width of the rectangle.  
T  height 
Height of the rectangle.  
Related Functions  
(Note that these are not member functions.)  
template<typename T >  
bool  operator== (const Rect< T > &left, const Rect< T > &right) 
Overload of binary operator ==.  
template<typename T >  
bool  operator!= (const Rect< T > &left, const Rect< T > &right) 
Overload of binary operator !=.  
Utility class for manipulating 2D axis aligned rectangles.
A rectangle is defined by its topleft corner and its size.
It is a very simple class defined for convenience, so its member variables (left, top, width and height) are public and can be accessed directly, just like the vector classes (Vector2 and Vector3).
To keep things simple, sf::Rect doesn't define functions to emulate the properties that are not directly members (such as right, bottom, center, etc.), it rather only provides intersection functions.
sf::Rect uses the usual rules for its boundaries:
This means that sf::IntRect(0, 0, 1, 1) and sf::IntRect(1, 1, 1, 1) don't intersect.
sf::Rect is a template and may be used with any numeric type, but for simplicity the instantiations used by SFML are typedef'd:
So that you don't have to care about the template syntax.
Usage example:
sf::Rect< T >::Rect  (  ) 
Default constructor.
Creates an empty rectangle (it is equivalent to calling Rect(0, 0, 0, 0)).
sf::Rect< T >::Rect  (  T  rectLeft, 
T  rectTop,  
T  rectWidth,  
T  rectHeight  
) 
Construct the rectangle from its coordinates.
Be careful, the last two parameters are the width and height, not the right and bottom coordinates!
rectLeft  Left coordinate of the rectangle 
rectTop  Top coordinate of the rectangle 
rectWidth  Width of the rectangle 
rectHeight  Height of the rectangle 
sf::Rect< T >::Rect  (  const Vector2< T > &  position, 
const Vector2< T > &  size  
) 
Construct the rectangle from position and size.
Be careful, the last parameter is the size, not the bottomright corner!
position  Position of the topleft corner of the rectangle 
size  Size of the rectangle 

explicit 
Construct the rectangle from another type of rectangle.
This constructor doesn't replace the copy constructor, it's called only when U != T. A call to this constructor will fail to compile if U is not convertible to T.
rectangle  Rectangle to convert 
Check if a point is inside the rectangle's area.
This check is noninclusive. If the point lies on the edge of the rectangle, this function will return false.
point  Point to test 
bool sf::Rect< T >::contains  (  T  x, 
T  y  
)  const 
Check if a point is inside the rectangle's area.
This check is noninclusive. If the point lies on the edge of the rectangle, this function will return false.
x  X coordinate of the point to test 
y  Y coordinate of the point to test 
sf::Vector2< T > sf::Rect< T >::getPosition  (  )  const 
sf::Vector2< T > sf::Rect< T >::getSize  (  )  const 
Check the intersection between two rectangles.
rectangle  Rectangle to test 
bool sf::Rect< T >::intersects  (  const Rect< T > &  rectangle, 
Rect< T > &  intersection  
)  const 
Check the intersection between two rectangles.
This overload returns the overlapped rectangle in the intersection parameter.
rectangle  Rectangle to test 
intersection  Rectangle to be filled with the intersection 
Overload of binary operator !=.
This operator compares strict difference between two rectangles.
left  Left operand (a rectangle) 
right  Right operand (a rectangle) 
Overload of binary operator ==.
This operator compares strict equality between two rectangles.
left  Left operand (a rectangle) 
right  Right operand (a rectangle) 
T sf::Rect< T >::height 
T sf::Rect< T >::left 
T sf::Rect< T >::top 
T sf::Rect< T >::width 