Zed-Unity插件代码注释——ZEDLayersManager.cs

Love The Way You Lie 2022-12-03 02:24 138阅读 0赞

### 文章目录 ###

*  Zed-Unity插件代码注释——ZEDLayersManager.cs
 *   *  引言
     *  基础环境
     *  ZEDLayersManager.cs脚本介绍
     *  代码（注释后）

# Zed-Unity插件代码注释——ZEDLayersManager.cs #

## 引言 ##

略(2020-09-01 15.50)

## 基础环境 ##

略(2020-09-01 15.58)

## ZEDLayersManager.cs脚本介绍 ##

*  脚本位置：

![在这里插入图片描述][20200901155900285.png_pic_center]

*  脚本功能：

这个脚本比较短，主要是在Unity启动的时候创建两个图层，一个图层可以在AR模式下被看到，一个看不到。 这个是为了混合现实的时候，控制用户看到的对象。例如把Unity的背景放在看不到的图层里面，然后把虚拟的人物放在可看到的图层里面。同时里面还定义了一个方法用以清除图层。

*  脚本使用  
    这个脚本是在编辑器阶段使用的，一般我们不会直接对里面的函数进行调用，但是里面创建的两个图层对我们来说比较重要。  
    unity中默认一共有31个图层，但不一定全都会被使用上，一般0~7图层被unity默认占用，我们只可以自定义8 ~ 31的图层。  
    这个脚本默认情况下会把不可见的图层定义在16层， 而把可见的ar图层定义在30层。具体原因可能跟习惯有关？？？  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NjeTI2MTk4MzYyNg_size_3_color_FFFFFF_t_70_pic_center]
 *  代码结构  
    这个脚本比较短，代码结构比较简单，就是先定义了一个图层结构体，里面是图层的一些固定参数，然后定义了图层管理类，类里面两个函数，一个用于创建指定2个图层，一个用于清除给定名称的图层。  
    ![在这里插入图片描述][20200901160911920.png_pic_center]

## 代码（注释后） ##

#if UNITY_EDITOR //Editor Lance: 条件编译， 指的是满足条件的话 把下面的引用对象添加进来
    using UnityEditor;
    #endif
    /* * Editor:lance * */
    /// <summary>
    /// This class creates automaticaly layers on load
    /// 此类在加载时自动创建图层
    /// Editor lances:创建的这个图层估计是ZED对象的主要图像 例如 画布等
    /// </summary>
    public struct ZEDLayers
    { 
    
        public static int tagInvisibleToZED = 16; //不可见的图层序号为16层，
        public static string ID_tagInvisibleToZED = "tagInvisibleToZED";  //图层名称，这个图层对ZED是不可见的
                                                                          //这个估计指的是在AR模式下 用户看不见的图层，例如Unity中的背景
        public static int arlayer = 30 ;    //定义 AR的图像序号，为30层，
        public static string ID_arlayer = "arlayer";  // AR图层的名称
    }
    
    #if UNITY_EDITOR
    
    [InitializeOnLoad] // Editor Lance: 监听Unity启动事件 https://blog.csdn.net/huutu/article/details/42318499
    public static class ZEDLayersManager
    { 
        static ZEDLayersManager() //构造函数，类的初始化
        { 
            CreateLayer(ZEDLayers.ID_tagInvisibleToZED, ZEDLayers.tagInvisibleToZED); //创建ZED不可见的图层
            CreateLayer(ZEDLayers.ID_arlayer, ZEDLayers.arlayer);//创建AR图层
        }
        /// <summary>
        /// 创建图层的函数
        /// </summary>
        /// <param name="layerName"> 图层名称</param>
        /// <param name="layerIndex">图层序号</param>
        public static void CreateLayer(string layerName, int layerIndex)
        { 
            // Editor Lance: 代码的用法 https://docs.unity3d.com/ScriptReference/AssetDatabase.LoadAllAssetsAtPath.html
            UnityEngine.Object[] asset = AssetDatabase.LoadAllAssetsAtPath("ProjectSettings/TagManager.asset"); // Editor Lance:加载Unity工程里面的TagManager的资源
    
            if (layerIndex < 7 || layerIndex > 31) return; //Invalid ID. Editor Lance:unity默认占用了0~7的图层，然后只有8~31的图层可以被自定义
            if ((asset != null) && (asset.Length > 0)) //资源里面有东西
            { 
                //Editor Lance: 官方解释 https://docs.unity3d.com/ScriptReference/SerializedObject.html 但是我没看懂具体的意思
                //Editor Lance: 博客解释 https://blog.csdn.net/weixin_30360497/article/details/98998280?utm_medium=distribute.pc_relevant.none-task-blog-title-1&spm=1001.2101.3001.4242
                //Editor Lance: 大概的意思就是生成的这个实例是一个被序列化的物品对象，序列化的意思是说在面板上是可见的。
                SerializedObject serializedObject = new SerializedObject(asset[0]); //asset[0]应该是主要的对象
                SerializedProperty layers = serializedObject.FindProperty("layers");  // 这个对象有一个叫layers字段的属性
    
                for (int i = 0; i < layers.arraySize; ++i) //这个对象是个数组?遍历其中的元素
                { 
                    if (layers.GetArrayElementAtIndex(i).stringValue == layerName) //如果存在我们要创建的层，则修改对应的图层序号
                    { 
                        layerIndex = i;//
                        return;     // Layer already present, update layerindex value.
                    }
                }
                // Editor Lance:如果上面遍历后发现没有我们要的图层，我们要重新创建
                if (layers.GetArrayElementAtIndex(layerIndex).stringValue == "") // 如果索引的图层还是空的
                { 
                    layers.GetArrayElementAtIndex(layerIndex).stringValue = layerName; // 赋值图层名称
                    serializedObject.ApplyModifiedProperties(); //应用修改后的属性
                    serializedObject.Update();//更新
                    if (layers.GetArrayElementAtIndex(layerIndex).stringValue == layerName)
                    { 
                        return;     // to avoid unity locked layer
                    }
                }
            }
        }
    
    
        /// <summary>
        /// 清除指定的图层名曾
        /// </summary>
        /// <param name="layerName"></param>
        public static void ClearLayer(string layerName)
        { 
            UnityEngine.Object[] asset = AssetDatabase.LoadAllAssetsAtPath("ProjectSettings/TagManager.asset");
    
            if ((asset != null) && (asset.Length > 0))
            { 
                SerializedObject serializedObject = new SerializedObject(asset[0]);
                SerializedProperty layers = serializedObject.FindProperty("layers"); //Editor Lance:前面代码可以认为是对图层操作的固定代码
    
                for (int i = 0; i < layers.arraySize; ++i)
                { 
                    if (layers.GetArrayElementAtIndex(i).stringValue == layerName)
                    { 
                        layers.GetArrayElementAtIndex(i).stringValue = "";
                    }
                }
                serializedObject.ApplyModifiedProperties(); //需要调用这两个函数，才可以完成修改
                serializedObject.Update();//需要调用这两个函数，才可以完成修改
            }
        }
    }
    #endif

[20200901155900285.png_pic_center]: /images/20221123/cfed486f0489462dad7d9202c819dc7e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NjeTI2MTk4MzYyNg_size_3_color_FFFFFF_t_70_pic_center]: /images/20221123/d253303a5070457b904394213f2f725e.png
[20200901160911920.png_pic_center]: /images/20221123/aee5b21171e74f32879dad29d68146ed.png