UnityCsReference/Modules/UIElements/Panel.cs at master · leoforgithub/UnityCsReference

684 lines (551 loc) · 23.2 KB
// Unity C# reference source
// Copyright (c) Unity Technologies. For terms of use, see
// https://unity3d.com/legal/licenses/Unity_Reference_Only_License
using System;
using System.Collections.Generic;
using UnityEngine.Profiling;
namespace UnityEngine.UIElements
    public enum ContextType
        Player = 0,
        Editor = 1
    [Flags]
    internal enum VersionChangeType
        // Some data was bound
        Bindings = 1 << 8,
        // persistent data ready
        ViewData = 1 << 7,
        // changes to hierarchy
        Hierarchy = 1 << 6,
        // changes to properties that may have an impact on layout
        Layout = 1 << 5,
        // changes to StyleSheet, USS class
        StyleSheet = 1 << 4,
        // changes to styles, colors and other render properties
        Styles = 1 << 3,
        // changes that may impact the world transform (e.g. laid out position, local transform)
        Transform = 1 << 2,
        // changes to the size of the element after layout has been performed, without taking the local transform into account
        Size = 1 << 1,
        // The visuals of the element have changed
        // TODO: Rename to visuals
        Repaint = 1 << 0,
    [Flags]
    internal enum RenderHint
        None = 0,
        GroupTransform = 1 << 0, // Use uniform matrix to transform children
        BoneTransform = 1 << 1, // Use GPU buffer to store transform matrices
        ClipWithScissors = 1 << 2 // If clipping is requested on this element, prefer scissoring
    internal class RepaintData
        public Matrix4x4 currentOffset { get; set; } = Matrix4x4.identity;
        public Vector2 mousePosition { get; set; }
        public Rect currentWorldClip { get; set; }
        public Event repaintEvent { get; set; }
    internal delegate void HierarchyEvent(VisualElement ve, HierarchyChangeType changeType);
    internal interface IGlobalPanelDebugger
        bool InterceptMouseEvent(IPanel panel, IMouseEvent ev);
        void OnPostMouseEvent(IPanel panel, IMouseEvent ev);
    internal interface IPanelDebugger
        IPanelDebug panelDebug { get; set; }
        void Disconnect();
        void Refresh();
        void OnVersionChanged(VisualElement ele, VersionChangeType changeTypeFlag);
        bool InterceptEvent(EventBase ev);
        void PostProcessEvent(EventBase ev);
    internal interface IPanelDebug
        IPanel panel { get; }
        VisualElement visualTree { get; }
        void AttachDebugger(IPanelDebugger debugger);
        void DetachDebugger(IPanelDebugger debugger);
        void DetachAllDebuggers();
        IEnumerable<IPanelDebugger> GetAttachedDebuggers();
        void MarkDirtyRepaint();
        void Refresh();
        void OnVersionChanged(VisualElement ele, VersionChangeType changeTypeFlag);
        bool InterceptEvent(EventBase ev);
        void PostProcessEvent(EventBase ev);
    // This is the required interface to IPanel for Runtime game components.
    internal interface IRuntimePanel
        void Update(Vector2 size);
        void Repaint(Event e);
    // Passed-in to every element of the visual tree
    public interface IPanel : IDisposable
        VisualElement visualTree { get; }
        EventDispatcher dispatcher { get; }
        ContextType contextType { get; }
        FocusController focusController { get; }
        VisualElement Pick(Vector2 point);
        VisualElement PickAll(Vector2 point, List<VisualElement> picked);
    abstract class BaseVisualElementPanel : IPanel, IRuntimePanel
        public abstract EventInterests IMGUIEventInterests { get; set; }
        public abstract ScriptableObject ownerObject { get; protected set; }
        public abstract SavePersistentViewData saveViewData { get; set; }
        public abstract GetViewDataDictionary getViewDataDictionary { get; set; }
        public abstract int IMGUIContainersCount { get; set; }
        public abstract FocusController focusController { get; set; }
        public void Dispose()
            Dispose(true);
            GC.SuppressFinalize(this);
        protected virtual void Dispose(bool disposing)
            if (disposed)
                return;
            if (disposing)
                if (panelDebug != null)
                    panelDebug.DetachAllDebuggers();
                    panelDebug = null;
                UIElementsUtility.RemoveCachedPanel(ownerObject.GetInstanceID());
            else
                DisposeHelper.NotifyMissingDispose(this);
            disposed = true;
        public abstract void Repaint(Event e);
        public abstract void ValidateLayout();
        public abstract void UpdateBindings();
        public abstract void ApplyStyles();
        public abstract void DirtyStyleSheets();
        internal float currentPixelsPerPoint { get; set; } = 1.0f;
        internal bool duringLayoutPhase {get; set;}
        internal bool isDirty
            get { return version != repaintVersion; }
        internal abstract uint version { get; }
        internal abstract uint repaintVersion { get; }
        internal abstract void OnVersionChanged(VisualElement ele, VersionChangeType changeTypeFlag);
        internal abstract void SetUpdater(IVisualTreeUpdater updater, VisualTreeUpdatePhase phase);
        internal virtual RepaintData repaintData { get; set; }
        internal virtual ICursorManager cursorManager { get; set; }
        internal virtual ContextualMenuManager contextualMenuManager { get; set; }
        //IPanel
        public abstract VisualElement visualTree { get; }
        public abstract EventDispatcher dispatcher { get; protected set; }
        internal void SendEvent(EventBase e, DispatchMode dispatchMode = DispatchMode.Queued)
            Debug.Assert(dispatcher != null);
            dispatcher?.Dispatch(e, this, dispatchMode);
        internal abstract IScheduler scheduler { get; }
        public abstract ContextType contextType { get; protected set; }
        public abstract VisualElement Pick(Vector2 point);
        public abstract VisualElement PickAll(Vector2 point, List<VisualElement> picked);
        internal bool disposed { get; private set; }
        internal bool allowPixelCaching { get; set; }
        public abstract bool keepPixelCacheOnWorldBoundChange { get; set; }
        internal abstract IVisualTreeUpdater GetUpdater(VisualTreeUpdatePhase phase);
        internal VisualElement topElementUnderMouse { get; private set; }
        internal abstract Shader standardShader { get; set; }
        internal event Action standardShaderChanged;
        protected void InvokeStandardShaderChanged() { if (standardShaderChanged != null) standardShaderChanged(); }
        internal event HierarchyEvent hierarchyChanged;
        internal void InvokeHierarchyChanged(VisualElement ve, HierarchyChangeType changeType) { if (hierarchyChanged != null) hierarchyChanged(ve, changeType); }
        internal void SetElementUnderMouse(VisualElement newElementUnderMouse, EventBase triggerEvent)
            if (newElementUnderMouse == topElementUnderMouse)
                return;
            VisualElement previousTopElementUnderMouse = topElementUnderMouse;
            topElementUnderMouse = newElementUnderMouse;
            IMouseEvent mouseEvent = triggerEvent == null ? null : triggerEvent as IMouseEvent;
            var mousePosition = mouseEvent == null
                ? MousePositionTracker.mousePosition
                : mouseEvent?.mousePosition ?? Vector2.zero;
            var sendMouseOverOut = (triggerEvent == null ||
                triggerEvent.eventTypeId == MouseMoveEvent.TypeId() ||
                triggerEvent.eventTypeId == MouseDownEvent.TypeId() ||
                triggerEvent.eventTypeId == MouseUpEvent.TypeId() ||
                triggerEvent.eventTypeId == MouseEnterWindowEvent.TypeId() ||
                triggerEvent.eventTypeId == MouseLeaveWindowEvent.TypeId() ||
                triggerEvent.eventTypeId == WheelEvent.TypeId());
            var sendDragEnterLeave = triggerEvent != null && (triggerEvent.eventTypeId == DragUpdatedEvent.TypeId() || triggerEvent.eventTypeId == DragExitedEvent.TypeId());
            using (new EventDispatcherGate(dispatcher))
                // mouse enter/leave must be dispatched *any* time the element under mouse changes
                MouseEventsHelper.SendEnterLeave<MouseLeaveEvent, MouseEnterEvent>(previousTopElementUnderMouse, topElementUnderMouse, mouseEvent, mousePosition);
                if (sendMouseOverOut)
                    MouseEventsHelper.SendMouseOverMouseOut(previousTopElementUnderMouse, topElementUnderMouse, mouseEvent, mousePosition);
                if (sendDragEnterLeave)
                    MouseEventsHelper.SendEnterLeave<DragLeaveEvent, DragEnterEvent>(previousTopElementUnderMouse, topElementUnderMouse, mouseEvent, mousePosition);
        internal void UpdateElementUnderMouse()
            if (MousePositionTracker.panel != this)
                SetElementUnderMouse(null, null);
            else
                VisualElement elementUnderMouse = Pick(MousePositionTracker.mousePosition);
                SetElementUnderMouse(elementUnderMouse, null);
        public IPanelDebug panelDebug { get; set; }
        public void Update(Vector2 size)
            scheduler.UpdateScheduledEvents();
            if (size != visualTree.layout.size)
                visualTree.SetSize(size);
            ValidateLayout();
            UpdateBindings();
    // Strategy to load assets must be provided in the context of Editor or Runtime
    internal delegate Object LoadResourceFunction(string pathName, System.Type type);
    // Strategy to fetch real time since startup in the context of Editor or Runtime
    internal delegate long TimeMsFunction();
    // Getting the view data dictionary relies on the Editor window.
    internal delegate ISerializableJsonDictionary GetViewDataDictionary();
    // Strategy to save persistent data must be provided in the context of Editor or Runtime
    internal delegate void SavePersistentViewData();
    // Default panel implementation
    internal class Panel : BaseVisualElementPanel
        private VisualElement m_RootContainer;
        private VisualTreeUpdater m_VisualTreeUpdater;
        private string m_PanelName;
        private string m_ProfileUpdateName;
        private string m_ProfileLayoutName;
        private string m_ProfileBindingsName;
        private uint m_Version = 0;
        private uint m_RepaintVersion = 0;
#pragma warning disable CS0649
        internal static Action BeforeUpdaterChange;
        internal static Action AfterUpdaterChange;
#pragma warning restore CS0649
        public override VisualElement visualTree
            get { return m_RootContainer; }
        public override EventDispatcher dispatcher { get; protected set; }
        TimerEventScheduler m_Scheduler;
        public TimerEventScheduler timerEventScheduler
            get { return m_Scheduler ?? (m_Scheduler = new TimerEventScheduler()); }
        internal override IScheduler scheduler
            get { return timerEventScheduler; }
        public override ScriptableObject ownerObject { get; protected set; }
        public override ContextType contextType { get; protected set; }
        public override SavePersistentViewData saveViewData { get; set; }
        public override GetViewDataDictionary getViewDataDictionary { get; set; }
        public override FocusController focusController { get; set; }
        public override EventInterests IMGUIEventInterests { get; set; }
        internal static LoadResourceFunction loadResourceFunc { private get; set; }
        internal static Object LoadResource(string pathName, Type type)
            // TODO make the LoadResource function non-static.
            // if (panel.contextType = ContextType.Player)
            //    obj = Resources.Load(pathName, type);
            // else
            //    ...
            Object obj = null;
            if (loadResourceFunc != null)
                obj = loadResourceFunc(pathName, type);
            else
                obj = Resources.Load(pathName, type);
            return obj;
        private Focusable m_SavedFocusedElement;
        internal void Focus()
            if (m_SavedFocusedElement != null && !(m_SavedFocusedElement is IMGUIContainer))
                m_SavedFocusedElement.Focus();
            m_SavedFocusedElement = null;
        internal void Blur()
            m_SavedFocusedElement = focusController?.GetLeafFocusedElement();
            if (m_SavedFocusedElement != null && !(m_SavedFocusedElement is IMGUIContainer))
                m_SavedFocusedElement.Blur();
        internal string name
            get { return m_PanelName; }
                m_PanelName = value;
                if (!string.IsNullOrEmpty(m_PanelName))
                    m_ProfileUpdateName = $"PanelUpdate.{m_PanelName}";
                    m_ProfileLayoutName = $"PanelLayout.{m_PanelName}";
                    m_ProfileBindingsName = $"PanelBindings.{m_PanelName}";
                    m_ProfileUpdateName = "PanelUpdate";
                    m_ProfileLayoutName = "PanelLayout";
                    m_ProfileBindingsName = "PanelBindings";
        private static TimeMsFunction s_TimeSinceStartup;
        internal static TimeMsFunction TimeSinceStartup
            get { return s_TimeSinceStartup; }
                if (value == null)
                    value = DefaultTimeSinceStartupMs;
                s_TimeSinceStartup = value;
        private bool m_KeepPixelCacheOnWorldBoundChange;
        public override bool keepPixelCacheOnWorldBoundChange
            get { return m_KeepPixelCacheOnWorldBoundChange; }
                if (m_KeepPixelCacheOnWorldBoundChange == value)
                    return;
                m_KeepPixelCacheOnWorldBoundChange = value;
                // We only need to force a repaint if this flag was set from
                // true (do NOT update pixel cache) to false (update pixel cache).
                // When it was true, the pixel cache was just being transformed and
                // now we want to regenerate it at the correct resolution. Going from
                // false to true does not need a repaint because the pixel cache is
                // already valid (was being updated each transform repaint).
                if (!value)
                    m_RootContainer.IncrementVersion(VersionChangeType.Transform | VersionChangeType.Repaint);
        public override int IMGUIContainersCount { get; set; }
        internal override uint version
            get { return m_Version; }
        internal override uint repaintVersion
            get { return m_RepaintVersion; }
        private Shader m_StandardShader;
        internal override Shader standardShader
            get { return m_StandardShader; }
                if (m_StandardShader != value)
                    m_StandardShader = value;
                    InvokeStandardShaderChanged();
        public Panel(ScriptableObject ownerObject, ContextType contextType, EventDispatcher dispatcher = null)
            m_VisualTreeUpdater = new VisualTreeUpdater(this);
            this.ownerObject = ownerObject;
            this.contextType = contextType;
            this.dispatcher = dispatcher ?? EventDispatcher.instance;
            repaintData = new RepaintData();
            cursorManager = new CursorManager();
            contextualMenuManager = null;
            m_RootContainer = new VisualElement
                name = VisualElementUtils.GetUniqueName("unity-panel-container"),
                viewDataKey = "PanelContainer"
            // Required!
            visualTree.SetPanel(this);
            focusController = new FocusController(new VisualElementFocusRing(visualTree));
            m_ProfileUpdateName = "PanelUpdate";
            m_ProfileLayoutName = "PanelLayout";
            m_ProfileBindingsName = "PanelBindings";
            allowPixelCaching = true;
            InvokeHierarchyChanged(visualTree, HierarchyChangeType.Add);
        protected override void Dispose(bool disposing)
            if (disposed)
                return;
            if (disposing)
                m_VisualTreeUpdater.Dispose();
            base.Dispose(disposing);
        public static long TimeSinceStartupMs()
            return (s_TimeSinceStartup == null) ? DefaultTimeSinceStartupMs() : s_TimeSinceStartup();
        internal static long DefaultTimeSinceStartupMs()
            return (long)(Time.realtimeSinceStartup * 1000.0f);
        // For tests only.
        internal static VisualElement PickAllWithoutValidatingLayout(VisualElement root, Vector2 point)
            return PickAll(root, point);
        private static VisualElement PickAll(VisualElement root, Vector2 point, List<VisualElement> picked = null)
            Profiler.BeginSample("Panel.PickAll");
            var result = PerformPick(root, point, picked);
            Profiler.EndSample();
            return result;
        private static VisualElement PerformPick(VisualElement root, Vector2 point, List<VisualElement> picked = null)
            // Skip picking for elements with display: none
            if (root.resolvedStyle.display == DisplayStyle.None)
                return null;
            if (root.pickingMode == PickingMode.Ignore && root.hierarchy.childCount == 0)
                return null;
            Vector2 localPoint = root.WorldToLocal(point);
            if (!root.boundingBox.Contains(localPoint))
                return null;
            bool containsPoint = root.ContainsPoint(localPoint);
            // we only skip children in the case we visually clip them
            if (!containsPoint && root.ShouldClip())
                return null;
            VisualElement returnedChild = null;
            // Depth first in reverse order, do children
            for (int i = root.hierarchy.childCount - 1; i >= 0; i--)
                var child = root.hierarchy[i];
                var result = PerformPick(child, point, picked);
                if (returnedChild == null && result != null && result.visible)
                    returnedChild = result;
            if (picked != null && root.enabledInHierarchy && root.visible && root.pickingMode == PickingMode.Position && containsPoint)
                picked.Add(root);
            if (returnedChild != null)
                return returnedChild;
            switch (root.pickingMode)
                case PickingMode.Position:
                    if (containsPoint && root.enabledInHierarchy && root.visible)
                        return root;
                break;
                case PickingMode.Ignore:
                    break;
            return null;
        public override VisualElement PickAll(Vector2 point, List<VisualElement> picked)
            ValidateLayout();
            if (picked != null)
                picked.Clear();
            return PickAll(visualTree, point, picked);
        public override VisualElement Pick(Vector2 point)
            ValidateLayout();
            return PickAll(visualTree, point);
        private bool m_ValidatingLayout = false;
        public override void ValidateLayout()
            // Reentrancy proofing: ValidateLayout() could be in the code path of updaters.
            // Actual case: TransformClip update phase recomputes elements under mouse, which does a pick, which validates layout.
            // Updaters use version numbers for early exit, but it may happen that an updater invalidates a subsequent updater.
            if (!m_ValidatingLayout)
                m_ValidatingLayout = true;
                Profiler.BeginSample(m_ProfileLayoutName);
                m_VisualTreeUpdater.UpdateVisualTreePhase(VisualTreeUpdatePhase.Styles);
                m_VisualTreeUpdater.UpdateVisualTreePhase(VisualTreeUpdatePhase.Layout);
                m_VisualTreeUpdater.UpdateVisualTreePhase(VisualTreeUpdatePhase.TransformClip);
                Profiler.EndSample();
                m_ValidatingLayout = false;
        public override void UpdateBindings()
            Profiler.BeginSample(m_ProfileBindingsName);
            m_VisualTreeUpdater.UpdateVisualTreePhase(VisualTreeUpdatePhase.Bindings);
            Profiler.EndSample();
        public override void ApplyStyles()
            m_VisualTreeUpdater.UpdateVisualTreePhase(VisualTreeUpdatePhase.Styles);
        public override void DirtyStyleSheets()
            m_VisualTreeUpdater.DirtyStyleSheets();
        public override void Repaint(Event e)
            Debug.Assert(GUIClip.Internal_GetCount() == 0, "UIElement is not compatible with IMGUI GUIClips, only GUIClip.ParentClipScope");
            m_RepaintVersion = version;
            // if the surface DPI changes we need to invalidate styles
            if (!Mathf.Approximately(currentPixelsPerPoint, GUIUtility.pixelsPerPoint))
                currentPixelsPerPoint = GUIUtility.pixelsPerPoint;
                visualTree.IncrementVersion(VersionChangeType.StyleSheet);
            repaintData.repaintEvent = e;
            Profiler.BeginSample(m_ProfileUpdateName);
                m_VisualTreeUpdater.UpdateVisualTree();
            finally
                Profiler.EndSample();
            panelDebug?.Refresh();
        internal override void OnVersionChanged(VisualElement ve, VersionChangeType versionChangeType)
            ++m_Version;
            m_VisualTreeUpdater.OnVersionChanged(ve, versionChangeType);
            panelDebug?.OnVersionChanged(ve, versionChangeType);
        internal override void SetUpdater(IVisualTreeUpdater updater, VisualTreeUpdatePhase phase)
            m_VisualTreeUpdater.SetUpdater(updater, phase);
        internal override IVisualTreeUpdater GetUpdater(VisualTreeUpdatePhase phase)
            return m_VisualTreeUpdater.GetUpdater(phase);
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Panel.cs

Latest commit

History

Panel.cs

File metadata and controls
