Files
FlaxEngine/Source/Editor/Windows/Assets/ModelBaseWindow.cs

509 lines
16 KiB
C#

// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
using System.Xml;
using FlaxEditor.Content;
using FlaxEditor.CustomEditors;
using FlaxEditor.CustomEditors.Editors;
using FlaxEditor.GUI;
using FlaxEditor.GUI.Tabs;
using FlaxEngine;
using FlaxEngine.GUI;
using FlaxEngine.Utilities;
#pragma warning disable 1591
namespace FlaxEditor.Windows.Assets
{
/// <summary>
/// Editor window to view/modify <see cref="ModelBase"/> asset.
/// </summary>
/// <seealso cref="Model" />
/// <seealso cref="FlaxEditor.Windows.Assets.AssetEditorWindow" />
public abstract class ModelBaseWindow<TAsset, TWindow> : AssetEditorWindowBase<TAsset>
where TAsset : ModelBase
where TWindow : ModelBaseWindow<TAsset, TWindow>
{
protected abstract class PropertiesProxyBase
{
[HideInEditor]
public TWindow Window;
[HideInEditor]
public TAsset Asset;
public virtual void OnLoad(TWindow window)
{
Window = window;
Asset = window.Asset;
}
public virtual void OnSave()
{
}
public virtual void OnClean()
{
Window = null;
Asset = null;
}
}
protected abstract class ProxyEditorBase : GenericEditor
{
internal override void RefreshInternal()
{
// Skip updates when model is not loaded
var proxy = (PropertiesProxyBase)Values[0];
if (proxy.Asset == null || !proxy.Asset.IsLoaded)
return;
base.RefreshInternal();
}
}
protected class Tab : GUI.Tabs.Tab
{
public CustomEditorPresenter Presenter;
public PropertiesProxyBase Proxy;
public Tab(string text, TWindow window, bool modifiesAsset = true)
: base(text)
{
var scrollPanel = new Panel(ScrollBars.Vertical)
{
AnchorPreset = AnchorPresets.StretchAll,
Offsets = Margin.Zero,
Parent = this
};
Presenter = new CustomEditorPresenter(null);
Presenter.Panel.Parent = scrollPanel;
if (modifiesAsset)
Presenter.Modified += window.MarkAsEdited;
}
/// <inheritdoc />
public override void OnDestroy()
{
Presenter.Deselect();
Presenter = null;
Proxy = null;
base.OnDestroy();
}
}
protected class UVsPropertiesProxyBase : PropertiesProxyBase
{
public enum UVChannel
{
None,
TexCoord0,
TexCoord1,
TexCoord2,
TexCoord3,
LightmapUVs,
};
private UVChannel _uvChannel = UVChannel.None;
[EditorOrder(0), EditorDisplay(null, "Preview UV Channel"), EnumDisplay(EnumDisplayAttribute.FormatMode.None)]
[Tooltip("Set UV channel to preview.")]
public UVChannel Channel
{
get => _uvChannel;
set
{
if (_uvChannel == value)
return;
_uvChannel = value;
Window._meshData?.RequestMeshData(Window._asset);
}
}
[EditorOrder(1), EditorDisplay(null, "LOD"), Limit(0, Model.MaxLODs), VisibleIf("ShowUVs")]
[Tooltip("Level Of Detail index to preview UVs layout.")]
public int LOD = 0;
[EditorOrder(2), EditorDisplay(null, "Mesh"), Limit(-1, 1000000), VisibleIf("ShowUVs")]
[Tooltip("Mesh index to preview UVs layout. Use -1 for all meshes")]
public int Mesh = -1;
private bool ShowUVs => _uvChannel != UVChannel.None;
/// <inheritdoc />
public override void OnClean()
{
Channel = UVChannel.None;
base.OnClean();
}
protected class ProxyEditor : ProxyEditorBase
{
private UVsLayoutPreviewControl _uvsPreview;
public override void Initialize(LayoutElementsContainer layout)
{
var proxy = (UVsPropertiesProxyBase)Values[0];
if (Utilities.Utils.OnAssetProperties(layout, proxy.Asset))
return;
base.Initialize(layout);
_uvsPreview = layout.Custom<UVsLayoutPreviewControl>().CustomControl;
_uvsPreview.Window = proxy.Window;
}
/// <inheritdoc />
public override void Refresh()
{
base.Refresh();
if (_uvsPreview != null)
{
var proxy = (UVsPropertiesProxyBase)Values[0];
switch (proxy._uvChannel)
{
case UVChannel.TexCoord0: _uvsPreview.Channel = 0; break;
case UVChannel.TexCoord1: _uvsPreview.Channel = 1; break;
case UVChannel.TexCoord2: _uvsPreview.Channel = 2; break;
case UVChannel.TexCoord3: _uvsPreview.Channel = 3; break;
case UVChannel.LightmapUVs:
{
_uvsPreview.Channel = -1;
if (proxy.Window.Asset && proxy.Window.Asset.IsLoaded)
{
// Pick UVs channel index from the first mesh
proxy.Window.Asset.GetMeshes(out var meshes);
foreach (var mesh in meshes)
{
if (mesh is Mesh m && m.HasLightmapUVs)
{
_uvsPreview.Channel = m.LightmapUVsIndex;
break;
}
}
}
break;
}
default: _uvsPreview.Channel = -1; break;
}
_uvsPreview.LOD = proxy.LOD;
_uvsPreview.Mesh = proxy.Mesh;
_uvsPreview.HighlightIndex = proxy.Window._highlightIndex;
_uvsPreview.IsolateIndex = proxy.Window._isolateIndex;
}
}
protected override void Deinitialize()
{
_uvsPreview = null;
base.Deinitialize();
}
}
}
protected sealed class UVsLayoutPreviewControl : RenderToTextureControl
{
private int _channel = -1;
private int _lod, _mesh = -1;
private int _highlightIndex = -1;
private int _isolateIndex = -1;
public ModelBaseWindow<TAsset, TWindow> Window;
public UVsLayoutPreviewControl()
{
Offsets = new Margin(4);
AutomaticInvalidate = false;
}
public int Channel
{
set
{
if (_channel == value)
return;
_channel = value;
Visible = _channel != -1;
if (Visible)
Invalidate();
}
}
public int LOD
{
set
{
if (_lod != value)
{
_lod = value;
Invalidate();
}
}
}
public int Mesh
{
set
{
if (_mesh != value)
{
_mesh = value;
Invalidate();
}
}
}
public int HighlightIndex
{
set
{
if (_highlightIndex != value)
{
_highlightIndex = value;
Invalidate();
}
}
}
public int IsolateIndex
{
set
{
if (_isolateIndex != value)
{
_isolateIndex = value;
Invalidate();
}
}
}
private void DrawMeshUVs(int meshIndex, ref MeshDataCache.MeshData meshData, ref Rectangle bounds)
{
if (meshData.IndexBuffer == null || meshData.VertexAccessor == null)
{
Render2D.DrawText(Style.Current.FontMedium, "Missing mesh data", bounds, Color.Red, TextAlignment.Center, TextAlignment.Center);
return;
}
var linesColor = _highlightIndex != -1 && _highlightIndex == meshIndex ? Style.Current.BackgroundSelected : Color.White;
var texCoordStream = meshData.VertexAccessor.TexCoord(_channel);
if (!texCoordStream.IsValid)
{
Render2D.DrawText(Style.Current.FontMedium, "Missing texcoords channel", bounds, Color.Yellow, TextAlignment.Center, TextAlignment.Center);
return;
}
var uvScale = bounds.Size;
for (int i = 0; i < meshData.IndexBuffer.Length; i += 3)
{
// Cache triangle indices
uint i0 = meshData.IndexBuffer[i + 0];
uint i1 = meshData.IndexBuffer[i + 1];
uint i2 = meshData.IndexBuffer[i + 2];
// Cache triangle uvs positions and transform positions to output target
Float2 uv0 = texCoordStream.GetFloat2((int)i0) * uvScale;
Float2 uv1 = texCoordStream.GetFloat2((int)i1) * uvScale;
Float2 uv2 = texCoordStream.GetFloat2((int)i2) * uvScale;
// Don't draw too small triangles
float area = Float2.TriangleArea(ref uv0, ref uv1, ref uv2);
if (area > 10.0f)
{
// Draw triangle
Render2D.DrawLine(uv0, uv1, linesColor);
Render2D.DrawLine(uv1, uv2, linesColor);
Render2D.DrawLine(uv2, uv0, linesColor);
}
}
}
/// <inheritdoc />
public override void DrawSelf()
{
base.DrawSelf();
var bounds = new Rectangle(Float2.Zero, Size);
if (_channel < 0 || bounds.Size.MaxValue < 5.0f)
return;
if (Window._meshData == null)
Window._meshData = new MeshDataCache();
if (!Window._meshData.RequestMeshData(Window._asset))
{
Invalidate();
Render2D.DrawText(Style.Current.FontMedium, "Loading...", bounds, Color.White, TextAlignment.Center, TextAlignment.Center);
return;
}
Render2D.PushClip(bounds);
var meshDatas = Window._meshData.MeshDatas;
var lodIndex = Mathf.Clamp(_lod, 0, meshDatas.Length - 1);
var lod = meshDatas[lodIndex];
var mesh = Mathf.Clamp(_mesh, -1, lod.Length - 1);
if (mesh == -1)
{
for (int meshIndex = 0; meshIndex < lod.Length; meshIndex++)
{
if (_isolateIndex != -1 && _isolateIndex != meshIndex)
continue;
DrawMeshUVs(meshIndex, ref lod[meshIndex], ref bounds);
}
}
else
{
DrawMeshUVs(mesh, ref lod[mesh], ref bounds);
}
Render2D.PopClip();
}
protected override void OnSizeChanged()
{
Height = Width;
base.OnSizeChanged();
}
protected override void OnVisibleChanged()
{
base.OnVisibleChanged();
Parent.PerformLayout();
Height = Width;
}
}
protected readonly SplitPanel _split;
protected readonly Tabs _tabs;
protected readonly ToolStripButton _saveButton;
protected bool _refreshOnLODsLoaded;
protected bool _skipEffectsGuiEvents;
protected int _isolateIndex = -1;
protected int _highlightIndex = -1;
protected MeshDataCache _meshData;
/// <inheritdoc />
protected ModelBaseWindow(Editor editor, AssetItem item)
: base(editor, item)
{
var inputOptions = Editor.Options.Options.Input;
// Toolstrip
_saveButton = _toolstrip.AddButton(editor.Icons.Save64, Save).LinkTooltip("Save", ref inputOptions.Save);
// Split Panel
_split = new SplitPanel(Orientation.Horizontal, ScrollBars.None, ScrollBars.None)
{
AnchorPreset = AnchorPresets.StretchAll,
Offsets = new Margin(0, 0, _toolstrip.Bottom, 0),
SplitterValue = 0.59f,
Parent = this
};
// Properties tabs
_tabs = new Tabs
{
AnchorPreset = AnchorPresets.StretchAll,
Offsets = Margin.Zero,
TabsSize = new Float2(60, 20),
TabsTextHorizontalAlignment = TextAlignment.Center,
UseScroll = true,
Parent = _split.Panel2
};
}
/// <inheritdoc />
protected override void UpdateToolstrip()
{
_saveButton.Enabled = IsEdited;
base.UpdateToolstrip();
}
/// <inheritdoc />
protected override void UnlinkItem()
{
_meshData?.WaitForMeshDataRequestEnd();
foreach (var child in _tabs.Children)
{
if (child is Tab tab && tab.Proxy.Window != null)
tab.Proxy.OnClean();
}
base.UnlinkItem();
}
/// <inheritdoc />
protected override void OnAssetLoaded()
{
foreach (var child in _tabs.Children)
{
if (child is Tab tab)
{
tab.Proxy.OnLoad((TWindow)this);
tab.Presenter.BuildLayout();
}
}
ClearEditedFlag();
base.OnAssetLoaded();
}
/// <inheritdoc />
public override void OnItemReimported(ContentItem item)
{
// Discard any old mesh data cache
_meshData?.Dispose();
// Refresh the properties (will get new data in OnAssetLoaded)
foreach (var child in _tabs.Children)
{
if (child is Tab tab)
{
tab.Proxy.OnClean();
tab.Presenter.BuildLayout();
}
}
ClearEditedFlag();
_refreshOnLODsLoaded = true;
base.OnItemReimported(item);
}
/// <inheritdoc />
public override void OnDestroy()
{
// Free mesh memory
_meshData?.Dispose();
_meshData = null;
base.OnDestroy();
}
/// <inheritdoc />
public override bool UseLayoutData => true;
/// <inheritdoc />
public override void OnLayoutSerialize(XmlWriter writer)
{
LayoutSerializeSplitter(writer, "Split", _split);
}
/// <inheritdoc />
public override void OnLayoutDeserialize(XmlElement node)
{
LayoutDeserializeSplitter(node, "Split", _split);
}
/// <inheritdoc />
public override void OnLayoutDeserialize()
{
_split.SplitterValue = 0.59f;
}
}
}