MyGUI: MyGUI_LayerManager.h Source File

MyGUI 3.4.3

MyGUI_LayerManager.h
Go to the documentation of this file.
1/*
2 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
3 * Distributed under the MIT License
4 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
5 */
6
7#ifndef MYGUI_LAYER_MANAGER_H_
8#define MYGUI_LAYER_MANAGER_H_
9
10#include "MyGUI_Prerequest.h"
11#include "MyGUI_Singleton.h"
12#include "MyGUI_Enumerator.h"
13#include "MyGUI_XmlDocument.h"
14#include "MyGUI_IUnlinkWidget.h"
15#include "MyGUI_ResourceManager.h"
16#include "MyGUI_ILayer.h"
17#include "MyGUI_BackwardCompatibility.h"
18
19namespace MyGUI
20{
21
22 class MYGUI_EXPORT LayerManager : public IUnlinkWidget, public MemberObsolete<LayerManager>
23 {
24 MYGUI_SINGLETON_DECLARATION(LayerManager);
25
26 public:
27 using VectorLayer = std::vector<ILayer*>;
28 using EnumeratorLayer = Enumerator<VectorLayer>;
29
30 public:
31 LayerManager();
32
33 void initialise();
34 void shutdown();
35
40 void attachToLayerNode(std::string_view _name, Widget* _item);
44 void detachFromLayer(Widget* _item);
45
49 void upLayerItem(Widget* _item);
50
52 bool isExist(std::string_view _name) const;
54 EnumeratorLayer getEnumerator() const;
55
61 ILayer* createLayerAt(std::string_view _name, std::string_view _type, size_t _index);
62
64 ILayer* getByName(std::string_view _name, bool _throw = true) const;
65
66 size_t getLayerCount() const;
67
68 ILayer* getLayer(size_t _index) const;
69
71 Widget* getWidgetFromPoint(int _left, int _top) const;
72
74 void renderToTarget(IRenderTarget* _target, bool _update);
75
76 void resizeView(const IntSize& _viewSize);
77
78 const std::string& getCategoryName() const;
79
80 private:
81 void _load(xml::ElementPtr _node, std::string_view _file, Version _version);
82 void _unlinkWidget(Widget* _widget) override;
83
84 ILayer* _createLayerObject(std::string_view _type);
85
86 void clear();
87
88 void merge(VectorLayer& _layers);
89 void destroy(ILayer* _layer);
90
91 private:
92 VectorLayer mLayerNodes;
93
94 bool mIsInitialise{false};
95 std::string mCategoryName;
96 };
97
98} // namespace MyGUI
99
100#endif // MYGUI_LAYER_MANAGER_H_
MyGUI_BackwardCompatibility.h
MyGUI_Enumerator.h
MyGUI_ILayer.h
MyGUI_IUnlinkWidget.h
MYGUI_EXPORT
#define MYGUI_EXPORT
Definition MyGUI_Platform.h:77
MyGUI_Prerequest.h
MyGUI_ResourceManager.h
MyGUI_Singleton.h
MYGUI_SINGLETON_DECLARATION
#define MYGUI_SINGLETON_DECLARATION(ClassName)
Definition MyGUI_Singleton.h:112
MyGUI_XmlDocument.h
MyGUI::Enumerator
Definition MyGUI_Enumerator.h:49
MyGUI::ILayer
Definition MyGUI_ILayer.h:22
MyGUI::IRenderTarget
Definition MyGUI_IRenderTarget.h:21
MyGUI::IUnlinkWidget
Definition MyGUI_IUnlinkWidget.h:17
MyGUI::LayerManager::detachFromLayer
void detachFromLayer(Widget *_item)
Definition MyGUI_LayerManager.cpp:145
MyGUI::LayerManager::upLayerItem
void upLayerItem(Widget *_item)
Definition MyGUI_LayerManager.cpp:151
MyGUI::LayerManager::getLayer
ILayer * getLayer(size_t _index) const
Definition MyGUI_LayerManager.cpp:259
MyGUI::LayerManager::getCategoryName
const std::string & getCategoryName() const
Definition MyGUI_LayerManager.cpp:265
MyGUI::LayerManager::LayerManager
LayerManager(const LayerManager &)=delete
MyGUI::LayerManager::getEnumerator
EnumeratorLayer getEnumerator() const
Definition MyGUI_LayerManager.cpp:243
MyGUI::LayerManager::getLayerCount
size_t getLayerCount() const
Definition MyGUI_LayerManager.cpp:254
MyGUI::LayerManager::createLayerAt
ILayer * createLayerAt(std::string_view _name, std::string_view _type, size_t _index)
Definition MyGUI_LayerManager.cpp:193
MyGUI::LayerManager::renderToTarget
void renderToTarget(IRenderTarget *_target, bool _update)
Definition MyGUI_LayerManager.cpp:224
MyGUI::LayerManager::shutdown
void shutdown()
Definition MyGUI_LayerManager.cpp:44
MyGUI::LayerManager::VectorLayer
std::vector< ILayer * > VectorLayer
Definition MyGUI_LayerManager.h:27
MyGUI::LayerManager::getByName
ILayer * getByName(std::string_view _name, bool _throw=true) const
Definition MyGUI_LayerManager.cpp:232
MyGUI::LayerManager::resizeView
void resizeView(const IntSize &_viewSize)
Definition MyGUI_LayerManager.cpp:248
MyGUI::LayerManager::attachToLayerNode
void attachToLayerNode(std::string_view _name, Widget *_item)
Definition MyGUI_LayerManager.cpp:122
MyGUI::LayerManager::getWidgetFromPoint
Widget * getWidgetFromPoint(int _left, int _top) const
Definition MyGUI_LayerManager.cpp:211
MyGUI::LayerManager::initialise
void initialise()
Definition MyGUI_LayerManager.cpp:29
MyGUI::LayerManager::EnumeratorLayer
Enumerator< VectorLayer > EnumeratorLayer
Definition MyGUI_LayerManager.h:28
MyGUI::LayerManager::isExist
bool isExist(std::string_view _name) const
Definition MyGUI_LayerManager.cpp:157
MyGUI::MemberObsolete
Definition MyGUI_DeprecatedTypes.h:14
MyGUI::Version
Definition MyGUI_Version.h:18
MyGUI::Widget
widget description should be here.
Definition MyGUI_Widget.h:40
MyGUI::xml::ElementPtr
Element * ElementPtr
Definition MyGUI_XmlDocument.h:112
MyGUI
Definition MyGUI_ActionController.h:15
MyGUI::IntSize
types::TSize< int > IntSize
Definition MyGUI_Types.h:30