GluonEngine::SpriteRendererComponent Class Reference
#include <spriterenderercomponent.h>
Classes | |
| class | SpriteRendererComponentPrivate |
Public Slots | |
| virtual void | setSize (const QSizeF &size) |
| virtual void | setMaterial (GluonGraphics::MaterialInstance *material) |
| virtual void | setMaterial (const QString &path) |
Public Member Functions | |
| Q_INVOKABLE | SpriteRendererComponent (QObject *parent=0) |
| SpriteRendererComponent (const SpriteRendererComponent &other) | |
| virtual | ~SpriteRendererComponent () |
| virtual QString | category () const |
| virtual void | initialize () |
| virtual void | start () |
| virtual void | draw (int timeLapse=0) |
| virtual void | cleanup () |
| virtual QSizeF | size () |
| virtual GluonGraphics::MaterialInstance * | material () |
Properties | |
| QSizeF | size |
| GluonGraphics::MaterialInstance | material |
Detailed Description
Definition at line 35 of file spriterenderercomponent.h.
Constructor & Destructor Documentation
| SpriteRendererComponent::SpriteRendererComponent | ( | QObject * | parent = 0 |
) |
Definition at line 62 of file spriterenderercomponent.cpp.
| SpriteRendererComponent::SpriteRendererComponent | ( | const SpriteRendererComponent & | other | ) |
Definition at line 69 of file spriterenderercomponent.cpp.
| SpriteRendererComponent::~SpriteRendererComponent | ( | ) | [virtual] |
Definition at line 75 of file spriterenderercomponent.cpp.
Member Function Documentation
| QString SpriteRendererComponent::category | ( | ) | const [virtual] |
Return the category of the component. Meta-data used for filtering and sorting components
Reimplemented from GluonEngine::Component.
Definition at line 80 of file spriterenderercomponent.cpp.
| void SpriteRendererComponent::cleanup | ( | ) | [virtual] |
The cleanup function is called whenever an object is no longer needed. This happens mostly during scene changes.
Reimplemented from GluonEngine::Component.
Definition at line 121 of file spriterenderercomponent.cpp.
| void SpriteRendererComponent::draw | ( | int | timeLapse = 0 |
) | [virtual] |
The draw function is run every time the engine requests a redraw of the screen. Avoid putting any game logic in this function. The optional timeLapse depends on gameloop being used. By default Gluon uses a gameloop which runs update a fixed number of times per second, while draw is called as often as it can be. The timeLapse parameter then tells you how many milliseconds have passed since the last time update was run. This allows you to extrapolate draw positions of items and thus create a potentially smoother gaming experience.
- Parameters:
-
timeLapse The number of milliseconds passed since the last update - See also:
- Game::runGame, update
Reimplemented from GluonEngine::Component.
Definition at line 109 of file spriterenderercomponent.cpp.
| void SpriteRendererComponent::initialize | ( | ) | [virtual] |
The initialize function is called whenever an initialized object is needed. This includes scene changes.
Reimplemented from GluonEngine::Component.
Definition at line 85 of file spriterenderercomponent.cpp.
| virtual GluonGraphics::MaterialInstance* GluonEngine::SpriteRendererComponent::material | ( | ) | [virtual] |
| void SpriteRendererComponent::setMaterial | ( | const QString & | path | ) | [virtual, slot] |
Definition at line 157 of file spriterenderercomponent.cpp.
| void SpriteRendererComponent::setMaterial | ( | GluonGraphics::MaterialInstance * | material | ) | [virtual, slot] |
Definition at line 146 of file spriterenderercomponent.cpp.
| void SpriteRendererComponent::setSize | ( | const QSizeF & | size | ) | [virtual, slot] |
Definition at line 130 of file spriterenderercomponent.cpp.
| virtual QSizeF GluonEngine::SpriteRendererComponent::size | ( | ) | [virtual] |
| void SpriteRendererComponent::start | ( | ) | [virtual] |
The start function is run once after each scene change, immediately before the first update
- See also:
- Game::setCurrentScene, update
Reimplemented from GluonEngine::Component.
Definition at line 105 of file spriterenderercomponent.cpp.
Property Documentation
GluonGraphics::MaterialInstance * SpriteRendererComponent::material [read, write] |
Definition at line 40 of file spriterenderercomponent.h.
QSizeF SpriteRendererComponent::size [read, write] |
Definition at line 39 of file spriterenderercomponent.h.
The documentation for this class was generated from the following files:
- engine/components/graphics/spriterenderer/spriterenderercomponent.h
- engine/components/graphics/spriterenderer/spriterenderercomponent.cpp
