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

A class to display a high number of sprites. More...

#include <gf/Particles.h>

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

Public Member Functions

 SpriteParticles ()
 Default constructor. More...
 
 SpriteParticles (const Texture &texture)
 Constructor with a texture. More...
 
void setTexture (const Texture &texture)
 Change the source texture. More...
 
void addSprite (Vector2f position, const RectF &textureRect, Color4f color=Color::White)
 Add a sprite to the particles. 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::Transformable
void setOriginFromAnchorAndBounds (Anchor anchor, const RectF &bounds)
 Set the origin from an anchor and bounds. More...
 

Detailed Description

A class to display a high number of sprites.

See also
gf::SpriteBatch

Constructor & Destructor Documentation

◆ SpriteParticles() [1/2]

gf::SpriteParticles::SpriteParticles ( )

Default constructor.

◆ SpriteParticles() [2/2]

gf::SpriteParticles::SpriteParticles ( const Texture texture)

Constructor with a texture.

Parameters
textureThe source texture

Member Function Documentation

◆ addSprite()

void gf::SpriteParticles::addSprite ( Vector2f  position,
const RectF textureRect,
Color4f  color = Color::White 
)

Add a sprite to the particles.

Parameters
positionThe position of the center of the sprite
textureRectThe sub-rectangle of the texture to assign to the sprite
colorThe color of the sprite

◆ draw()

virtual void gf::SpriteParticles::draw ( RenderTarget target,
RenderStates  states 
)
overridevirtual

Draw the object to a render target.

This is a pure virtual function that has to be implemented by the derived class to define how the drawable should be drawn.

Parameters
targetRender target to draw to
statesCurrent render states

Implements gf::Drawable.

◆ setTexture()

void gf::SpriteParticles::setTexture ( const Texture texture)

Change the source texture.

Parameters
textureThe new texture