GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format code and simplify IControlReference a little bit

Browse Source 
#3123
This commit is contained in:
Wojtek Figat
2025-03-04 16:06:48 +01:00
parent fee54f0f39
commit 35fa63852c
2 changed files with 54 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
Source/Editor/CustomEditors/Editors/ControlReferenceEditor.cs
View File

@@ -1,6 +1,6 @@
using System;
using System.Collections.Generic;
using FlaxEditor.CustomEditors;
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
using System;
using FlaxEditor.CustomEditors.Elements;
using FlaxEditor.GUI;
using FlaxEditor.GUI.Drag;
@@ -25,7 +25,7 @@ public class UIControlRefPickerControl : Control
private ActorTreeNode _linkedTreeNode;
private string _valueName;
private bool _supportsPickDropDown;
private bool _isMouseDown;
private Float2 _mouseDownPos;
private Float2 _mousePos;
@@ -33,17 +33,17 @@ public class UIControlRefPickerControl : Control
private bool _hasValidDragOver;
private DragActors _dragActors;
private DragHandlers _dragHandlers;
/// <summary>
/// The presenter using this control.
/// </summary>
public IPresenterOwner PresenterContext;
/// <summary>
/// Occurs when value gets changed.
/// </summary>
public event Action ValueChanged;
/// <summary>
/// The type of the Control
/// </summary>
@@ -100,7 +100,7 @@ public class UIControlRefPickerControl : Control
OnValueChanged();
}
}
/// <summary>
/// Gets or sets the selected object value by identifier.
/// </summary>
@@ -109,14 +109,13 @@ public class UIControlRefPickerControl : Control
get => _value ? _value.ID : Guid.Empty;
set => Value = Object.Find<UIControl>(ref value);
}
/// <summary>
/// Initializes a new instance of the <see cref="UIControlRefPickerControl"/> class.
/// </summary>
public UIControlRefPickerControl()
: base(0, 0, 50, 16)
: base(0, 0, 50, 16)
{
}
private void OnValueChanged()
@@ -142,12 +141,12 @@ public class UIControlRefPickerControl : Control
{
return actor == null || actor is UIControl a && a.Control.GetType() == _controlType;
}
private bool ValidateDragActor(ActorNode a)
{
if (!IsValid(a.Actor))
return false;
if (PresenterContext is PrefabWindow prefabWindow)
{
if (prefabWindow.Tree == a.TreeNode.ParentTree)
@@ -216,7 +215,7 @@ public class UIControlRefPickerControl : Control
Render2D.DrawRectangle(bounds, style.SelectionBorder);
}
}
/// <inheritdoc />
public override void OnMouseEnter(Float2 location)
{
@@ -225,8 +224,8 @@ public class UIControlRefPickerControl : Control
base.OnMouseEnter(location);
}
/// <inheritdoc />
/// <inheritdoc />
public override void OnMouseLeave()
{
_mousePos = Float2.Minimum;
@@ -326,7 +325,7 @@ public class UIControlRefPickerControl : Control
return base.OnMouseUp(location, button);
}
/// <inheritdoc />
public override bool OnMouseDown(Float2 location, MouseButton button)
{
@@ -339,7 +338,7 @@ public class UIControlRefPickerControl : Control
return base.OnMouseDown(location, button);
}
/// <inheritdoc />
public override bool OnMouseDoubleClick(Float2 location, MouseButton button)
{
@@ -361,7 +360,7 @@ public class UIControlRefPickerControl : Control
return base.OnMouseDoubleClick(location, button);
}
/// <inheritdoc />
public override void OnSubmit()
{
@@ -404,7 +403,7 @@ public class UIControlRefPickerControl : Control
return DragEffect;
}
/// <inheritdoc />
public override DragDropEffect OnDragMove(ref Float2 location, DragData data)
{
@@ -456,10 +455,10 @@ public class UIControlRefPickerControl : Control
public class ControlReferenceEditor : CustomEditor
{
private CustomElement<UIControlRefPickerControl> _element;
/// <inheritdoc />
public override DisplayStyle Style => DisplayStyle.Inline;
/// <inheritdoc />
public override void Initialize(LayoutElementsContainer layout)
{
@@ -485,7 +484,7 @@ public class ControlReferenceEditor : CustomEditor
Type t = typeof(ControlReference<>);
Type tw = t.MakeGenericType(new Type[] { genericType });
var instance = Activator.CreateInstance(tw);
(instance as IControlReference).Set(_element.CustomControl.Value);
((IControlReference)instance).UIControl = _element.CustomControl.Value;
SetValue(instance);
}
};

91
Source/Engine/UI/ControlReference.cs
View File

@@ -1,58 +1,36 @@
using System;
using System.Collections.Generic;
using FlaxEngine;
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
using System;
using FlaxEngine.GUI;
namespace FlaxEngine;
/// <summary>
/// The control reference interface.
/// Interface for control references access.
/// </summary>
public interface IControlReference
{
/// <summary>
/// The UIControl.
/// Gets or sets the reference to <see cref="FlaxEngine.UIControl"/> actor.
/// </summary>
public UIControl UIControl { get; }
public UIControl UIControl { get; set; }
/// <summary>
/// The Control type
/// Gets the type of the control the interface uses.
/// </summary>
/// <returns>The Control Type</returns>
public Type GetControlType();
/// <summary>
/// A safe set of the UI Control. Will warn if Control is of the wrong type.
/// </summary>
/// <param name="uiControl">The UIControl to set.</param>
public void Set(UIControl uiControl);
public Type ControlType { get; }
}
/// <summary>
/// ControlReference class.
/// UI Control reference utility. References UI Control actor with a typed control type.
/// </summary>
[Serializable]
public struct ControlReference<T> : IControlReference where T : Control
{
[Serialize, ShowInEditor]
private UIControl _uiControl;
/// <summary>
/// Default constructor for ControlReference;
/// </summary>
public ControlReference()
{
_uiControl = null;
}
/// <inheritdoc />
public Type GetControlType()
{
return typeof(T);
}
/// <summary>
/// The Control attached to the UI Control.
/// Gets the typed UI control object owned by the referenced <see cref="FlaxEngine.UIControl"/> actor.
/// </summary>
[HideInEditor]
public T Control
@@ -61,39 +39,34 @@ public struct ControlReference<T> : IControlReference where T : Control
{
if (_uiControl != null && _uiControl.Control is T t)
return t;
Debug.Write(LogType.Warning, "Trying to get Control from ControlReference but UIControl is null, or UIControl.Control is null, or UIControl.Control is not the correct type.");
return null;
}
}
/// <inheritdoc />
public UIControl UIControl
{
get => _uiControl;
set
{
if (value == null)
{
_uiControl = null;
}
else if (value.Control is T t)
{
_uiControl = value;
}
else
{
Debug.Write(LogType.Warning, "Trying to get Control from ControlReference but UIControl is null, or UIControl.Control is null, or UIControl.Control is not the correct type.");
return null;
Debug.Write(LogType.Warning, "Trying to set ControlReference but UIControl.Control is null or UIControl.Control is not the correct type.");
}
}
}
/// <inheritdoc />
public UIControl UIControl => _uiControl;
/// <inheritdoc />
public void Set(UIControl uiControl)
{
if (uiControl == null)
{
Clear();
return;
}
if (uiControl.Control is T castedControl)
_uiControl = uiControl;
else
Debug.Write(LogType.Warning, "Trying to set ControlReference but UIControl.Control is null or UIControl.Control is not the correct type.");
}
/// <summary>
/// Clears the UIControl reference.
/// </summary>
public void Clear()
{
_uiControl = null;
}
public Type ControlType => typeof(T);
/// <summary>
/// The implicit operator for the Control.