UIElements 开源项目教程

UIElements 开源项目教程

UIElementsVarious scripts related to Unity UI Toolkit (UIElements).项目地址:https://gitcode.com/gh_mirrors/ui/UIElements

1. 项目的目录结构及介绍

UIElements 项目的目录结构如下：

UIElements/
├── Assets/
│   ├── Editor/
│   │   ├── UIElements/
│   │   │   ├── Styles/
│   │   │   │   └── DefaultStyles.uss
│   │   │   ├── Templates/
│   │   │   │   └── DefaultTemplate.uxml
│   │   │   ├── UIElementsEditorWindow.cs
│   │   │   └── UIElementsUtility.cs
│   ├── Runtime/
│   │   ├── UIElements/
│   │   │   ├── Controls/
│   │   │   │   ├── Button.cs
│   │   │   │   ├── Label.cs
│   │   │   │   └── ...
│   │   │   ├── Core/
│   │   │   │   ├── VisualElement.cs
│   │   │   │   └── ...
│   │   │   └── UIElementsRuntime.cs
├── README.md
├── LICENSE
└── .gitignore

目录结构介绍

• Assets/: 项目的主要资源文件夹。
  • Editor/: 包含编辑器相关的脚本和资源。
    • UIElements/: UIElements 编辑器扩展的核心文件夹。
      • Styles/: 包含样式文件（.uss）。
      • Templates/: 包含模板文件（.uxml）。
      • UIElementsEditorWindow.cs: 编辑器窗口的入口文件。
      • UIElementsUtility.cs: 编辑器工具类。
  • Runtime/: 包含运行时相关的脚本和资源。
    • UIElements/: UIElements 运行时的核心文件夹。
      • Controls/: 包含各种 UI 控件的实现。
      • Core/: 包含核心类和接口。
      • UIElementsRuntime.cs: 运行时的入口文件。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

编辑器启动文件

UIElementsEditorWindow.cs 是 UIElements 编辑器扩展的入口文件。它负责初始化编辑器窗口并加载必要的资源。

using UnityEditor;
using UnityEngine.UIElements;

public class UIElementsEditorWindow : EditorWindow
{
    [MenuItem("Window/UIElements/Open Editor")]
    public static void OpenEditor()
    {
        GetWindow<UIElementsEditorWindow>("UIElements Editor");
    }

    private void OnEnable()
    {
        var visualTree = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/Editor/UIElements/Templates/DefaultTemplate.uxml");
        VisualElement root = rootVisualElement;
        visualTree.CloneTree(root);

        var styleSheet = AssetDatabase.LoadAssetAtPath<StyleSheet>("Assets/Editor/UIElements/Styles/DefaultStyles.uss");
        root.styleSheets.Add(styleSheet);
    }
}

运行时启动文件

UIElementsRuntime.cs 是 UIElements 运行时的入口文件。它负责初始化运行时环境并加载必要的资源。

using UnityEngine;
using UnityEngine.UIElements;

public class UIElementsRuntime : MonoBehaviour
{
    private void Start()
    {
        var visualTree = Resources.Load<VisualTreeAsset>("UIElements/Templates/DefaultTemplate");
        VisualElement root = GetComponent<UIDocument>().rootVisualElement;
        visualTree.CloneTree(root);

        var styleSheet = Resources.Load<StyleSheet>("UIElements/Styles/DefaultStyles");
        root.styleSheets.Add(styleSheet);
    }
}

3. 项目的配置文件介绍

样式文件

DefaultStyles.uss 是 UIElements 的默认样式文件。它定义了各种 UI 元素的样式。

/* DefaultStyles.uss */
.button {
    background-color: #4CAF50;
    color: white;
    padding: 10px 20px;
    border-radius: 5px;
    font

UIElementsVarious scripts related to Unity UI Toolkit (UIElements).项目地址:https://gitcode.com/gh_mirrors/ui/UIElements