1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* Copyright 2009-2011 Jörg Hermann Müller
*
* This file is part of AudaSpace.
*
* Audaspace is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* AudaSpace is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Audaspace; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file audaspace/intern/AUD_SequencerHandle.h
* \ingroup audaspaceintern
*/
#ifndef AUD_SEQUENCERHANDLE
#define AUD_SEQUENCERHANDLE
#include "AUD_SequencerEntry.h"
#include "AUD_IHandle.h"
#include "AUD_I3DHandle.h"
class AUD_ReadDevice;
/**
* Represents a playing sequenced entry.
*/
class AUD_SequencerHandle
{
private:
/// The entry this handle belongs to.
AUD_Reference<AUD_SequencerEntry> m_entry;
/// The handle in the read device.
AUD_Reference<AUD_IHandle> m_handle;
/// The 3D handle in the read device.
AUD_Reference<AUD_I3DHandle> m_3dhandle;
/// The last read status from the entry.
int m_status;
/// The last position status from the entry.
int m_pos_status;
/// The last sound status from the entry.
int m_sound_status;
/// The read device this handle is played on.
AUD_ReadDevice& m_device;
public:
/**
* Creates a new sequenced handle.
* \param entry The entry this handle plays.
* \param device The read device to play on.
*/
AUD_SequencerHandle(AUD_Reference<AUD_SequencerEntry> entry, AUD_ReadDevice& device);
/**
* Destroys the handle.
*/
~AUD_SequencerHandle();
/**
* Compares whether this handle is playing the same entry as supplied.
* \param entry The entry to compare to.
* \return Whether the entries ID is smaller, equal or bigger.
*/
int compare(AUD_Reference<AUD_SequencerEntry> entry) const;
/**
* Stops playing back the handle.
*/
void stop();
/**
* Updates the handle for playback.
* \param position The current time during playback.
* \param frame The current frame during playback.
* \param fps The animation frames per second.
*/
void update(float position, float frame, float fps);
/**
* Seeks the handle to a specific time position.
* \param position The time to seek to.
*/
void seek(float position);
};
#endif //AUD_SEQUENCERHANDLE
|