sf::RectangleShape Class Reference

Specialized shape representing a rectangle. More...

#include <RectangleShape.hpp>

Inheritance diagram for sf::RectangleShape:

Collaboration diagram for sf::RectangleShape:

Public Member Functions
	RectangleShape (const Vector2f &size=Vector2f(0, 0))
	Default constructor. More...
void	setSize (const Vector2f &size)
	Set the size of the rectangle. More...
const Vector2f &	getSize () const
	Get the size of the rectangle. More...
virtual std::size_t	getPointCount () const
	Get the number of points defining the shape. More...
virtual Vector2f	getPoint (std::size_t index) const
	Get a point of the rectangle. More...
Public Member Functions inherited from sf::Shape
virtual	~Shape ()
	Virtual destructor. More...
void	setTexture (const Texture *texture, bool resetRect=false)
	Change the source texture of the shape. More...
void	setTextureRect (const IntRect &rect)
	Set the sub-rectangle of the texture that the shape will display. More...
void	setFillColor (const Color &color)
	Set the fill color of the shape. More...
void	setOutlineColor (const Color &color)
	Set the outline color of the shape. More...
void	setOutlineThickness (float thickness)
	Set the thickness of the shape's outline. More...
const Texture *	getTexture () const
	Get the source texture of the shape. More...
const IntRect &	getTextureRect () const
	Get the sub-rectangle of the texture displayed by the shape. More...
const Color &	getFillColor () const
	Get the fill color of the shape. More...
const Color &	getOutlineColor () const
	Get the outline color of the shape. More...
float	getOutlineThickness () const
	Get the outline thickness of the shape. More...
virtual std::size_t	getPointCount () const =0
	Get the total number of points of the shape. More...
virtual Vector2f	getPoint (std::size_t index) const =0
	Get a point of the shape. More...
FloatRect	getLocalBounds () const
	Get the local bounding rectangle of the entity. More...
FloatRect	getGlobalBounds () const
	Get the global (non-minimal) bounding rectangle of the entity. More...
Public Member Functions inherited from sf::Drawable
virtual	~Drawable ()
	Virtual destructor. More...
Public Member Functions inherited from sf::Transformable
	Transformable ()
	Default constructor. More...
virtual	~Transformable ()
	Virtual destructor. More...
void	setPosition (float x, float y)
	set the position of the object More...
void	setPosition (const Vector2f &position)
	set the position of the object More...
void	setRotation (float angle)
	set the orientation of the object More...
void	setScale (float factorX, float factorY)
	set the scale factors of the object More...
void	setScale (const Vector2f &factors)
	set the scale factors of the object More...
void	setOrigin (float x, float y)
	set the local origin of the object More...
void	setOrigin (const Vector2f &origin)
	set the local origin of the object More...
const Vector2f &	getPosition () const
	get the position of the object More...
float	getRotation () const
	get the orientation of the object More...
const Vector2f &	getScale () const
	get the current scale of the object More...
const Vector2f &	getOrigin () const
	get the local origin of the object More...
void	move (float offsetX, float offsetY)
	Move the object by a given offset. More...
void	move (const Vector2f &offset)
	Move the object by a given offset. More...
void	rotate (float angle)
	Rotate the object. More...
void	scale (float factorX, float factorY)
	Scale the object. More...
void	scale (const Vector2f &factor)
	Scale the object. More...
const Transform &	getTransform () const
	get the combined transform of the object More...
const Transform &	getInverseTransform () const
	get the inverse of the combined transform of the object More...

Additional Inherited Members
Protected Member Functions inherited from sf::Shape
	Shape ()
	Default constructor. More...
void	update ()
	Recompute the internal geometry of the shape. More...
virtual void	draw (RenderTarget &target, RenderStates states) const =0
	Draw the object to a render target. More...

Detailed Description

Specialized shape representing a rectangle.

This class inherits all the functions of sf::Transformable (position, rotation, scale, bounds, ...) as well as the functions of sf::Shape (outline, color, texture, ...).

Usage example:

sf::RectangleShape rectangle;
rectangle.setSize(sf::Vector2f(100, 50));
rectangle.setOutlineColor(sf::Color::Red);
rectangle.setOutlineThickness(5);
rectangle.setPosition(10, 20);
...
window.draw(rectangle);

See also

sf::Shape, sf::CircleShape, sf::ConvexShape

Definition at line 41 of file RectangleShape.hpp.

Constructor & Destructor Documentation

RectangleShape()

sf::RectangleShape::RectangleShape ( const Vector2f &  size = Vector2f(0, 0) )

explicit

Default constructor.

Parameters

size	Size of the rectangle

Member Function Documentation

getPoint()

virtual Vector2f sf::RectangleShape::getPoint ( std::size_t  index ) const

virtual

Get a point of the rectangle.

The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account. The result is undefined if index is out of the valid range.

Parameters

index

Index of the point to get, in range [0 .. 3]

Returns

index-th point of the shape

Implements sf::Shape.

getPointCount()

virtual std::size_t sf::RectangleShape::getPointCount ( ) const

virtual

Get the number of points defining the shape.

Returns

Number of points of the shape. For rectangle shapes, this number is always 4.

Implements sf::Shape.

getSize()

const Vector2f & sf::RectangleShape::getSize

(

)

const

Get the size of the rectangle.

Returns

Size of the rectangle

See also

setSize

Here is the caller graph for this function:

setSize()

void sf::RectangleShape::setSize

(

const Vector2f &

size

)

Set the size of the rectangle.

Parameters

size	New size of the rectangle

See also

getSize

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• RectangleShape.hpp