Specialized shape representing a circle. More...

#include <gf/Shapes.h>

Inheritance diagram for gf::CircleShape:

Public Member Functions
	CircleShape (float radius=0, std::size_t pointCount=30)
	Default constructor. More...

	CircleShape (const CircF &circ, std::size_t pointCount=30)
	Constructor with a circle. More...

void	setRadius (float radius)
	Set the radius of the circle. More...

float	getRadius () const
	Get the radius of the circle. More...

void	setPointCount (std::size_t pointCount)
	Set the number of points of the circle. More...

virtual std::size_t	getPointCount () const override
	Get the total number of points of the shape. More...

virtual Vector2f	getPoint (std::size_t index) const override
	Get a point of the shape. More...

Public Member Functions inherited from gf::Shape
	Shape ()
	Default constructor. More...

void	setTexture (const Texture &texture, bool resetRect=false)
	Change the source texture of the shape. More...

const Texture *	getTexture () const
	Get the source texture of the shape. More...

void	unsetTexture ()
	Unset the source texture of the shape. More...

void	setTextureRect (const RectF &rect)
	Set the sub-rectangle of the texture that the shape will display. More...

const RectF &	getTextureRect () const
	Get the sub-rectangle of the texture displayed by the shape. More...

void	setColor (const Color4f &color)
	Set the fill color of the shape. More...

const Color4f &	getColor () const
	Get the fill color of the shape. More...

void	setOutlineColor (const Color4f &color)
	Set the outline color of the shape. More...

const Color4f &	getOutlineColor () const
	Get the outline color of the shape. More...

void	setOutlineThickness (float thickness)
	Set the thickness of the shape's outline. More...

float	getOutlineThickness () const
	Get the outline thickness of the shape. More...

RectF	getLocalBounds () const
	Get the local bounding rectangle of the entity. More...

void	setAnchor (Anchor anchor)
	Set the anchor origin of the entity. More...

VertexBuffer	commitGeometry () const
	Create a buffer with the current geometry. More...

VertexBuffer	commitOutlineGeometry () const
	Create a buffer with the current outline geometry. More...

virtual void	draw (RenderTarget &target, RenderStates states) override
	Draw the object to a render target. More...

Public Member Functions inherited from gf::Transformable
	Transformable ()
	Default constructor. More...

void	setOrigin (Vector2f origin)
	Set the local origin of the object. More...

Vector2f	getOrigin () const
	Get the local origin of the object. More...

void	setPosition (Vector2f position)
	Set the position of the object. More...

Vector2f	getPosition () const
	Get the position of the object. More...

void	move (Vector2f offset)
	Move the object by a given offset. More...

void	setRotation (float angle)
	Set the orientation of the object. More...

float	getRotation () const
	Get the orientation of the object. More...

void	rotate (float angle)
	Rotate the object. More...

void	setScale (Vector2f factors)
	Set the scale factors of the object. More...

void	setScale (float factor)
	Set the scale factor of the object. More...

Vector2f	getScale () const
	Get the current scale of the object. More...

void	scale (Vector2f factors)
	Scale the object. More...

void	scale (float factor)
	Scale the object. More...

Matrix3f	getTransform () const
	Get the combined transform of the object. More...

Matrix3f	getInverseTransform () const
	Get the inverse of the combined transform of the object. More...

Public Member Functions inherited from gf::Drawable
virtual	~Drawable ()
	Virtual desctructor. More...

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

Protected Member Functions inherited from gf::Transformable
void	setOriginFromAnchorAndBounds (Anchor anchor, const RectF &bounds)
	Set the origin from an anchor and bounds. More...

Detailed Description

Specialized shape representing a circle.

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

Usage example:

gf::CircleShape circle;
circle.setRadius(150);
circle.setOutlineColor(gf::Color::Red);
circle.setOutlineThickness(5);
circle.setPosition({ 10.0f, 20.0f });
...
window.draw(circle);

Since the graphics card can't draw perfect circles, we have to fake them with multiple triangles connected to each other. The "points count" property of gf::CircleShape defines how many of these triangles to use, and therefore defines the quality of the circle.

The number of points can also be used for another purpose; with small numbers you can create any regular polygon shape: equilateral triangle, square, pentagon, hexagon, ...

See also: gf::Shape

Constructor & Destructor Documentation

gf::CircleShape::CircleShape	(	float	radius = `0`,
		std::size_t	pointCount = `30`
	)

Default constructor.

Parameters

radius	Radius of the circle
pointCount	Number of points composing the circle

gf::CircleShape::CircleShape	(	const CircF &	circ,
		std::size_t	pointCount = `30`
	)

explicit

Constructor with a circle.

The shape takes the radius of the circle and the position of the circle.

Parameters

circ	A circle with a radius and a position
pointCount	Number of points composing the circle

Member Function Documentation

virtual Vector2f gf::CircleShape::getPoint ( std::size_t index ) const

overridevirtual

Get a point of the shape.

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, n-1] \) where \( n \) is the number of points of the shape.

Returns: index-th point of the shape

See also: getPointCount()

Implements gf::Shape.

virtual std::size_t gf::CircleShape::getPointCount ( ) const

overridevirtual

Get the total number of points of the shape.

Returns: Number of points of the shape

See also: getPoint()

Implements gf::Shape.

float gf::CircleShape::getRadius ( ) const

inline

Get the radius of the circle.

Returns: Radius of the circle

See also: setRadius()

void gf::CircleShape::setPointCount ( std::size_t pointCount )

Set the number of points of the circle.

Parameters

pointCount New number of points of the circle

See also: getPointCount()

void gf::CircleShape::setRadius ( float radius )

Set the radius of the circle.

Parameters

radius New radius of the circle

See also: getRadius()

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation