FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
iobjectloader.h
Go to the documentation of this file.
1 /**************************************************************************
2 * Copyright (C) 2005-2017 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21 
22 #ifndef FIFE_IOBJECTLOADER_H_
23 #define FIFE_IOBJECTLOADER_H_
24 
25 // Standard C++ library includes
26 #include <string>
27 
28 // 3rd party library includes
29 
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 #include "util/base/sharedptr.h"
35 
36 #include "ianimationloader.h"
37 #include "iatlasloader.h"
38 
39 namespace FIFE {
40 
43  class IObjectLoader {
44  public:
45  virtual ~IObjectLoader() { };
46 
50  virtual void setAnimationLoader(const AnimationLoaderPtr& animationLoader) = 0;
51 
53 
57  virtual void setAtlasLoader(const AtlasLoaderPtr& atlasLoader) = 0;
58 
59  virtual AtlasLoaderPtr getAtlasLoader() = 0;
60 
64  virtual bool isLoadable(const std::string& filename) const = 0;
65 
69  virtual void load(const std::string& filename) = 0;
70  };
71 
73 }
74 
75 #endif
SharedPtr< FIFE::IObjectLoader > ObjectLoaderPtr
Definition: iobjectloader.h:72
virtual void setAtlasLoader(const AtlasLoaderPtr &atlasLoader)=0
allows setting which atlas loader will be used to load atlas files
virtual ~IObjectLoader()
Definition: iobjectloader.h:45
virtual void load(const std::string &filename)=0
responsible for loading the object resource and populating the engine
virtual bool isLoadable(const std::string &filename) const =0
determines whether the resource is in the correct format for this loader
virtual AnimationLoaderPtr getAnimationLoader()=0
virtual void setAnimationLoader(const AnimationLoaderPtr &animationLoader)=0
allows setting which animation loader will be used to load animation files
Interface class that all object loaders should derive from.
Definition: iobjectloader.h:43
virtual AtlasLoaderPtr getAtlasLoader()=0