/
asset.h
73 lines (60 loc) · 2.19 KB
/
asset.h
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
/** @file asset.h Information about the state of an asset (e.g., resource).
*
* @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program 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. This program 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 this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBDENG2_ASSET_H
#define LIBDENG2_ASSET_H
#include "../libdeng2.h"
#include "../Observers"
namespace de {
/**
* Information about the state of an asset (e.g., resource). This class
* provides a uniform way for various resources to declare their state to
* whoever needs the resources.
*/
class DENG2_PUBLIC Asset
{
public:
enum State {
NotReady, ///< Asset is not available at the moment.
Ready, ///< Asset is available immediately.
Recoverable ///< Asset is available but not immediately (e.g., needs reloading from disk).
};
enum Policy {
Ignore, ///< State of the asset should be ignored.
Required, ///< Dependents cannot operate without the asset.
SuspendTime ///< Time cannot advance without the asset.
};
/**
* Notified whenever the state of the asset changes.
*/
DENG2_DEFINE_AUDIENCE(StateChange, void assetStateChanged(Asset &))
public:
Asset(Policy assetPolicy = Ignore, State initialState = NotReady);
virtual ~Asset();
void setPolicy(Policy p);
Policy policy() const;
void setState(State s);
State state() const;
/**
* Determines if the asset is ready for use (immediately).
*/
bool isReady() const;
private:
DENG2_PRIVATE(d)
};
} // namespace de
#endif // LIBDENG2_ASSET_H