aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/irrlicht-1.8/include/ISceneLoader.h
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/irrlicht-1.8/include/ISceneLoader.h')
-rw-r--r--libraries/irrlicht-1.8/include/ISceneLoader.h124
1 files changed, 62 insertions, 62 deletions
diff --git a/libraries/irrlicht-1.8/include/ISceneLoader.h b/libraries/irrlicht-1.8/include/ISceneLoader.h
index c71c15d..45a80f3 100644
--- a/libraries/irrlicht-1.8/include/ISceneLoader.h
+++ b/libraries/irrlicht-1.8/include/ISceneLoader.h
@@ -1,62 +1,62 @@
1// Copyright (C) 2010-2012 Nikolaus Gebhardt 1// Copyright (C) 2010-2012 Nikolaus Gebhardt
2// This file is part of the "Irrlicht Engine". 2// This file is part of the "Irrlicht Engine".
3// For conditions of distribution and use, see copyright notice in irrlicht.h 3// For conditions of distribution and use, see copyright notice in irrlicht.h
4 4
5#ifndef __I_SCENE_LOADER_H_INCLUDED__ 5#ifndef __I_SCENE_LOADER_H_INCLUDED__
6#define __I_SCENE_LOADER_H_INCLUDED__ 6#define __I_SCENE_LOADER_H_INCLUDED__
7 7
8#include "IReferenceCounted.h" 8#include "IReferenceCounted.h"
9#include "path.h" 9#include "path.h"
10 10
11namespace irr 11namespace irr
12{ 12{
13namespace io 13namespace io
14{ 14{
15 class IReadFile; 15 class IReadFile;
16} // end namespace io 16} // end namespace io
17namespace scene 17namespace scene
18{ 18{
19 class ISceneNode; 19 class ISceneNode;
20 class ISceneUserDataSerializer; 20 class ISceneUserDataSerializer;
21 21
22//! Class which can load a scene into the scene manager. 22//! Class which can load a scene into the scene manager.
23/** If you want Irrlicht to be able to load currently unsupported 23/** If you want Irrlicht to be able to load currently unsupported
24scene file formats (e.g. .vrml), then implement this and add your 24scene file formats (e.g. .vrml), then implement this and add your
25new Sceneloader to the engine with ISceneManager::addExternalSceneLoader(). */ 25new Sceneloader to the engine with ISceneManager::addExternalSceneLoader(). */
26class ISceneLoader : public virtual IReferenceCounted 26class ISceneLoader : public virtual IReferenceCounted
27{ 27{
28public: 28public:
29 29
30 //! Returns true if the class might be able to load this file. 30 //! Returns true if the class might be able to load this file.
31 /** This decision should be based on the file extension (e.g. ".vrml") 31 /** This decision should be based on the file extension (e.g. ".vrml")
32 only. 32 only.
33 \param filename Name of the file to test. 33 \param filename Name of the file to test.
34 \return True if the extension is a recognised type. */ 34 \return True if the extension is a recognised type. */
35 virtual bool isALoadableFileExtension(const io::path& filename) const = 0; 35 virtual bool isALoadableFileExtension(const io::path& filename) const = 0;
36 36
37 //! Returns true if the class might be able to load this file. 37 //! Returns true if the class might be able to load this file.
38 /** This decision will be based on a quick look at the contents of the file. 38 /** This decision will be based on a quick look at the contents of the file.
39 \param file The file to test. 39 \param file The file to test.
40 \return True if the extension is a recognised type. */ 40 \return True if the extension is a recognised type. */
41 virtual bool isALoadableFileFormat(io::IReadFile* file) const = 0; 41 virtual bool isALoadableFileFormat(io::IReadFile* file) const = 0;
42 42
43 //! Loads the scene into the scene manager. 43 //! Loads the scene into the scene manager.
44 /** \param file File which contains the scene. 44 /** \param file File which contains the scene.
45 \param userDataSerializer: If you want to load user data which may be attached 45 \param userDataSerializer: If you want to load user data which may be attached
46 to some some scene nodes in the file, implement the ISceneUserDataSerializer 46 to some some scene nodes in the file, implement the ISceneUserDataSerializer
47 interface and provide it as parameter here. Otherwise, simply specify 0 as this 47 interface and provide it as parameter here. Otherwise, simply specify 0 as this
48 parameter. 48 parameter.
49 \param rootNode The node to load the scene into, if none is provided then the 49 \param rootNode The node to load the scene into, if none is provided then the
50 scene will be loaded into the root node. 50 scene will be loaded into the root node.
51 \return Returns true on success, false on failure. Returns 0 if loading failed. */ 51 \return Returns true on success, false on failure. Returns 0 if loading failed. */
52 virtual bool loadScene(io::IReadFile* file, ISceneUserDataSerializer* userDataSerializer=0, 52 virtual bool loadScene(io::IReadFile* file, ISceneUserDataSerializer* userDataSerializer=0,
53 ISceneNode* rootNode=0) = 0; 53 ISceneNode* rootNode=0) = 0;
54 54
55}; 55};
56 56
57 57
58} // end namespace scene 58} // end namespace scene
59} // end namespace irr 59} // end namespace irr
60 60
61#endif 61#endif
62 62