Mercurial > fife-parpg

annotate engine/core/util/resource/resource.i @ 677:bb26a76458c6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Modified a calculation in PointType2D to use the FIFE math function * Replaced a #define with an enum for the resource location type * Exposed ResourceLocation::getType() to python
author prock@33b003aa-7bff-0310-803a-e67f0ece8222
date Fri, 12 Nov 2010 03:10:46 +0000
parents b84dbc4665b0
children
rev   line source
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
1 /***************************************************************************
677
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
2 * Copyright (C) 2005-2010 by the FIFE team *
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
3 * http://www.fifengine.net *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
4 * This file is part of FIFE. *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
5 * *
46
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
6 * FIFE is free software; you can redistribute it and/or *
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
7 * modify it under the terms of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
8 * License as published by the Free Software Foundation; either *
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
9 * version 2.1 of the License, or (at your option) any later version. *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
10 * *
46
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
11 * This library is distributed in the hope that it will be useful, *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
46
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
14 * Lesser General Public License for more details. *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
15 * *
46
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
16 * You should have received a copy of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
17 * License along with this library; if not, write to the *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
18 * Free Software Foundation, Inc., *
46
90005975cdbb * Final LGPL switch step by adjusting the file headers
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 19
diff changeset
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
20 ***************************************************************************/
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
21 %module fife
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
22
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
23 %{
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
24 #include "util/resource/resource.h"
150
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
25 #include "util/resource/resource_ptr.h"
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
26 #include "util/resource/resource_location.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
27 #include "util/resource/pool.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
28 %}
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
29
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
30 namespace FIFE {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
31
677
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
32 enum ResourceLocationType {
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
33 RES_TYPE_FILE = 0,
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
34 RES_TYPE_IMAGE = 1
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
35 };
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
36
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
37
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
38 class ResourceLocation {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
39 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
40 ResourceLocation(const std::string& filename);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
41 virtual ~ResourceLocation() {};
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
42 const std::string& getFilename() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
43 virtual bool operator ==(const ResourceLocation& loc) const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
44 virtual bool operator <(const ResourceLocation& loc) const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
45 virtual ResourceLocation* clone() const;
677
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
46
bb26a76458c6 * Modified a calculation in PointType2D to use the FIFE math function
prock@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 644
diff changeset
47 ResourceLocationType getType() const;
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
48 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
49
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
50
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
51 class IReferenceCounted {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
52 virtual ~IReferenceCounted();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
53 virtual void addRef() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
54 virtual void decRef() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
55 virtual unsigned int getRefCount() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
56 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
57
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
58 class IResource: public IReferenceCounted {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
59 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
60 virtual ~IResource() {};
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
61 virtual const ResourceLocation& getResourceLocation() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
62 virtual const std::string& getResourceFile() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
63 virtual void setResourceLocation(const ResourceLocation& location) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
64 virtual void setResourceFile(const std::string& filename) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
65 virtual int getPoolId() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
66 virtual void setPoolId(int poolid) = 0;
139
2cc01d9433ab Minor Changes to SWIG-Interface
thebastion@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 46
diff changeset
67 virtual unsigned int getRefCount() = 0;
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
68 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
69
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
70 %warnfilter(473) ResourceLoader; // filter out "returning a pointer or reference in a director method is not recommended"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
71 %feature("director") ResourceLoader;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
72 class ResourceLoader {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
73 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
74 virtual ~ResourceLoader() { };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
75 virtual IResource* loadResource(const ResourceLocation& location) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
76 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
77
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
78 class ResourceSaver {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
79 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
80 virtual ~ResourceSaver() { };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
81 virtual void save(const ResourceLocation& location, IResource* resource) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
82 virtual void save(const std::string& filename, IResource* resource) { save(ResourceLocation(filename), resource); }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
83 };
644
b84dbc4665b0 loaders extension can now handle multiple loaders for different filetypes. A difference between map and object files is now being made!
nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 156
diff changeset
84
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
85 class Pool {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
86 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
87 static const int INVALID_ID = -1;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
88 virtual ~Pool();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
89 virtual int addResourceFromFile(const std::string& filename);
156
376b8afc9a18 Fixed a horrendous misconeception in the pool.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 152
diff changeset
90 virtual int addResourceFromLocation(ResourceLocation* loc);
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
91 virtual int getResourceCount(int status);
148
72c25cc27d8b For your convenience pools now have a function
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 139
diff changeset
92 virtual int purgeLoadedResources();
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
93 virtual void addResourceLoader(ResourceLoader* loader);
644
b84dbc4665b0 loaders extension can now handle multiple loaders for different filetypes. A difference between map and object files is now being made!
nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 156
diff changeset
94 virtual void clearResourceLoaders();
139
2cc01d9433ab Minor Changes to SWIG-Interface
thebastion@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 46
diff changeset
95 virtual void release(unsigned int index, bool dec = false);
2cc01d9433ab Minor Changes to SWIG-Interface
thebastion@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 46
diff changeset
96 virtual IResource& get(unsigned int index, bool inc = false);
2cc01d9433ab Minor Changes to SWIG-Interface
thebastion@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 46
diff changeset
97 virtual void printStatistics();
2cc01d9433ab Minor Changes to SWIG-Interface
thebastion@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 46
diff changeset
98
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
99 private:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
100 Pool();
644
b84dbc4665b0 loaders extension can now handle multiple loaders for different filetypes. A difference between map and object files is now being made!
nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 156
diff changeset
101 };
150
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
102
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
103 class ResourcePtr {
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
104 public:
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
105 ResourcePtr(IResource* ptr = 0);
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
106 ResourcePtr(Pool* pool,int index);
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
107 ResourcePtr(const ResourcePtr& r);
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
108 void release();
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
109 void load();
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
110 void unload();
6e7d228def30 Lazy loading for animations.
phoku@33b003aa-7bff-0310-803a-e67f0ece8222
parents: 148
diff changeset
111 };
0
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-)
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
112 }