BaseViewControl

字段

1
2
3
4
5
6
7
8
9
self.id             ---@type ViewManager.view_xxx 枚举
self.uiLayer        ---@type ViewManager.UI_LAYER_XXX 枚举
self.uiClass        ---@type BaseUI | BaseSubUI | nil 类
self.sceneClass     ---@type any 类
self.pUI            ---@type BaseUI | BaseSubUI | nil 对象
self.pScene         ---@type any 对象
self.pDialogLayer   ---@type BaseSubUI 对象 弹窗层根节点
self._assetPath     ---@type table | string | nil 加载时首先加载的资源路径
self._subAssetPath  ---@type table | string | nil 加载完assetPath后加载的路径

初始化

1
2
3
4
5
6
7
8
9
10
11
12
13
14
--[[
    -@param id ViewManager.view_xxx 在ViewManager定义的id
    -@param uiClass BaseUI | BaseSubUI | nil 界面对应的主UI的类(不是对象)
    -@param sceneClass any | nil
    -@param uiLayer ViewManager.UI_LAYER_XXX | nil 在ViewManager定义的id

    -@desc 保存id, uiLayer, uiClass, sceneClass.
            根据id注册control, ViewManager.viewControlTab[id] = self .
            根据uiLayer注册id到不同的字典, ViewManager.viewXxxControlTab[id] = true . 

    !! uiLayer只能为 UI_LAYER_BACK | UI_LAYER_UI01 | UI_LAYER_UI02, nil时为UI_LAYER_BACK.
    !! 1个control只对应1个id, 并且只存在在一个uiLayer. 
]]
BaseViewControl:init(id, uiClass, sceneClass, uiLayer)

资源加载

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
--[[
    -@desc 返回基础资源路径, 对应self._assetPath的路径, 但不会为它赋值.
    -@return table | string | nil

    !! 路径为 "res/view/prefab/xxx/xxxUI.prefab" .
]]
BaseViewControl:getAssetPath()


--[[
    -@desc 返回次级资源路径, 对应self._subAssetPath的路径, 但不会为它赋值.
    -@return table | string | nil

    !! 路径为 "res/view/prefab/xxx/xxxUI.prefab" .
]]
BaseViewControl:getSubAssetPath()


--[[
    -@param sucCb fun():nil     加载成功回调
    -@param failCb fun():nil    加载失败回调
    -@param processCB fun():nil 加载进度回调

    -@desc 赋值self._assetPath = self:getAssetPath().
            然后调用self:loadAndCall(self_assetPath, ... )进行异步加载.          
]]
BaseViewControl:loadRes(sucCb, failCb, processCB)


--[[
    -@param assets table | string | nil 资源加载的路径
    -@param scb fun():nil       加载成功回调
    -@param fcb fun():nil       加载失败回调
    -@param processCB fun():nil 加载进度回调

    -@desc 通过DownLoadMission异步加载assets路径

    !! 注意当assets为nil时, 会直接调用scb表示成功加载资源.
]]
BaseViewControl:loadAndCall(assets, scb, fcb, processCB)

显示和添加

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
--[[
    -@param sucCb fun():nil
    -@param failCb fun():nil
    -@param processCB fun():nil

    -@desc 1. 通过self:loadRes()异步加载self:getAssetPath()中的资源并赋值self._assetPath .
            2. 通过self:loadRes()中的回调调用self.loadAndCall()来异步加载self:getSubAssetPath()中的资源
                并赋值self._subAssetPath .
            3. 对self._assetPath和self._subAssetPath进行资源引用计数(在C#端进行的计数).
            4. 

]]
BaseViewControl:openView(sucCb, failCb, processCB)


--[[

]]
BaseViewControl:addView()


--[[

]]
BaseViewControl:addScene()


--[[

]]
BaseViewControl:addUI()



隐藏和移除

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
--[[
    -@param autoShow boolean
    -@desc 移除系统.
            1. 移除资源引用.                 移除C#端的资源引用计数.
            2. 调用self:removeData()        移除数据
            3. 调用self:removeDialogLayer() 移除弹窗, self.pDialogLayer = nil .
            4. 调用self:removeUI()          移除主UI, self.pUI = nil .
            5. 调用self:removeScene()       移除场景, self.pScene = nil .
            6. 调用ViewManager:removeViewFinally() 移除系统最后调用.
]]
BaseViewControl:removeView(autoShow)


--[[
    -@desc 移除数据, 函数为空, 可以重写.
]]
BaseViewControl:removeData()


--[[
    -@desc 移除该系统所有弹窗, 并将self.pDialogLayer根节点也移除置nil.
]]
BaseViewControl:removeDialogLayer()


--[[
    -@desc 移除该系统主UI, 并将self.pUI置nil.
]]
BaseViewControl:removeUI()


--[[
    -@desc 移除该系统场景, 并将self.pScene置nil
]]
BaseViewControl:removeScene()


--[[
    -@desc 根据uiLayer分4种情况:
            对于ViewManager.UI_LAYER_BACK, 会移除其他所有前三层的control, 通过control:removeView().
            对于ViewManager.UI_LAYER_UI01, 会隐藏其他所有前三层的control, 通过control:hideView().
            对于ViewManager.UI_LAYER_UI02, 会隐藏UI01, UI02的control, 通过control:hideView().
]]
BaseViewControl:removeOrHideOtherView()


--[[
    -@desc 隐藏系统.
            1. self.pUI:hide() 进行主ui的隐藏.
            2. self.pScene:hide() 进行场景的隐藏.
            3. self.pDialogLayer:hide() 进行弹窗的隐藏.
            4. 进行 BaseViewControl:onHideView() 的回调.
]]
BaseViewControl:hideView()