sf::RectangleShape Class Reference

Specialized shape representing a rectangle. More...

#include <RectangleShape.hpp>

Inheritance diagram for sf::RectangleShape:

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

Additional Inherited Members
Protected Member Functions inherited from sf::Shape
void	update ()
	Recompute the internal geometry of the shape.

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

Constructor & Destructor Documentation

RectangleShape()

sf::RectangleShape::RectangleShape ( Vector2f size = {} )

explicit

Default constructor.

Parameters

size	Size of the rectangle

Member Function Documentation

getGeometricCenter()

Vector2f sf::RectangleShape::getGeometricCenter ( ) const

nodiscardoverridevirtual

Get the geometric center of the rectangle.

The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account.

Returns

The geometric center of the shape

Reimplemented from sf::Shape.

getPoint()

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

nodiscardoverridevirtual

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()

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

nodiscardoverridevirtual

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()

Vector2f sf::RectangleShape::getSize ( ) const

nodiscard

Get the size of the rectangle.

Returns

Size of the rectangle

See also

setSize

setSize()

void sf::RectangleShape::setSize

(

Vector2f

size

)

Set the size of the rectangle.

Parameters

size	New size of the rectangle

See also

getSize

---

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

• SFML/Graphics/RectangleShape.hpp