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

Add GetDebugInfo to BT nodes for debugging

Browse Source
This commit is contained in:
Wojtek Figat
2023-09-19 20:57:19 +02:00
parent f845344d03
commit 336fe46e03
12 changed files with 225 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
Source/Editor/Surface/Archetypes/BehaviorTree.cs
View File

@@ -29,6 +29,8 @@ namespace FlaxEditor.Surface.Archetypes
protected const float DecoratorsMarginX = 5.0f;
protected const float DecoratorsMarginY = 2.0f;
protected string _debugInfo;
protected Float2 _debugInfoSize;
protected ScriptType _type;
internal bool _isValueEditing;
@@ -52,6 +54,21 @@ namespace FlaxEditor.Surface.Archetypes
return title;
}
public virtual void UpdateDebug(Behavior behavior)
{
BehaviorTreeNode instance = null;
if (behavior)
{
// Try to use instance from the currently debugged behavior
// TODO: support nodes from nested trees
instance = behavior.Tree.GetNodeInstance(ID);
}
var size = _debugInfoSize;
UpdateDebugInfo(instance, behavior);
if (size != _debugInfoSize)
ResizeAuto();
}
protected virtual void UpdateTitle()
{
string title = null;
@@ -69,6 +86,21 @@ namespace FlaxEditor.Surface.Archetypes
Title = title;
}
protected virtual void UpdateDebugInfo(BehaviorTreeNode instance = null, Behavior behavior = null)
{
_debugInfo = null;
_debugInfoSize = Float2.Zero;
if (!instance)
instance = Instance;
if (instance)
{
// Get debug description for the node based on the current settings
_debugInfo = Behavior.GetNodeDebugInfo(instance, behavior);
if (!string.IsNullOrEmpty(_debugInfo))
_debugInfoSize = Style.Current.FontSmall.MeasureText(_debugInfo);
}
}
public override void OnLoaded(SurfaceNodeActions action)
{
base.OnLoaded(action);
@@ -97,6 +129,7 @@ namespace FlaxEditor.Surface.Archetypes
Instance = null;
}
UpdateDebugInfo();
UpdateTitle();
}
@@ -129,6 +162,7 @@ namespace FlaxEditor.Surface.Archetypes
}
}
UpdateDebugInfo();
UpdateTitle();
}
@@ -139,10 +173,23 @@ namespace FlaxEditor.Surface.Archetypes
ResizeAuto();
}
public override void Draw()
{
base.Draw();
// Debug Info
if (!string.IsNullOrEmpty(_debugInfo))
{
var style = Style.Current;
Render2D.DrawText(style.FontSmall, _debugInfo, new Rectangle(4, _headerRect.Bottom + 4, _debugInfoSize), style.Foreground);
}
}
public override void OnDestroy()
{
if (IsDisposing)
return;
_debugInfo = null;
_type = ScriptType.Null;
FlaxEngine.Object.Destroy(ref Instance);
@@ -258,6 +305,7 @@ namespace FlaxEditor.Surface.Archetypes
{
get
{
// Return decorator nodes attached to this node to be moved/copied/pasted as a one
SurfaceNode[] result = null;
var ids = Values.Length >= 3 ? Values[2] as byte[] : null;
if (ids != null)
@@ -425,6 +473,11 @@ namespace FlaxEditor.Surface.Archetypes
var titleLabelFont = Style.Current.FontLarge;
width = Mathf.Max(width, 100.0f);
width = Mathf.Max(width, titleLabelFont.MeasureText(Title).X + 30);
if (_debugInfoSize.X > 0)
{
width = Mathf.Max(width, _debugInfoSize.X + 8.0f);
height += _debugInfoSize.Y + 8.0f;
}
if (_input != null && _input.Visible)
height += ConnectionAreaHeight;
if (_output != null && _output.Visible)
@@ -463,9 +516,12 @@ namespace FlaxEditor.Surface.Archetypes
const float closeButtonSize = FlaxEditor.Surface.Constants.NodeCloseButtonSize;
_headerRect = new Rectangle(0, bounds.Y - Y, bounds.Width, headerSize);
_closeButtonRect = new Rectangle(bounds.Width - closeButtonSize - closeButtonMargin, _headerRect.Y + closeButtonMargin, closeButtonSize, closeButtonSize);
_footerRect = new Rectangle(0, _headerRect.Bottom, bounds.Width, footerSize);
_footerRect = new Rectangle(0, bounds.Height - footerSize, bounds.Width, footerSize);
if (_output != null && _output.Visible)
{
_footerRect.Y -= ConnectionAreaHeight;
_output.Bounds = new Rectangle(ConnectionAreaMargin, bounds.Height - ConnectionAreaHeight, bounds.Width - ConnectionAreaMargin * 2, ConnectionAreaHeight);
}
}
protected override void OnLocationChanged()
@@ -589,7 +645,12 @@ namespace FlaxEditor.Surface.Archetypes
protected override Float2 CalculateNodeSize(float width, float height)
{
return new Float2(width + FlaxEditor.Surface.Constants.NodeCloseButtonSize + 2 * DecoratorsMarginX, height + FlaxEditor.Surface.Constants.NodeHeaderSize);
if (_debugInfoSize.X > 0)
{
width = Mathf.Max(width, _debugInfoSize.X + 8.0f);
height += _debugInfoSize.Y + 8.0f;
}
return new Float2(width + FlaxEditor.Surface.Constants.NodeCloseButtonSize * 2 + DecoratorsMarginX * 2, height + FlaxEditor.Surface.Constants.NodeHeaderSize);
}
protected override void UpdateRectangles()
@@ -603,15 +664,22 @@ namespace FlaxEditor.Surface.Archetypes
protected override void UpdateTitle()
{
var title = Title;
base.UpdateTitle();
// Update parent node on title change
var title = Title;
base.UpdateTitle();
if (title != Title)
Node?.ResizeAuto();
}
protected override void UpdateDebugInfo(BehaviorTreeNode instance, Behavior behavior)
{
// Update parent node on debug text change
var debugInfoSize = _debugInfoSize;
base.UpdateDebugInfo(instance, behavior);
if (debugInfoSize != _debugInfoSize)
Node?.ResizeAuto();
}
public override void OnLoaded(SurfaceNodeActions action)
{
// Add drag button to reorder decorator

19
Source/Editor/Windows/Assets/BehaviorTreeWindow.cs
View File

@@ -449,6 +449,18 @@ namespace FlaxEditor.Windows.Assets
UpdateKnowledge();
}
private void UpdateDebugInfos(bool playMode)
{
var behavior = playMode ? (Behavior)_behaviorPicker.Value : null;
if (!behavior)
behavior = null;
foreach (var e in _surface.Nodes)
{
if (e is Surface.Archetypes.BehaviorTree.NodeBase node)
node.UpdateDebug(behavior);
}
}
/// <inheritdoc />
public override void OnPlayBegin()
{
@@ -461,6 +473,7 @@ namespace FlaxEditor.Windows.Assets
public override void OnPlayEnd()
{
SetCanEdit(true);
UpdateDebugInfos(false);
base.OnPlayEnd();
}
@@ -520,6 +533,12 @@ namespace FlaxEditor.Windows.Assets
// Update behavior debugging
SetCanDebug(Editor.IsPlayMode && _behaviorPicker.Value);
// Update debug info texts on all nodes
if (Editor.IsPlayMode)
{
UpdateDebugInfos(true);
}
base.Update(deltaTime);
}