123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382 |
- //------------------------------------------------------------
- // Game Framework
- // Copyright © 2013-2021 loyalsoft. All rights reserved.
- // Homepage: http://www.game7000.com/
- // Feedback: http://www.game7000.com/
- //------------------------------------------------------------
- using GameFramework.ObjectPool;
- using GameFramework.Resource;
- using System;
- using System.Collections.Generic;
- namespace GameFramework.UI
- {
- /// <summary>
- /// 界面管理器接口。
- /// </summary>
- public interface IUIManager
- {
- /// <summary>
- /// 获取界面组数量。
- /// </summary>
- int UIGroupCount
- {
- get;
- }
- /// <summary>
- /// 获取或设置界面实例对象池自动释放可释放对象的间隔秒数。
- /// </summary>
- float InstanceAutoReleaseInterval
- {
- get;
- set;
- }
- /// <summary>
- /// 获取或设置界面实例对象池的容量。
- /// </summary>
- int InstanceCapacity
- {
- get;
- set;
- }
- /// <summary>
- /// 获取或设置界面实例对象池对象过期秒数。
- /// </summary>
- float InstanceExpireTime
- {
- get;
- set;
- }
- /// <summary>
- /// 获取或设置界面实例对象池的优先级。
- /// </summary>
- int InstancePriority
- {
- get;
- set;
- }
- /// <summary>
- /// 打开界面成功事件。
- /// </summary>
- event EventHandler<OpenUIFormSuccessEventArgs> OpenUIFormSuccess;
- /// <summary>
- /// 打开界面失败事件。
- /// </summary>
- event EventHandler<OpenUIFormFailureEventArgs> OpenUIFormFailure;
- /// <summary>
- /// 打开界面更新事件。
- /// </summary>
- event EventHandler<OpenUIFormUpdateEventArgs> OpenUIFormUpdate;
- /// <summary>
- /// 打开界面时加载依赖资源事件。
- /// </summary>
- event EventHandler<OpenUIFormDependencyAssetEventArgs> OpenUIFormDependencyAsset;
- /// <summary>
- /// 关闭界面完成事件。
- /// </summary>
- event EventHandler<CloseUIFormCompleteEventArgs> CloseUIFormComplete;
- /// <summary>
- /// 设置对象池管理器。
- /// </summary>
- /// <param name="objectPoolManager">对象池管理器。</param>
- void SetObjectPoolManager(IObjectPoolManager objectPoolManager);
- /// <summary>
- /// 设置资源管理器。
- /// </summary>
- /// <param name="resourceManager">资源管理器。</param>
- void SetResourceManager(IResourceManager resourceManager);
- /// <summary>
- /// 设置界面辅助器。
- /// </summary>
- /// <param name="uiFormHelper">界面辅助器。</param>
- void SetUIFormHelper(IUIFormHelper uiFormHelper);
- /// <summary>
- /// 是否存在界面组。
- /// </summary>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <returns>是否存在界面组。</returns>
- bool HasUIGroup(string uiGroupName);
- /// <summary>
- /// 获取界面组。
- /// </summary>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <returns>要获取的界面组。</returns>
- IUIGroup GetUIGroup(string uiGroupName);
- /// <summary>
- /// 获取所有界面组。
- /// </summary>
- /// <returns>所有界面组。</returns>
- IUIGroup[] GetAllUIGroups();
- /// <summary>
- /// 获取所有界面组。
- /// </summary>
- /// <param name="results">所有界面组。</param>
- void GetAllUIGroups(List<IUIGroup> results);
- /// <summary>
- /// 增加界面组。
- /// </summary>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="uiGroupHelper">界面组辅助器。</param>
- /// <returns>是否增加界面组成功。</returns>
- bool AddUIGroup(string uiGroupName, IUIGroupHelper uiGroupHelper);
- /// <summary>
- /// 增加界面组。
- /// </summary>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="uiGroupDepth">界面组深度。</param>
- /// <param name="uiGroupHelper">界面组辅助器。</param>
- /// <returns>是否增加界面组成功。</returns>
- bool AddUIGroup(string uiGroupName, int uiGroupDepth, IUIGroupHelper uiGroupHelper);
- /// <summary>
- /// 是否存在界面。
- /// </summary>
- /// <param name="serialId">界面序列编号。</param>
- /// <returns>是否存在界面。</returns>
- bool HasUIForm(int serialId);
- /// <summary>
- /// 是否存在界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <returns>是否存在界面。</returns>
- bool HasUIForm(string uiFormAssetName);
- /// <summary>
- /// 获取界面。
- /// </summary>
- /// <param name="serialId">界面序列编号。</param>
- /// <returns>要获取的界面。</returns>
- IUIForm GetUIForm(int serialId);
- /// <summary>
- /// 获取界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <returns>要获取的界面。</returns>
- IUIForm GetUIForm(string uiFormAssetName);
- /// <summary>
- /// 获取界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <returns>要获取的界面。</returns>
- IUIForm[] GetUIForms(string uiFormAssetName);
- /// <summary>
- /// 获取界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="results">要获取的界面。</param>
- void GetUIForms(string uiFormAssetName, List<IUIForm> results);
- /// <summary>
- /// 获取所有已加载的界面。
- /// </summary>
- /// <returns>所有已加载的界面。</returns>
- IUIForm[] GetAllLoadedUIForms();
- /// <summary>
- /// 获取所有已加载的界面。
- /// </summary>
- /// <param name="results">所有已加载的界面。</param>
- void GetAllLoadedUIForms(List<IUIForm> results);
- /// <summary>
- /// 获取所有正在加载界面的序列编号。
- /// </summary>
- /// <returns>所有正在加载界面的序列编号。</returns>
- int[] GetAllLoadingUIFormSerialIds();
- /// <summary>
- /// 获取所有正在加载界面的序列编号。
- /// </summary>
- /// <param name="results">所有正在加载界面的序列编号。</param>
- void GetAllLoadingUIFormSerialIds(List<int> results);
- /// <summary>
- /// 是否正在加载界面。
- /// </summary>
- /// <param name="serialId">界面序列编号。</param>
- /// <returns>是否正在加载界面。</returns>
- bool IsLoadingUIForm(int serialId);
- /// <summary>
- /// 是否正在加载界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <returns>是否正在加载界面。</returns>
- bool IsLoadingUIForm(string uiFormAssetName);
- /// <summary>
- /// 是否是合法的界面。
- /// </summary>
- /// <param name="uiForm">界面。</param>
- /// <returns>界面是否合法。</returns>
- bool IsValidUIForm(IUIForm uiForm);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="priority">加载界面资源的优先级。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, int priority);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="pauseCoveredUIForm">是否暂停被覆盖的界面。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, bool pauseCoveredUIForm);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, object userData);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="priority">加载界面资源的优先级。</param>
- /// <param name="pauseCoveredUIForm">是否暂停被覆盖的界面。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, int priority, bool pauseCoveredUIForm);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="priority">加载界面资源的优先级。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, int priority, object userData);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="pauseCoveredUIForm">是否暂停被覆盖的界面。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, bool pauseCoveredUIForm, object userData);
- /// <summary>
- /// 打开界面。
- /// </summary>
- /// <param name="uiFormAssetName">界面资源名称。</param>
- /// <param name="uiGroupName">界面组名称。</param>
- /// <param name="priority">加载界面资源的优先级。</param>
- /// <param name="pauseCoveredUIForm">是否暂停被覆盖的界面。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>界面的序列编号。</returns>
- int OpenUIForm(string uiFormAssetName, string uiGroupName, int priority, bool pauseCoveredUIForm, object userData);
- /// <summary>
- /// 关闭界面。
- /// </summary>
- /// <param name="serialId">要关闭界面的序列编号。</param>
- void CloseUIForm(int serialId);
- /// <summary>
- /// 关闭界面。
- /// </summary>
- /// <param name="serialId">要关闭界面的序列编号。</param>
- /// <param name="userData">用户自定义数据。</param>
- void CloseUIForm(int serialId, object userData);
- /// <summary>
- /// 关闭界面。
- /// </summary>
- /// <param name="uiForm">要关闭的界面。</param>
- void CloseUIForm(IUIForm uiForm);
- /// <summary>
- /// 关闭界面。
- /// </summary>
- /// <param name="uiForm">要关闭的界面。</param>
- /// <param name="userData">用户自定义数据。</param>
- void CloseUIForm(IUIForm uiForm, object userData);
- /// <summary>
- /// 关闭所有已加载的界面。
- /// </summary>
- void CloseAllLoadedUIForms();
- /// <summary>
- /// 关闭所有已加载的界面。
- /// </summary>
- /// <param name="userData">用户自定义数据。</param>
- void CloseAllLoadedUIForms(object userData);
- /// <summary>
- /// 关闭所有正在加载的界面。
- /// </summary>
- void CloseAllLoadingUIForms();
- /// <summary>
- /// 激活界面。
- /// </summary>
- /// <param name="uiForm">要激活的界面。</param>
- void RefocusUIForm(IUIForm uiForm);
- /// <summary>
- /// 激活界面。
- /// </summary>
- /// <param name="uiForm">要激活的界面。</param>
- /// <param name="userData">用户自定义数据。</param>
- void RefocusUIForm(IUIForm uiForm, object userData);
- /// <summary>
- /// 设置界面实例是否被加锁。
- /// </summary>
- /// <param name="uiFormInstance">要设置是否被加锁的界面实例。</param>
- /// <param name="locked">界面实例是否被加锁。</param>
- void SetUIFormInstanceLocked(object uiFormInstance, bool locked);
- /// <summary>
- /// 设置界面实例的优先级。
- /// </summary>
- /// <param name="uiFormInstance">要设置优先级的界面实例。</param>
- /// <param name="priority">界面实例优先级。</param>
- void SetUIFormInstancePriority(object uiFormInstance, int priority);
- }
- }
|