Gamedev Framework (gf)  0.3.0
A C++11 framework for 2D games
Public Member Functions | List of all members
gf::StarShape Class Reference

Specialized shape representing a star. More...

#include <gf/Shapes.h>

Inheritance diagram for gf::StarShape:
Inheritance graph
[legend]

Public Member Functions

 StarShape (float minRadius=0, float maxRadius=0, std::size_t branches=7)
 Default constructor. More...
 
void setMinRadius (float minRadius)
 Set the minimum radius. More...
 
float getMinRadius () const
 Get the minimum radius. More...
 
void setMaxRadius (float maxRadius)
 Set the maximum radius. More...
 
float getMaxRadius () const
 Get the maximum radius. More...
 
void setBranches (std::size_t branches)
 Set the number of branches. More...
 
std::size_t getBranches () const
 Get the number of branches. 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 TexturegetTexture () 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 RectFgetTextureRect () 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 Color4fgetColor () const
 Get the fill color of the shape. More...
 
void setOutlineColor (const Color4f &color)
 Set the outline color of the shape. More...
 
const Color4fgetOutlineColor () 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 star.

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:

star.setMinRadius(25.0f);
star.setMaxRadius(50.0f);
star.setBranches(5);
star.setPosition({ 10.0f, 20.0f });
...
window.draw(star);
See also
gf::Shape

Constructor & Destructor Documentation

gf::StarShape::StarShape ( float  minRadius = 0,
float  maxRadius = 0,
std::size_t  branches = 7 
)

Default constructor.

Parameters
minRadiusMinimum radius
maxRadiusMaximum radius
branchesNumber of branches of the star

Member Function Documentation

std::size_t gf::StarShape::getBranches ( ) const
inline

Get the number of branches.

Returns
The number of branches
See also
setBranches()
float gf::StarShape::getMaxRadius ( ) const
inline

Get the maximum radius.

Returns
The maximum radius
See also
setMaxRadius()
float gf::StarShape::getMinRadius ( ) const
inline

Get the minimum radius.

Returns
The minimum radius
See also
setMinRadius()
virtual Vector2f gf::StarShape::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
indexIndex 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::StarShape::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.

void gf::StarShape::setBranches ( std::size_t  branches)

Set the number of branches.

Parameters
branchesNumber of branches
See also
getBranches()
void gf::StarShape::setMaxRadius ( float  maxRadius)

Set the maximum radius.

Parameters
maxRadiusMaximum radius
See also
getMaxRadius()
void gf::StarShape::setMinRadius ( float  minRadius)

Set the minimum radius.

Parameters
minRadiusMinimum radius
See also
getMinRadius()