sp::scene::SAnimQueue Struct Reference

#include <spAnimationPlayback.hpp>

List of all members.

Classes
struct	SFrame
	Internal frame structure. More...
Public Member Functions
	SAnimQueue ()
	~SAnimQueue ()
void	addFrame (u32 Frame, f32 Speed=1.0f)
void	removeEntry (u32 QueueEntryIndex)
void	clear ()
Public Attributes
std::vector< SFrame >	Queue

---

Detailed Description

Animation playback queue structure. This is used to store custom playback sequences. For default playback sequences the next frame is always the current frame plus one (NextFrame := CurrentFrame + 1). But for playback queues the next frame can be specified individually. Also the playback speed can be manipulated for each frame.

---

Constructor & Destructor Documentation

sp::scene::SAnimQueue::SAnimQueue

(

)

sp::scene::SAnimQueue::~SAnimQueue

(

)

---

Member Function Documentation

void sp::scene::SAnimQueue::addFrame	(	u32	Frame,
		f32	Speed = 1.0f
	)

Adds a new frame to the queue.

Parameters:

[in]	Frame	Specifies the frame index which is to be added.
[in]	Speed	Specifies the speed multiplier. This will be multiplied by the animation playback speed. By default 1.0.

void sp::scene::SAnimQueue::clear

(

)

Clears all frame entries. This is equivalent to the following code:

    MyAnimQueue.Queue.clear();

void sp::scene::SAnimQueue::removeEntry

(

u32

QueueEntryIndex

)

Removes the specified queue entry.

Parameters:

[in]

QueueEntryIndex

Specifies the index for the queue's entry which is to be removed.

Note:

"QueueEntryIndex" does not specify a frame index but a queue's entry index.

---

Member Data Documentation

std::vector<SFrame> sp::scene::SAnimQueue::Queue

---

The documentation for this struct was generated from the following files:

• D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/SceneGraph/Animation/spAnimationPlayback.hpp
• D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/SceneGraph/Animation/spAnimationPlayback.cpp