gf::Drawable Class Reference

Abstract base class for objects that can be drawn to a render window. More...

#include <gf/Drawable.h>

Inheritance diagram for gf::Drawable:

Public Member Functions
virtual	~Drawable ()
	Virtual desctructor. More...
virtual void	draw (RenderTarget &target, const RenderStates &states)=0
	Draw the object to a render target. More...

Detailed Description

Abstract base class for objects that can be drawn to a render window.

gf::Drawable is a very simple base class that allows objects of derived classes to be drawn to a sf::RenderTarget.

All you have to do in your derived class is to override the draw() virtual function.

Note that inheriting from gf::Drawable is not mandatory, but it allows this nice syntax target.draw(object) rather than object.draw(target), which is more consistent with other classes.

Example:

class MyDrawable : public gf::Drawable {
public:
 
  // ...
 
  virtual void draw(gf::RenderTarget& target, const gf::RenderStates& states) override {
    // You can draw other high-level objects
    target.draw(m_sprite, states);
 
    // ... or use the low-level API
    gf::RenderStates localStates = states;
    localStates.texture[0] = &m_texture;
    target.draw(m_vertices, localStates);
  }
 
private:
  gf::Sprite m_sprite;
  gf::Texture m_texture;
  gf::VertexArray m_vertices;
};

Constructor & Destructor Documentation

~Drawable()

virtual gf::Drawable::~Drawable ( )

virtual

Virtual desctructor.

Member Function Documentation

draw()

virtual void gf::Drawable::draw ( RenderTarget &  target, const RenderStates &  states  )

pure virtual

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

target	Render target to draw to
states	Current render states

Implemented in gf::BufferedGeometry, gf::Console, gf::Curve, gf::Grid, gf::Logo, gf::NinePatch, gf::PointParticles, gf::ShapeParticles, gf::SpriteParticles, gf::PostProcessing, gf::Segue, gf::Shape, gf::Sprite, gf::Text, gf::TileLayer, gf::VertexArray, gf::TextWidget, gf::TextButtonWidget, gf::SpriteWidget, and gf::ChoiceSpriteWidget.