Version: 2023.1
言語: 日本語
トランジションイベントの作成
UI Renderer

ループする遷移の作成

バージョン: 2022.1 以降

この例では、TransitionEndEvent を活用してループする遷移を作成する方法を紹介します。

例の概要

この例では、2 つのループするアニメーションを紹介します。

  • ヨーヨー: 状態 A から状態 B に遷移し、遷移しながら状態 A に戻るループ。
  • A から B: 状態 A から状態 B に遷移し、遷移せずに状態 A に戻るループ。
ウィンドウはヨーヨーと A から B ループの遷移効果を表示します
ウィンドウはヨーヨーと A から B ループの遷移効果を表示します

この例で作成するすべてのファイルは、GitHub リポジトリ にあります。

要件

このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。

例の作成

  1. Unity で任意のテンプレートでプロジェクトを作成します。

  2. Project ウィンドウに、loop-transition-example という名前のフォルダーを作成します。

  3. そのフォルダー上で右クリックし、Create > UI Toolkit > Editor Window を選択します。

  4. UI Toolkit Editor Window Creator ウィンドウに、LoopingExample と入力します。

  5. 変更を保存します。これにより、LoopingExample.csLoopingExample.ussLoopingExample.uxml という 3 つのファイルが作成されます。

  6. LoopingExample.cs を以下のコンテンツに置き換えます。

    using UnityEditor;
    using UnityEngine;
    using UnityEngine.UIElements;
    public class LoopingExample : EditorWindow
    {
        [SerializeField] private VisualTreeAsset m_VisualTreeAsset = default;
        private Label _yoyoLabel;
        private Label _a2bLabel;
        [MenuItem("Window/UI Toolkit/Transition Looping Example")]
        public static void ShowExample()
        {
            var wnd = GetWindow<LoopingExample>();
            wnd.titleContent = new GUIContent("TransitionStyle");
        }
        public void CreateGUI()
        {
            VisualElement root = rootVisualElement;
            VisualElement asset = m_VisualTreeAsset.Instantiate();
            root.Add(asset);
            SetupYoyo(root);
            SetupA2B(root);
        }
        // This method powers the yo-yo loop.
        private void SetupYoyo(VisualElement root)
        {
            _yoyoLabel = root.Q<Label>(name: "yoyo-label");
            // When the animation ends, the callback toggles a class to set the scale to 1.3 
            // or back to 1.0 when it's removed.
            _yoyoLabel.RegisterCallback<TransitionEndEvent>(evt => _yoyoLabel.ToggleInClassList("enlarge-scale-yoyo"));
            // Schedule the first transition 100 milliseconds after the root.schedule.Execute method is called.
            root.schedule.Execute(() => _yoyoLabel.ToggleInClassList("enlarge-scale-yoyo")).StartingIn(100);
        }
        // This method powers the A-to-B cycle.
        private void SetupA2B(VisualElement root)
        {
            _a2bLabel = root.Q<Label>(name:"a2b-label");
            _a2bLabel.RegisterCallback<TransitionEndEvent>(evt =>
            {
                _a2bLabel.RemoveFromClassList("enlarge-scale-a2b");
                _a2bLabel.schedule.Execute(() => _a2bLabel.AddToClassList("enlarge-scale-a2b")).StartingIn(10);
            });
            _a2bLabel.schedule.Execute(() => _a2bLabel.AddToClassList("enlarge-scale-a2b")).StartingIn(100);
        }
    }
    
  7. LoopingExample.uxml を以下のコンテンツに置き換えます。

    <ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" 
             xsi="http://www.w3.org/2001/XMLSchema-instance" 
             engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" 
             noNamespaceSchemaLocation="../../../../UIElementsSchema/UIElements.xsd" 
             editor-extension-mode="False">
        <Style src="LoopingExample.uss" />
        <ui:VisualElement name="container">
            <ui:VisualElement>
                    <ui:Label text="Yo-yo Transition" name="yoyo-label" class="text-style" />
            </ui:VisualElement>
            <ui:VisualElement>
                    <ui:Label text="A-to-B Transition" name="a2b-label" class="text-style"/>
            </ui:VisualElement>
        </ui:VisualElement>
    </ui:UXML>
    
  8. LoopingExample.uss を以下のコンテンツに置き換えます。

        #yoyo-label{
                transition-duration: 3s;
            }
    
            .text-style {
                font-size: 20px;
                flex-grow: 0;
                margin: 20px; 
            }
    
            .enlarge-scale-a2b{
                scale: 1.5 1.5;
                transition-duration: 3s;
            }
        
            .enlarge-scale-yoyo{
                scale: 1.5 1.5;
            }
    
            #container{
                flex-grow:1;
                justify-content: space-around;
                align-items: center;
            }
    
  9. 例をテストするには、メニューから Window -> UI Toolkit -> Transition Looping Example を選択します。

その他の参考資料

トランジションイベントの作成
UI Renderer