SFMLDrawableRenderer Class Reference

A Renderer drawing particles as SFML Drawables for the SFML 2D rendering engine. More...

Inheritance diagram for SFMLDrawableRenderer:
SFMLRenderer Renderer Registerable BufferHandler

List of all members.

Public Member Functions

 SFMLDrawableRenderer (sf::Drawable *drawable=NULL, float scaleX=1.0f, float scaleY=1.0f)
 Constructor of SFMLDrawableRenderer.
void setDrawable (sf::Drawable *drawable)
 Sets the base Drawable of this SFMLDrawableRenderer.
void setScale (float scaleX, float scaleY)
 Sets the scale of this SFMLDrawableRenderer.
sf::Drawable * getDrawable () const
 Gets the base Drawable of this SFMLDrawableRenderer.
float getScaleX () const
 Gets the scale in X axis of this SFMLDrawableRenderer.
float getScaleY () const
 Gets the scale in Y axis of this SFMLDrawableRenderer.

Static Public Member Functions

static SFMLDrawableRenderercreate (sf::Drawable *drawable=NULL, float scaleX=1.0f, float scaleY=1.0f)
 Creates and registers a new SFMLDrawableRenderer.

Detailed Description

A Renderer drawing particles as SFML Drawables for the SFML 2D rendering engine.

This SFMLRenderer allows to render particles with any of the SFML Drawables available in the library :


Note that when possible other SFML renderers should be prefered as they are more optimized.
For instance, SFMLQuadRenderer should be preferred to SFMLDrawableRenderer with Sprites.

The base Drawable should have its center centered on the Drawable (it is the top left corner by default) with a call to sf::Drawable::SetCenter() to have scale, translation and rotation well defined.
However the center can be set wherever on the Drawable to get desirable effects.

Note that the parameters of the base Drawable are modified during rendering.
In that way, the initial position, scale, color, angle and blending mode of the Drawable is not used but overriden by particle parameters.

Below are the parameters of Particle that are used in this Renderer (others have no effects) :

Since:
1.01.00

Definition at line 67 of file SPK_SFMLDrawableRenderer.h.


Constructor & Destructor Documentation

SFMLDrawableRenderer ( sf::Drawable *  drawable = NULL,
float  scaleX = 1.0f,
float  scaleY = 1.0f 
)

Constructor of SFMLDrawableRenderer.

Parameters:
drawable : the base Drawable of this SFMLDrawableRenderer
scaleX : the scale in X axis of this SFMLDrawableRenderer
scaleY : the scale in X axis of this SFMLDrawableRenderer

Member Function Documentation

SFMLDrawableRenderer * create ( sf::Drawable *  drawable = NULL,
float  scaleX = 1.0f,
float  scaleY = 1.0f 
) [static]

Creates and registers a new SFMLDrawableRenderer.

Parameters:
drawable : the base Drawable of this SFMLDrawableRenderer
scaleX : the scale in X axis of this SFMLDrawableRenderer
scaleY : the scale in X axis of this SFMLDrawableRenderer
Returns:
A new registered SFMLDrawableRenderer
Since:
1.04.00

Definition at line 146 of file SPK_SFMLDrawableRenderer.h.

sf::Drawable * getDrawable (  )  const

Gets the base Drawable of this SFMLDrawableRenderer.

Returns:
the base Drawable of this SFMLDrawableRenderer or NULL if no Drawable is set

Definition at line 164 of file SPK_SFMLDrawableRenderer.h.

float getScaleX (  )  const

Gets the scale in X axis of this SFMLDrawableRenderer.

Returns:
the scale in X axis of this SFMLDrawableRenderer

Definition at line 169 of file SPK_SFMLDrawableRenderer.h.

float getScaleY (  )  const

Gets the scale in Y axis of this SFMLDrawableRenderer.

Returns:
the scale in Y axis of this SFMLDrawableRenderer

Definition at line 174 of file SPK_SFMLDrawableRenderer.h.

void setDrawable ( sf::Drawable *  drawable  ) 

Sets the base Drawable of this SFMLDrawableRenderer.

Parameters:
drawable : the base Drawable of this SFMLDrawableRenderer

Definition at line 153 of file SPK_SFMLDrawableRenderer.h.

void setScale ( float  scaleX,
float  scaleY 
)

Sets the scale of this SFMLDrawableRenderer.

Parameters:
scaleX : the scale in X axis of this SFMLDrawableRenderer
scaleY : the scale in X axis of this SFMLDrawableRenderer

Definition at line 158 of file SPK_SFMLDrawableRenderer.h.


Generated on Wed Apr 27 21:09:27 2011 for SPARK Particle Engine by  doxygen 1.6.1