Commit pending working-tree changes (local edits, line endings)
This commit is contained in:
cthangover committed
1 parent
9ecbbb4056
commit
3fb418fa4a
22 files changed
+1651
-1651
No files matched your search
@@ -1,21 +1,21 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base
|
||||
{
|
||||
/// <summary>
|
||||
/// Forwarder pattern for Godot input: proxies _Input to a virtual OnInput
|
||||
/// so derived classes can handle input events without needing to know about
|
||||
/// Godot's _Input override mechanics.
|
||||
/// </summary>
|
||||
public partial class InputHandlerNode : Node
|
||||
{
|
||||
/// <summary>Engine entry point: forwards the input event to <see cref="OnInput"/>.</summary>
|
||||
public override void _Input(InputEvent @event)
|
||||
{
|
||||
OnInput(@event);
|
||||
}
|
||||
|
||||
/// <summary>Override in derived classes to receive Godot input events. Called by <see cref="_Input"/> which proxies from the engine.</summary>
|
||||
protected virtual void OnInput(InputEvent @event) { }
|
||||
}
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base
|
||||
{
|
||||
/// <summary>
|
||||
/// Forwarder pattern for Godot input: proxies _Input to a virtual OnInput
|
||||
/// so derived classes can handle input events without needing to know about
|
||||
/// Godot's _Input override mechanics.
|
||||
/// </summary>
|
||||
public partial class InputHandlerNode : Node
|
||||
{
|
||||
/// <summary>Engine entry point: forwards the input event to <see cref="OnInput"/>.</summary>
|
||||
public override void _Input(InputEvent @event)
|
||||
{
|
||||
OnInput(@event);
|
||||
}
|
||||
|
||||
/// <summary>Override in derived classes to receive Godot input events. Called by <see cref="_Input"/> which proxies from the engine.</summary>
|
||||
protected virtual void OnInput(InputEvent @event) { }
|
||||
}
|
||||
}
|
||||
+19
-19
@@ -1,19 +1,19 @@
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Serializable margin/padding struct for list layout calculations.
|
||||
/// Marked [System.Serializable] for potential JSON serialization in mod configs.
|
||||
/// </summary>
|
||||
[System.Serializable]
|
||||
public struct Border
|
||||
{
|
||||
/// <summary>Left margin or padding, in pixels.</summary>
|
||||
public float left;
|
||||
/// <summary>Right margin or padding, in pixels.</summary>
|
||||
public float right;
|
||||
/// <summary>Top margin or padding, in pixels.</summary>
|
||||
public float top;
|
||||
/// <summary>Bottom margin or padding, in pixels.</summary>
|
||||
public float bottom;
|
||||
}
|
||||
}
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Serializable margin/padding struct for list layout calculations.
|
||||
/// Marked [System.Serializable] for potential JSON serialization in mod configs.
|
||||
/// </summary>
|
||||
[System.Serializable]
|
||||
public struct Border
|
||||
{
|
||||
/// <summary>Left margin or padding, in pixels.</summary>
|
||||
public float left;
|
||||
/// <summary>Right margin or padding, in pixels.</summary>
|
||||
public float right;
|
||||
/// <summary>Top margin or padding, in pixels.</summary>
|
||||
public float top;
|
||||
/// <summary>Bottom margin or padding, in pixels.</summary>
|
||||
public float bottom;
|
||||
}
|
||||
}
|
||||
@@ -1,22 +1,22 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Extends IListWidget with grid/cell dimensions. CellSize drives item sizing;
|
||||
/// ViewCellsCount determines how many cells fit in the visible area (used for
|
||||
/// scroll/viewport calculations).
|
||||
/// </summary>
|
||||
public interface ICellListWidget<TItem, TModel> : IListWidget<TItem, TModel>
|
||||
where TItem : class, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>Pixel dimensions of each cell in the grid. Drives item sizing; derived from content width and aspect ratio.</summary>
|
||||
Vector2 CellSize { get; }
|
||||
|
||||
/// <summary>Number of cells visible in the viewport (columns × rows). Used for scroll range and visibility calculations.</summary>
|
||||
Vector2I ViewCellsCount { get; }
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Extends IListWidget with grid/cell dimensions. CellSize drives item sizing;
|
||||
/// ViewCellsCount determines how many cells fit in the visible area (used for
|
||||
/// scroll/viewport calculations).
|
||||
/// </summary>
|
||||
public interface ICellListWidget<TItem, TModel> : IListWidget<TItem, TModel>
|
||||
where TItem : class, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>Pixel dimensions of each cell in the grid. Drives item sizing; derived from content width and aspect ratio.</summary>
|
||||
Vector2 CellSize { get; }
|
||||
|
||||
/// <summary>Number of cells visible in the viewport (columns × rows). Used for scroll range and visibility calculations.</summary>
|
||||
Vector2I ViewCellsCount { get; }
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
+27
-27
@@ -1,27 +1,27 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Contract for a single item in a list widget. Construct binds a model;
|
||||
/// Destruct tears down (typically QueueFree). The Rect getter exposes the
|
||||
/// item's Control for layout positioning by the parent list.
|
||||
/// </summary>
|
||||
public interface IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>The Control that this item occupies. Used by the parent list to position the item in layout.</summary>
|
||||
Control Rect { get; }
|
||||
|
||||
/// <summary>The bound data model. Set via <see cref="Construct"/>.</summary>
|
||||
TModel Model { get; }
|
||||
|
||||
/// <summary>Binds the item to a data model. Called by the list widget after instantiation, before layout positioning.</summary>
|
||||
void Construct(TModel model);
|
||||
|
||||
/// <summary>Cleans up the item — typically disconnects signals and calls QueueFree. Called when the list is destroyed or refreshed.</summary>
|
||||
void Destruct();
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Contract for a single item in a list widget. Construct binds a model;
|
||||
/// Destruct tears down (typically QueueFree). The Rect getter exposes the
|
||||
/// item's Control for layout positioning by the parent list.
|
||||
/// </summary>
|
||||
public interface IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>The Control that this item occupies. Used by the parent list to position the item in layout.</summary>
|
||||
Control Rect { get; }
|
||||
|
||||
/// <summary>The bound data model. Set via <see cref="Construct"/>.</summary>
|
||||
TModel Model { get; }
|
||||
|
||||
/// <summary>Binds the item to a data model. Called by the list widget after instantiation, before layout positioning.</summary>
|
||||
void Construct(TModel model);
|
||||
|
||||
/// <summary>Cleans up the item — typically disconnects signals and calls QueueFree. Called when the list is destroyed or refreshed.</summary>
|
||||
void Destruct();
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,45 +1,45 @@
|
||||
using System.Collections.Generic;
|
||||
using Godot;
|
||||
|
||||
using System.Collections.Generic;
|
||||
using Godot;
|
||||
|
||||
using Cthangover.Core.UI;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Generic list widget contract: binds a collection of models to Item widgets.
|
||||
/// The two-step CreateModels() → CreateContent() pattern separates data sourcing
|
||||
/// from instantiation, so subclasses can pull models from anywhere (runtime state,
|
||||
/// config, save data) while the framework handles layout. ConstructUI/DestructUI
|
||||
/// manage the full lifecycle of child items.
|
||||
/// </summary>
|
||||
public interface IListWidget<TItem, TModel> : IWidget
|
||||
where TItem : class, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>Padding between items in pixels, stored as Vector2(X, Y). The X component is horizontal gap, Y is vertical gap.</summary>
|
||||
Vector2 ItemsCellPadding { get; }
|
||||
|
||||
/// <summary>The container Control that holds all child item nodes. Items are added as children of this node.</summary>
|
||||
Control Content { get; }
|
||||
|
||||
/// <summary>The collection of instantiated item widgets. Populated by <see cref="ConstructUI"/> and cleared by <see cref="DestructUI"/>.</summary>
|
||||
List<TItem> Items { get; set; }
|
||||
|
||||
/// <summary>Implementations return the collection of data models to display. Called once per <see cref="ConstructUI"/> cycle.</summary>
|
||||
ICollection<TModel> CreateModels();
|
||||
|
||||
/// <summary>Instantiates item widgets from the model collection. Separates model sourcing from instantiation so subclasses control both steps.</summary>
|
||||
List<TItem> CreateContent(ICollection<TModel> models);
|
||||
|
||||
/// <summary>Calculates the total content size in pixels for <paramref name="count"/> items, used for scroll container sizing.</summary>
|
||||
Vector2 GetContentSize(int count);
|
||||
|
||||
/// <summary>Builds the full item tree: creates models, instantiates items, and positions them via layout.</summary>
|
||||
void ConstructUI();
|
||||
|
||||
/// <summary>Tears down all child items by calling each item's <see cref="IListItem{TModel}.Destruct"/> and clearing the Items list.</summary>
|
||||
void DestructUI();
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Generic list widget contract: binds a collection of models to Item widgets.
|
||||
/// The two-step CreateModels() → CreateContent() pattern separates data sourcing
|
||||
/// from instantiation, so subclasses can pull models from anywhere (runtime state,
|
||||
/// config, save data) while the framework handles layout. ConstructUI/DestructUI
|
||||
/// manage the full lifecycle of child items.
|
||||
/// </summary>
|
||||
public interface IListWidget<TItem, TModel> : IWidget
|
||||
where TItem : class, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>Padding between items in pixels, stored as Vector2(X, Y). The X component is horizontal gap, Y is vertical gap.</summary>
|
||||
Vector2 ItemsCellPadding { get; }
|
||||
|
||||
/// <summary>The container Control that holds all child item nodes. Items are added as children of this node.</summary>
|
||||
Control Content { get; }
|
||||
|
||||
/// <summary>The collection of instantiated item widgets. Populated by <see cref="ConstructUI"/> and cleared by <see cref="DestructUI"/>.</summary>
|
||||
List<TItem> Items { get; set; }
|
||||
|
||||
/// <summary>Implementations return the collection of data models to display. Called once per <see cref="ConstructUI"/> cycle.</summary>
|
||||
ICollection<TModel> CreateModels();
|
||||
|
||||
/// <summary>Instantiates item widgets from the model collection. Separates model sourcing from instantiation so subclasses control both steps.</summary>
|
||||
List<TItem> CreateContent(ICollection<TModel> models);
|
||||
|
||||
/// <summary>Calculates the total content size in pixels for <paramref name="count"/> items, used for scroll container sizing.</summary>
|
||||
Vector2 GetContentSize(int count);
|
||||
|
||||
/// <summary>Builds the full item tree: creates models, instantiates items, and positions them via layout.</summary>
|
||||
void ConstructUI();
|
||||
|
||||
/// <summary>Tears down all child items by calling each item's <see cref="IListItem{TModel}.Destruct"/> and clearing the Items list.</summary>
|
||||
void DestructUI();
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,93 +1,93 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists.Impls
|
||||
{
|
||||
/// <summary>
|
||||
/// Grid-based list layout with configurable column count, aspect-ratio cells,
|
||||
/// and border/padding offsets. Cell dimensions are computed dynamically from
|
||||
/// the content area width, so they scale with the parent. GetContentSize
|
||||
/// calculates the total scrollable height from item count and cell geometry,
|
||||
/// enabling vertical scrolling through a grid. PutToLayout positions items
|
||||
/// by flat-index-to-grid conversion. The isScaledCanvas flag supports
|
||||
/// resolution-independent layouts.
|
||||
/// </summary>
|
||||
public abstract partial class ColumnCellListWidget<TItem, TModel> : ListWidget<TItem, TModel>, ICellListWidget<TItem, TModel>
|
||||
where TItem : Control, IListItem<TModel>
|
||||
{
|
||||
[Export] private int columnCount;
|
||||
[Export] private float aspectHeight = 1f;
|
||||
[Export] private float borderLeft;
|
||||
[Export] private float borderRight;
|
||||
[Export] private float borderTop;
|
||||
[Export] private float borderBottom;
|
||||
[Export] private bool isScaledCanvas = true;
|
||||
|
||||
private Border contentBorder => new() { left = borderLeft, right = borderRight, top = borderTop, bottom = borderBottom };
|
||||
|
||||
/// <summary>Dynamically computed cell dimensions in pixels. Width = (content width - borders - padding * (columns - 1)) / columns; height = width * aspectHeight.</summary>
|
||||
public Vector2 CellSize => GetCellSize(Content.Size);
|
||||
|
||||
private Vector2 GetCellSize(Vector2 contentSize)
|
||||
{
|
||||
var size = contentSize;
|
||||
var effectiveWidth = size.X - contentBorder.left - contentBorder.right;
|
||||
var cellWidth = (effectiveWidth - (columnCount - 1) * ItemsCellPadding.X) / columnCount;
|
||||
var cellHeight = cellWidth * aspectHeight;
|
||||
return new Vector2(cellWidth, cellHeight);
|
||||
}
|
||||
|
||||
/// <summary>Number of cells visible in the viewport: X = columnCount, Y = floor((content height - borders) / (cell height + padding)).</summary>
|
||||
public Vector2I ViewCellsCount
|
||||
{
|
||||
get
|
||||
{
|
||||
var size = Content.Size;
|
||||
return new Vector2I(
|
||||
columnCount,
|
||||
Mathf.FloorToInt((size.Y - contentBorder.top - contentBorder.bottom) / (CellSize.Y + ItemsCellPadding.Y))
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Calculates total scrollable content height: top border + bottom border + rows * cellHeight + (rows - 1) * padding.</summary>
|
||||
public override Vector2 GetContentSize(int count)
|
||||
{
|
||||
if (count == 0) return Vector2.Zero;
|
||||
|
||||
var rect = Content.Size;
|
||||
var effectiveWidth = rect.X - contentBorder.left - contentBorder.right;
|
||||
var cellWidth = (effectiveWidth - (columnCount - 1) * ItemsCellPadding.X) / columnCount;
|
||||
var cellHeight = cellWidth * aspectHeight;
|
||||
|
||||
var rows = Mathf.CeilToInt((float)count / columnCount);
|
||||
var contentHeight = contentBorder.top + contentBorder.bottom + rows * cellHeight + (rows - 1) * ItemsCellPadding.Y;
|
||||
var contentWidth = rect.X;
|
||||
|
||||
return new Vector2(contentWidth, contentHeight);
|
||||
}
|
||||
|
||||
protected override void PutToLayout(TItem item, int index, Control container, Vector2 contentSize)
|
||||
{
|
||||
var rectTransform = item;
|
||||
var cellIndex = GetIndex(index);
|
||||
var cellSize = GetCellSize(contentSize);
|
||||
|
||||
if (rectTransform.GetParent() != container)
|
||||
rectTransform.Reparent(container, false);
|
||||
rectTransform.Position = new Vector2(
|
||||
contentBorder.left + cellIndex.X * (cellSize.X + ItemsCellPadding.X),
|
||||
contentBorder.top + cellIndex.Y * (cellSize.Y + ItemsCellPadding.Y)
|
||||
);
|
||||
rectTransform.Size = cellSize;
|
||||
}
|
||||
|
||||
private Vector2I GetIndex(int flatIndex)
|
||||
{
|
||||
var count = ViewCellsCount;
|
||||
return new Vector2I(
|
||||
flatIndex % count.X,
|
||||
flatIndex / count.X
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists.Impls
|
||||
{
|
||||
/// <summary>
|
||||
/// Grid-based list layout with configurable column count, aspect-ratio cells,
|
||||
/// and border/padding offsets. Cell dimensions are computed dynamically from
|
||||
/// the content area width, so they scale with the parent. GetContentSize
|
||||
/// calculates the total scrollable height from item count and cell geometry,
|
||||
/// enabling vertical scrolling through a grid. PutToLayout positions items
|
||||
/// by flat-index-to-grid conversion. The isScaledCanvas flag supports
|
||||
/// resolution-independent layouts.
|
||||
/// </summary>
|
||||
public abstract partial class ColumnCellListWidget<TItem, TModel> : ListWidget<TItem, TModel>, ICellListWidget<TItem, TModel>
|
||||
where TItem : Control, IListItem<TModel>
|
||||
{
|
||||
[Export] private int columnCount;
|
||||
[Export] private float aspectHeight = 1f;
|
||||
[Export] private float borderLeft;
|
||||
[Export] private float borderRight;
|
||||
[Export] private float borderTop;
|
||||
[Export] private float borderBottom;
|
||||
[Export] private bool isScaledCanvas = true;
|
||||
|
||||
private Border contentBorder => new() { left = borderLeft, right = borderRight, top = borderTop, bottom = borderBottom };
|
||||
|
||||
/// <summary>Dynamically computed cell dimensions in pixels. Width = (content width - borders - padding * (columns - 1)) / columns; height = width * aspectHeight.</summary>
|
||||
public Vector2 CellSize => GetCellSize(Content.Size);
|
||||
|
||||
private Vector2 GetCellSize(Vector2 contentSize)
|
||||
{
|
||||
var size = contentSize;
|
||||
var effectiveWidth = size.X - contentBorder.left - contentBorder.right;
|
||||
var cellWidth = (effectiveWidth - (columnCount - 1) * ItemsCellPadding.X) / columnCount;
|
||||
var cellHeight = cellWidth * aspectHeight;
|
||||
return new Vector2(cellWidth, cellHeight);
|
||||
}
|
||||
|
||||
/// <summary>Number of cells visible in the viewport: X = columnCount, Y = floor((content height - borders) / (cell height + padding)).</summary>
|
||||
public Vector2I ViewCellsCount
|
||||
{
|
||||
get
|
||||
{
|
||||
var size = Content.Size;
|
||||
return new Vector2I(
|
||||
columnCount,
|
||||
Mathf.FloorToInt((size.Y - contentBorder.top - contentBorder.bottom) / (CellSize.Y + ItemsCellPadding.Y))
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Calculates total scrollable content height: top border + bottom border + rows * cellHeight + (rows - 1) * padding.</summary>
|
||||
public override Vector2 GetContentSize(int count)
|
||||
{
|
||||
if (count == 0) return Vector2.Zero;
|
||||
|
||||
var rect = Content.Size;
|
||||
var effectiveWidth = rect.X - contentBorder.left - contentBorder.right;
|
||||
var cellWidth = (effectiveWidth - (columnCount - 1) * ItemsCellPadding.X) / columnCount;
|
||||
var cellHeight = cellWidth * aspectHeight;
|
||||
|
||||
var rows = Mathf.CeilToInt((float)count / columnCount);
|
||||
var contentHeight = contentBorder.top + contentBorder.bottom + rows * cellHeight + (rows - 1) * ItemsCellPadding.Y;
|
||||
var contentWidth = rect.X;
|
||||
|
||||
return new Vector2(contentWidth, contentHeight);
|
||||
}
|
||||
|
||||
protected override void PutToLayout(TItem item, int index, Control container, Vector2 contentSize)
|
||||
{
|
||||
var rectTransform = item;
|
||||
var cellIndex = GetIndex(index);
|
||||
var cellSize = GetCellSize(contentSize);
|
||||
|
||||
if (rectTransform.GetParent() != container)
|
||||
rectTransform.Reparent(container, false);
|
||||
rectTransform.Position = new Vector2(
|
||||
contentBorder.left + cellIndex.X * (cellSize.X + ItemsCellPadding.X),
|
||||
contentBorder.top + cellIndex.Y * (cellSize.Y + ItemsCellPadding.Y)
|
||||
);
|
||||
rectTransform.Size = cellSize;
|
||||
}
|
||||
|
||||
private Vector2I GetIndex(int flatIndex)
|
||||
{
|
||||
var count = ViewCellsCount;
|
||||
return new Vector2I(
|
||||
flatIndex % count.X,
|
||||
flatIndex / count.X
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,33 +1,33 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists.Impls
|
||||
{
|
||||
/// <summary>
|
||||
/// Simple vertical stack layout. Items are placed top-to-bottom with padding
|
||||
/// between them, offset so the list grows upward from the content center.
|
||||
/// Content height is the sum of all item heights plus padding — no pooling
|
||||
/// or virtualization, so it's intended for short lists.
|
||||
/// </summary>
|
||||
public abstract partial class VerticalListWidget<TItem, TModel> : ListWidget<TItem, TModel>
|
||||
where TItem : Control, IListItem<TModel>
|
||||
{
|
||||
|
||||
protected override void PutToLayout(TItem item, int index, Control container, Vector2 contentSize)
|
||||
{
|
||||
var posY = index * (PrefabRect.Size.Y + ItemsCellPadding.Y);
|
||||
var itemRect = item;
|
||||
var pos = new Vector2(itemRect.Position.X, -posY + contentSize.Y * 0.5f);
|
||||
itemRect.Position = pos;
|
||||
}
|
||||
|
||||
/// <summary>Content height = count * (prefab height + Y padding). Width is inherited from the Content container.</summary>
|
||||
public override Vector2 GetContentSize(int count)
|
||||
{
|
||||
var boxSize = Content.Size;
|
||||
boxSize.Y = count * (PrefabRect.Size.Y + ItemsCellPadding.Y);
|
||||
return boxSize;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists.Impls
|
||||
{
|
||||
/// <summary>
|
||||
/// Simple vertical stack layout. Items are placed top-to-bottom with padding
|
||||
/// between them, offset so the list grows upward from the content center.
|
||||
/// Content height is the sum of all item heights plus padding — no pooling
|
||||
/// or virtualization, so it's intended for short lists.
|
||||
/// </summary>
|
||||
public abstract partial class VerticalListWidget<TItem, TModel> : ListWidget<TItem, TModel>
|
||||
where TItem : Control, IListItem<TModel>
|
||||
{
|
||||
|
||||
protected override void PutToLayout(TItem item, int index, Control container, Vector2 contentSize)
|
||||
{
|
||||
var posY = index * (PrefabRect.Size.Y + ItemsCellPadding.Y);
|
||||
var itemRect = item;
|
||||
var pos = new Vector2(itemRect.Position.X, -posY + contentSize.Y * 0.5f);
|
||||
itemRect.Position = pos;
|
||||
}
|
||||
|
||||
/// <summary>Content height = count * (prefab height + Y padding). Width is inherited from the Content container.</summary>
|
||||
public override Vector2 GetContentSize(int count)
|
||||
{
|
||||
var boxSize = Content.Size;
|
||||
boxSize.Y = count * (PrefabRect.Size.Y + ItemsCellPadding.Y);
|
||||
return boxSize;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
+29
-29
@@ -1,35 +1,35 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Base list item: stores the bound model and provides a Rect for layout.
|
||||
/// The virtual Construct saves the model reference; Destruct is abstract so
|
||||
/// subclasses must explicitly implement cleanup (signal disconnection, QueueFree).
|
||||
/// </summary>
|
||||
public abstract partial class ListItem<TModel> : Control, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>The data model bound to this list item. Set by <see cref="Construct"/>.</summary>
|
||||
public TModel Model { get; private set; }
|
||||
/// <summary>The Control that this item occupies for layout. Returns itself — ListItem is its own layout root.</summary>
|
||||
public Control Rect => this;
|
||||
|
||||
/// <summary>Saves the model reference. Override in subclasses to apply model data to UI elements.</summary>
|
||||
public virtual void Construct(TModel model)
|
||||
{
|
||||
Model = model;
|
||||
}
|
||||
|
||||
/// <summary>Required cleanup method. Subclasses must implement — typically disconnects signals and calls QueueFree.</summary>
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Base list item: stores the bound model and provides a Rect for layout.
|
||||
/// The virtual Construct saves the model reference; Destruct is abstract so
|
||||
/// subclasses must explicitly implement cleanup (signal disconnection, QueueFree).
|
||||
/// </summary>
|
||||
public abstract partial class ListItem<TModel> : Control, IListItem<TModel>
|
||||
{
|
||||
|
||||
/// <summary>The data model bound to this list item. Set by <see cref="Construct"/>.</summary>
|
||||
public TModel Model { get; private set; }
|
||||
/// <summary>The Control that this item occupies for layout. Returns itself — ListItem is its own layout root.</summary>
|
||||
public Control Rect => this;
|
||||
|
||||
/// <summary>Saves the model reference. Override in subclasses to apply model data to UI elements.</summary>
|
||||
public virtual void Construct(TModel model)
|
||||
{
|
||||
Model = model;
|
||||
}
|
||||
|
||||
/// <summary>Required cleanup method. Subclasses must implement — typically disconnects signals and calls QueueFree.</summary>
|
||||
public abstract void Destruct();
|
||||
|
||||
/// <summary>Engine callback; forwards to <see cref="OnReady"/> so mod subclasses receive the ready signal without their own engine bindings.</summary>
|
||||
public override void _Ready() => OnReady();
|
||||
|
||||
/// <summary>Forwarded from <see cref="_Ready"/>. Override for mod item initialization.</summary>
|
||||
protected virtual void OnReady() { }
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
protected virtual void OnReady() { }
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
+134
-134
@@ -1,134 +1,134 @@
|
||||
using System.Collections.Generic;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract model-driven list: instantiates items from a PackedScene prefab
|
||||
/// for each model in CreateModels(), then delegates positioning to the abstract
|
||||
/// PutToLayout (defined by layout subclasses like ColumnCellListWidget or
|
||||
/// VerticalListWidget). Refresh() tears down and rebuilds the list in place
|
||||
/// for reactive updates. The virtual Create/Init hooks let subclasses inject
|
||||
/// extra setup between instantiation and model binding without overriding
|
||||
/// CreateContent.
|
||||
/// </summary>
|
||||
public abstract partial class ListWidget<T, M> : Widget, IListWidget<T, M>
|
||||
where T : Control, IListItem<M>
|
||||
{
|
||||
|
||||
[Export]
|
||||
private Control content;
|
||||
|
||||
[Export]
|
||||
private PackedScene itemScene;
|
||||
|
||||
[Export] private Vector2 itemsCellPadding = new(0f, 1f);
|
||||
|
||||
/// <summary>Editor-configured padding between items; exposed for layout size math.</summary>
|
||||
public Vector2 ItemsCellPadding => itemsCellPadding;
|
||||
|
||||
/// <summary>Prefab instance for layout measurement. Instantiated on each access — not cached. Returns null if itemScene is not set.</summary>
|
||||
protected T Prefab => itemScene?.Instantiate<T>();
|
||||
/// <summary>The Control rect of the item prefab, used for layout size calculations.</summary>
|
||||
protected Control PrefabRect => Prefab;
|
||||
|
||||
/// <summary>The container Control that holds child items. Set via [Export] in the Godot editor.</summary>
|
||||
public Control Content => content;
|
||||
|
||||
/// <summary>Calculates the total content size for a given item count. Subclass-specific — different layouts have different formulas.</summary>
|
||||
public abstract Vector2 GetContentSize(int count);
|
||||
|
||||
/// <summary>The instantiated item collection. Set by <see cref="ConstructUI"/> and cleared by <see cref="DestructUI"/>.</summary>
|
||||
public List<T> Items { get; set; }
|
||||
|
||||
/// <summary>Shows the widget and rebuilds the UI tree via <see cref="ConstructUI"/>.</summary>
|
||||
public override void Show()
|
||||
{
|
||||
base.Show();
|
||||
ConstructUI();
|
||||
}
|
||||
|
||||
/// <summary>Tears down child items via <see cref="DestructUI"/> then hides via base <see cref="Widget.Hide"/>.</summary>
|
||||
public override void Hide()
|
||||
{
|
||||
DestructUI();
|
||||
base.Hide();
|
||||
}
|
||||
|
||||
/// <summary>Destructs and reconstructs the item tree in place. Use for reactive updates when the model collection changes.</summary>
|
||||
public void Refresh()
|
||||
{
|
||||
if (!Visible)
|
||||
return;
|
||||
|
||||
DestructUI();
|
||||
ConstructUI();
|
||||
}
|
||||
|
||||
/// <summary>Iterates <paramref name="models"/> and calls <see cref="Create"/> for each, building the item widget collection.</summary>
|
||||
public List<T> CreateContent(ICollection<M> models)
|
||||
{
|
||||
var items = new List<T>();
|
||||
|
||||
foreach (var model in models)
|
||||
{
|
||||
var item = Create(model);
|
||||
item.Construct(model);
|
||||
items.Add(item);
|
||||
}
|
||||
|
||||
return items;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Full build pipeline: gets models via <see cref="CreateModels"/>, instantiates items via <see cref="CreateContent"/>,
|
||||
/// sets the content container size via <see cref="CallDeferred"/> to size, then positions each item via <see cref="PutToLayout"/>.
|
||||
/// </summary>
|
||||
public void ConstructUI()
|
||||
{
|
||||
var rect = Content;
|
||||
var models = CreateModels();
|
||||
|
||||
var items = CreateContent(models);
|
||||
var size = GetContentSize(items.Count);
|
||||
rect.CallDeferred("set_size", size);
|
||||
|
||||
for (int i = 0; i < items.Count; i++)
|
||||
PutToLayout(items[i], i, rect, size);
|
||||
|
||||
Items = items;
|
||||
}
|
||||
|
||||
/// <summary>Subclasses implement positioning logic. Called for each item with its flat index, the content container, and total content size.</summary>
|
||||
protected abstract void PutToLayout(T item, int index, Control container, Vector2 contentSize);
|
||||
|
||||
/// <summary>Subclasses implement model sourcing. Called by <see cref="ConstructUI"/> before item instantiation.</summary>
|
||||
public abstract ICollection<M> CreateModels();
|
||||
|
||||
/// <summary>Hook for subclasses to inject setup between instantiation and model binding. Called by <see cref="Create"/>.</summary>
|
||||
protected virtual void Init(T item, M model) { }
|
||||
|
||||
/// <summary>Instantiates the PackedScene prefab, adds it to <see cref="Content"/>, and calls <see cref="Init"/> for subclass setup.</summary>
|
||||
protected virtual T Create(M model)
|
||||
{
|
||||
var instance = itemScene.Instantiate<T>();
|
||||
Content.AddChild(instance);
|
||||
Init(instance, model);
|
||||
return instance;
|
||||
}
|
||||
|
||||
/// <summary>Calls <see cref="IListItem{TModel}.Destruct"/> on each child item, clears the list, and sets Items to null.</summary>
|
||||
public void DestructUI()
|
||||
{
|
||||
if (Items == null || Items.Count == 0)
|
||||
return;
|
||||
|
||||
foreach (var item in Items)
|
||||
item.Destruct();
|
||||
|
||||
Items.Clear();
|
||||
Items = null;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
using System.Collections.Generic;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract model-driven list: instantiates items from a PackedScene prefab
|
||||
/// for each model in CreateModels(), then delegates positioning to the abstract
|
||||
/// PutToLayout (defined by layout subclasses like ColumnCellListWidget or
|
||||
/// VerticalListWidget). Refresh() tears down and rebuilds the list in place
|
||||
/// for reactive updates. The virtual Create/Init hooks let subclasses inject
|
||||
/// extra setup between instantiation and model binding without overriding
|
||||
/// CreateContent.
|
||||
/// </summary>
|
||||
public abstract partial class ListWidget<T, M> : Widget, IListWidget<T, M>
|
||||
where T : Control, IListItem<M>
|
||||
{
|
||||
|
||||
[Export]
|
||||
private Control content;
|
||||
|
||||
[Export]
|
||||
private PackedScene itemScene;
|
||||
|
||||
[Export] private Vector2 itemsCellPadding = new(0f, 1f);
|
||||
|
||||
/// <summary>Editor-configured padding between items; exposed for layout size math.</summary>
|
||||
public Vector2 ItemsCellPadding => itemsCellPadding;
|
||||
|
||||
/// <summary>Prefab instance for layout measurement. Instantiated on each access — not cached. Returns null if itemScene is not set.</summary>
|
||||
protected T Prefab => itemScene?.Instantiate<T>();
|
||||
/// <summary>The Control rect of the item prefab, used for layout size calculations.</summary>
|
||||
protected Control PrefabRect => Prefab;
|
||||
|
||||
/// <summary>The container Control that holds child items. Set via [Export] in the Godot editor.</summary>
|
||||
public Control Content => content;
|
||||
|
||||
/// <summary>Calculates the total content size for a given item count. Subclass-specific — different layouts have different formulas.</summary>
|
||||
public abstract Vector2 GetContentSize(int count);
|
||||
|
||||
/// <summary>The instantiated item collection. Set by <see cref="ConstructUI"/> and cleared by <see cref="DestructUI"/>.</summary>
|
||||
public List<T> Items { get; set; }
|
||||
|
||||
/// <summary>Shows the widget and rebuilds the UI tree via <see cref="ConstructUI"/>.</summary>
|
||||
public override void Show()
|
||||
{
|
||||
base.Show();
|
||||
ConstructUI();
|
||||
}
|
||||
|
||||
/// <summary>Tears down child items via <see cref="DestructUI"/> then hides via base <see cref="Widget.Hide"/>.</summary>
|
||||
public override void Hide()
|
||||
{
|
||||
DestructUI();
|
||||
base.Hide();
|
||||
}
|
||||
|
||||
/// <summary>Destructs and reconstructs the item tree in place. Use for reactive updates when the model collection changes.</summary>
|
||||
public void Refresh()
|
||||
{
|
||||
if (!Visible)
|
||||
return;
|
||||
|
||||
DestructUI();
|
||||
ConstructUI();
|
||||
}
|
||||
|
||||
/// <summary>Iterates <paramref name="models"/> and calls <see cref="Create"/> for each, building the item widget collection.</summary>
|
||||
public List<T> CreateContent(ICollection<M> models)
|
||||
{
|
||||
var items = new List<T>();
|
||||
|
||||
foreach (var model in models)
|
||||
{
|
||||
var item = Create(model);
|
||||
item.Construct(model);
|
||||
items.Add(item);
|
||||
}
|
||||
|
||||
return items;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Full build pipeline: gets models via <see cref="CreateModels"/>, instantiates items via <see cref="CreateContent"/>,
|
||||
/// sets the content container size via <see cref="CallDeferred"/> to size, then positions each item via <see cref="PutToLayout"/>.
|
||||
/// </summary>
|
||||
public void ConstructUI()
|
||||
{
|
||||
var rect = Content;
|
||||
var models = CreateModels();
|
||||
|
||||
var items = CreateContent(models);
|
||||
var size = GetContentSize(items.Count);
|
||||
rect.CallDeferred("set_size", size);
|
||||
|
||||
for (int i = 0; i < items.Count; i++)
|
||||
PutToLayout(items[i], i, rect, size);
|
||||
|
||||
Items = items;
|
||||
}
|
||||
|
||||
/// <summary>Subclasses implement positioning logic. Called for each item with its flat index, the content container, and total content size.</summary>
|
||||
protected abstract void PutToLayout(T item, int index, Control container, Vector2 contentSize);
|
||||
|
||||
/// <summary>Subclasses implement model sourcing. Called by <see cref="ConstructUI"/> before item instantiation.</summary>
|
||||
public abstract ICollection<M> CreateModels();
|
||||
|
||||
/// <summary>Hook for subclasses to inject setup between instantiation and model binding. Called by <see cref="Create"/>.</summary>
|
||||
protected virtual void Init(T item, M model) { }
|
||||
|
||||
/// <summary>Instantiates the PackedScene prefab, adds it to <see cref="Content"/>, and calls <see cref="Init"/> for subclass setup.</summary>
|
||||
protected virtual T Create(M model)
|
||||
{
|
||||
var instance = itemScene.Instantiate<T>();
|
||||
Content.AddChild(instance);
|
||||
Init(instance, model);
|
||||
return instance;
|
||||
}
|
||||
|
||||
/// <summary>Calls <see cref="IListItem{TModel}.Destruct"/> on each child item, clears the list, and sets Items to null.</summary>
|
||||
public void DestructUI()
|
||||
{
|
||||
if (Items == null || Items.Count == 0)
|
||||
return;
|
||||
|
||||
foreach (var item in Items)
|
||||
item.Destruct();
|
||||
|
||||
Items.Clear();
|
||||
Items = null;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
+36
-36
@@ -1,38 +1,38 @@
|
||||
using Godot;
|
||||
|
||||
using Godot;
|
||||
|
||||
using Cthangover.Core.UI;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Lightweight alternative to Widget for mod-authored controls. Has a simpler
|
||||
/// lifecycle — just Construct() on first access and Destruct() on tree exit —
|
||||
/// without the visibility interception and Show/Hide pipeline that Widget
|
||||
/// carries. Use when the heavy Widget state machine would be overkill or
|
||||
/// when the control's visibility is managed by Godot's native system.
|
||||
/// </summary>
|
||||
public abstract partial class ModWidget : Control, IUiLazyConstruct
|
||||
{
|
||||
private bool _constructed;
|
||||
|
||||
/// <summary>Idempotent construction gate: calls <see cref="Construct"/> exactly once, on the first invocation. Thread-safe for repeated external calls.</summary>
|
||||
public void EnsureConstructed()
|
||||
{
|
||||
if (_constructed)
|
||||
return;
|
||||
_constructed = true;
|
||||
|
||||
Construct();
|
||||
}
|
||||
|
||||
/// <summary>Runs <see cref="Destruct"/> once when the constructed control leaves the tree.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (_constructed)
|
||||
Destruct();
|
||||
}
|
||||
|
||||
protected abstract void Construct();
|
||||
protected virtual void Destruct() { }
|
||||
}
|
||||
}
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Lightweight alternative to Widget for mod-authored controls. Has a simpler
|
||||
/// lifecycle — just Construct() on first access and Destruct() on tree exit —
|
||||
/// without the visibility interception and Show/Hide pipeline that Widget
|
||||
/// carries. Use when the heavy Widget state machine would be overkill or
|
||||
/// when the control's visibility is managed by Godot's native system.
|
||||
/// </summary>
|
||||
public abstract partial class ModWidget : Control, IUiLazyConstruct
|
||||
{
|
||||
private bool _constructed;
|
||||
|
||||
/// <summary>Idempotent construction gate: calls <see cref="Construct"/> exactly once, on the first invocation. Thread-safe for repeated external calls.</summary>
|
||||
public void EnsureConstructed()
|
||||
{
|
||||
if (_constructed)
|
||||
return;
|
||||
_constructed = true;
|
||||
|
||||
Construct();
|
||||
}
|
||||
|
||||
/// <summary>Runs <see cref="Destruct"/> once when the constructed control leaves the tree.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (_constructed)
|
||||
Destruct();
|
||||
}
|
||||
|
||||
protected abstract void Construct();
|
||||
protected virtual void Destruct() { }
|
||||
}
|
||||
}
|
||||
+128
-128
@@ -1,128 +1,128 @@
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.Mods.Resolvers;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Shader-based scene transition: animates a "progress" uniform on the
|
||||
/// background's ShaderMaterial via a Godot Tween, then reveals content after
|
||||
/// a configurable delay. The shader is resolved through the mod system
|
||||
/// (ModManager.ResolveShader), allowing mods to replace the transition effect.
|
||||
/// Uses an easeInOut curve for the progress ramp. Material is duplicated on
|
||||
/// first use so each instance gets its own shader parameters. On tree exit,
|
||||
/// the duplicated material is disposed to avoid leaks.
|
||||
/// </summary>
|
||||
public abstract partial class TransitionWidget : Widget
|
||||
{
|
||||
private static readonly StringName ProgressParam = "progress";
|
||||
|
||||
[Export] private TextureRect imgBackground;
|
||||
[Export] private Control contentGroup;
|
||||
[Export] private float transitionDuration = 0.8f;
|
||||
[Export] private float contentDelay = 0.05f;
|
||||
|
||||
private ShaderMaterial materialInstance;
|
||||
private Tween transitionTween;
|
||||
|
||||
/// <summary>
|
||||
/// Shows the widget base, then creates or reuses a shader material for the background and starts the transition tween.
|
||||
/// Material is duplicated from <c>imgBackground.Material</c> on first call so each instance gets independent shader parameters.
|
||||
/// </summary>
|
||||
public override void Show()
|
||||
{
|
||||
base.Show();
|
||||
|
||||
if (materialInstance == null && imgBackground != null)
|
||||
{
|
||||
materialInstance = imgBackground.Material?.Duplicate() as ShaderMaterial;
|
||||
if (materialInstance == null)
|
||||
{
|
||||
materialInstance = new ShaderMaterial();
|
||||
var shader = Shaders.Resolve("scene_transition");
|
||||
if (shader != null)
|
||||
materialInstance.Shader = shader;
|
||||
}
|
||||
imgBackground.Material = materialInstance;
|
||||
materialInstance.SetShaderParameter(ProgressParam, 0f);
|
||||
}
|
||||
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
RunShowAnimation();
|
||||
}
|
||||
|
||||
/// <summary>Kills the active transition tween if one is running, then calls base <see cref="Widget.Hide"/>.</summary>
|
||||
public override void Hide()
|
||||
{
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
base.Hide();
|
||||
}
|
||||
|
||||
private void RunShowAnimation()
|
||||
{
|
||||
if (contentGroup != null)
|
||||
{
|
||||
contentGroup.Modulate = UiTokens.Alpha(UiTokens.White, 0f);
|
||||
contentGroup.MouseFilter = MouseFilterEnum.Ignore;
|
||||
}
|
||||
|
||||
transitionTween = CreateTween();
|
||||
transitionTween.SetProcessMode(Tween.TweenProcessMode.Physics);
|
||||
transitionTween.TweenMethod(Callable.From<float>(OnProgressUpdate), 0f, 1f, transitionDuration);
|
||||
transitionTween.Finished += OnTweenFinished;
|
||||
}
|
||||
|
||||
private void OnProgressUpdate(float t)
|
||||
{
|
||||
float curvedT = EaseInOut(t);
|
||||
if (imgBackground?.Material is ShaderMaterial mat)
|
||||
mat.SetShaderParameter(ProgressParam, curvedT);
|
||||
}
|
||||
|
||||
private void OnTweenFinished()
|
||||
{
|
||||
if (imgBackground?.Material is ShaderMaterial mat)
|
||||
mat.SetShaderParameter(ProgressParam, 1f);
|
||||
|
||||
var timer = GetTree().CreateTimer(contentDelay);
|
||||
timer.Timeout += () =>
|
||||
{
|
||||
if (contentGroup != null)
|
||||
{
|
||||
contentGroup.Modulate = UiTokens.White;
|
||||
contentGroup.MouseFilter = MouseFilterEnum.Stop;
|
||||
}
|
||||
};
|
||||
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
private static float EaseInOut(float t)
|
||||
{
|
||||
return t < 0.5f ? 2f * t * t : 1f - Mathf.Pow(-2f * t + 2f, 2f) / 2f;
|
||||
}
|
||||
|
||||
/// <summary>Disposes the per-instance shader material created for the transition.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (materialInstance != null)
|
||||
{
|
||||
materialInstance.Dispose();
|
||||
materialInstance = null;
|
||||
}
|
||||
base._ExitTree();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.Mods.Resolvers;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Shader-based scene transition: animates a "progress" uniform on the
|
||||
/// background's ShaderMaterial via a Godot Tween, then reveals content after
|
||||
/// a configurable delay. The shader is resolved through the mod system
|
||||
/// (ModManager.ResolveShader), allowing mods to replace the transition effect.
|
||||
/// Uses an easeInOut curve for the progress ramp. Material is duplicated on
|
||||
/// first use so each instance gets its own shader parameters. On tree exit,
|
||||
/// the duplicated material is disposed to avoid leaks.
|
||||
/// </summary>
|
||||
public abstract partial class TransitionWidget : Widget
|
||||
{
|
||||
private static readonly StringName ProgressParam = "progress";
|
||||
|
||||
[Export] private TextureRect imgBackground;
|
||||
[Export] private Control contentGroup;
|
||||
[Export] private float transitionDuration = 0.8f;
|
||||
[Export] private float contentDelay = 0.05f;
|
||||
|
||||
private ShaderMaterial materialInstance;
|
||||
private Tween transitionTween;
|
||||
|
||||
/// <summary>
|
||||
/// Shows the widget base, then creates or reuses a shader material for the background and starts the transition tween.
|
||||
/// Material is duplicated from <c>imgBackground.Material</c> on first call so each instance gets independent shader parameters.
|
||||
/// </summary>
|
||||
public override void Show()
|
||||
{
|
||||
base.Show();
|
||||
|
||||
if (materialInstance == null && imgBackground != null)
|
||||
{
|
||||
materialInstance = imgBackground.Material?.Duplicate() as ShaderMaterial;
|
||||
if (materialInstance == null)
|
||||
{
|
||||
materialInstance = new ShaderMaterial();
|
||||
var shader = Shaders.Resolve("scene_transition");
|
||||
if (shader != null)
|
||||
materialInstance.Shader = shader;
|
||||
}
|
||||
imgBackground.Material = materialInstance;
|
||||
materialInstance.SetShaderParameter(ProgressParam, 0f);
|
||||
}
|
||||
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
RunShowAnimation();
|
||||
}
|
||||
|
||||
/// <summary>Kills the active transition tween if one is running, then calls base <see cref="Widget.Hide"/>.</summary>
|
||||
public override void Hide()
|
||||
{
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
base.Hide();
|
||||
}
|
||||
|
||||
private void RunShowAnimation()
|
||||
{
|
||||
if (contentGroup != null)
|
||||
{
|
||||
contentGroup.Modulate = UiTokens.Alpha(UiTokens.White, 0f);
|
||||
contentGroup.MouseFilter = MouseFilterEnum.Ignore;
|
||||
}
|
||||
|
||||
transitionTween = CreateTween();
|
||||
transitionTween.SetProcessMode(Tween.TweenProcessMode.Physics);
|
||||
transitionTween.TweenMethod(Callable.From<float>(OnProgressUpdate), 0f, 1f, transitionDuration);
|
||||
transitionTween.Finished += OnTweenFinished;
|
||||
}
|
||||
|
||||
private void OnProgressUpdate(float t)
|
||||
{
|
||||
float curvedT = EaseInOut(t);
|
||||
if (imgBackground?.Material is ShaderMaterial mat)
|
||||
mat.SetShaderParameter(ProgressParam, curvedT);
|
||||
}
|
||||
|
||||
private void OnTweenFinished()
|
||||
{
|
||||
if (imgBackground?.Material is ShaderMaterial mat)
|
||||
mat.SetShaderParameter(ProgressParam, 1f);
|
||||
|
||||
var timer = GetTree().CreateTimer(contentDelay);
|
||||
timer.Timeout += () =>
|
||||
{
|
||||
if (contentGroup != null)
|
||||
{
|
||||
contentGroup.Modulate = UiTokens.White;
|
||||
contentGroup.MouseFilter = MouseFilterEnum.Stop;
|
||||
}
|
||||
};
|
||||
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
private static float EaseInOut(float t)
|
||||
{
|
||||
return t < 0.5f ? 2f * t * t : 1f - Mathf.Pow(-2f * t + 2f, 2f) / 2f;
|
||||
}
|
||||
|
||||
/// <summary>Disposes the per-instance shader material created for the transition.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (materialInstance != null)
|
||||
{
|
||||
materialInstance.Dispose();
|
||||
materialInstance = null;
|
||||
}
|
||||
base._ExitTree();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+192
-192
@@ -1,194 +1,194 @@
|
||||
using Cthangover.Core.Utils;
|
||||
using Godot;
|
||||
|
||||
using Cthangover.Core.Utils;
|
||||
using Godot;
|
||||
|
||||
using Cthangover.Core.UI;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Base widget with a lazy construct/destruct lifecycle around Show/Hide.
|
||||
/// On first Show(), OnceConstruct() fires once via EnsureConstructed — subsequent
|
||||
/// Show/Hide calls trigger ShowConstruct/HideDestruct instead, allowing repeated
|
||||
/// state reset without full reconstruction. Overrides Godot's built-in Visible
|
||||
/// property to intercept visibility changes and route them through the lifecycle.
|
||||
/// Maintains an independent isVisible flag because Godot's visibility has quirks
|
||||
/// (e.g. parent visibility propagation) that would break the state machine.
|
||||
/// The #if TOOLS _ValidateProperty syncs the editor inspector with the override.
|
||||
/// </summary>
|
||||
public abstract partial class Widget : Control, IWidget
|
||||
{
|
||||
private bool isConstructed;
|
||||
|
||||
/// <summary>Syncs the internal visibility flag with the scene-file state and hides properly when the widget starts hidden.</summary>
|
||||
public override void _Ready()
|
||||
{
|
||||
GameLogger.Log("WIDGET", $"_Ready: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
isVisible = base.Visible;
|
||||
if (!isVisible)
|
||||
Hide();
|
||||
OnReady();
|
||||
}
|
||||
|
||||
/// <summary>Tears down a constructed widget when it leaves the tree, so hidden-while-freed widgets still release their resources.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (isConstructed)
|
||||
OnceDestruct();
|
||||
OnExitTree();
|
||||
}
|
||||
|
||||
/// <summary>Engine callback; forwards to <see cref="OnInput"/> so mod subclasses receive input without their own engine bindings.</summary>
|
||||
public override void _Input(InputEvent @event) => OnInput(@event);
|
||||
|
||||
/// <summary>Forwarded from <see cref="_Ready"/>. Override for mod widget initialization.</summary>
|
||||
protected virtual void OnReady() { }
|
||||
|
||||
/// <summary>Forwarded from <see cref="_ExitTree"/>. Override for mod widget teardown.</summary>
|
||||
protected virtual void OnExitTree() { }
|
||||
|
||||
/// <summary>Forwarded from <see cref="_Input"/>. Override to handle input in mod widgets.</summary>
|
||||
protected virtual void OnInput(InputEvent @event) { }
|
||||
|
||||
/// <summary>Toggles visibility: calls <see cref="Hide"/> if visible, <see cref="Show"/> otherwise.</summary>
|
||||
public void Switch()
|
||||
{
|
||||
if (Visible)
|
||||
Hide();
|
||||
else
|
||||
Show();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Makes visible and runs lifecycle. On first call, <see cref="EnsureConstructed"/> fires <see cref="OnceConstruct"/>.
|
||||
/// Subsequent calls trigger <see cref="ShowConstruct"/> without reconstruction. Sets both the internal isVisible flag
|
||||
/// and Godot's native visibility, then explicitly shows the Body canvas item.
|
||||
/// </summary>
|
||||
public new virtual void Show()
|
||||
{
|
||||
GameLogger.Log("WIDGET", $"Show ENTER: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
var wasConstructed = isConstructed;
|
||||
EnsureConstructed();
|
||||
|
||||
if (Visible)
|
||||
{
|
||||
if (!wasConstructed)
|
||||
ShowConstruct();
|
||||
GameLogger.Log("WIDGET", $"Show SKIP: already visible", LogLevel.Debug);
|
||||
return;
|
||||
}
|
||||
|
||||
ShowConstruct();
|
||||
|
||||
isVisible = true;
|
||||
base.Visible = true;
|
||||
|
||||
var canvasBody = Body as CanvasItem;
|
||||
if (canvasBody != null)
|
||||
canvasBody.Visible = true;
|
||||
|
||||
(Body as Control)?.QueueRedraw();
|
||||
|
||||
GameLogger.Log("WIDGET", $"Show EXIT: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
}
|
||||
|
||||
/// <summary>Hides the widget, fires <see cref="HideDestruct"/> if constructed, sets internal and Godot visibility to false, and hides the Body canvas item.</summary>
|
||||
public new virtual void Hide()
|
||||
{
|
||||
if (!Visible)
|
||||
return;
|
||||
|
||||
if (isConstructed)
|
||||
HideDestruct();
|
||||
|
||||
isVisible = false;
|
||||
base.Visible = false;
|
||||
|
||||
var canvasBody = Body as CanvasItem;
|
||||
if (canvasBody != null)
|
||||
canvasBody.Visible = false;
|
||||
}
|
||||
|
||||
/// <summary>Idempotent construction gate: calls <see cref="OnceConstruct"/> exactly once, on the first invocation.</summary>
|
||||
public void EnsureConstructed()
|
||||
{
|
||||
if (!isConstructed)
|
||||
{
|
||||
isConstructed = true;
|
||||
OnceConstruct();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Called exactly once on the first <see cref="Show"/>. Override to perform one-time initialization.</summary>
|
||||
protected virtual void OnceConstruct()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>Called once on tree exit if constructed. Override for one-time cleanup of resources allocated in <see cref="OnceConstruct"/>.</summary>
|
||||
protected virtual void OnceDestruct()
|
||||
{
|
||||
}
|
||||
|
||||
[Export] private bool isVisible = true;
|
||||
|
||||
[Export] private Node body;
|
||||
|
||||
/// <summary>
|
||||
/// Shadows Godot's built-in visibility. Setting to true calls <see cref="Show"/>, setting to false calls <see cref="Hide"/>.
|
||||
/// Maintains an independent <c>isVisible</c> flag because Godot's native visibility propagates through the parent chain,
|
||||
/// which would break the explicit lifecycle state machine.
|
||||
/// </summary>
|
||||
public new bool Visible
|
||||
{
|
||||
get => isVisible;
|
||||
set
|
||||
{
|
||||
if (isVisible == value)
|
||||
return;
|
||||
|
||||
if (value)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The rendered content subtree. May be a child node separate from the Rect layout root.</summary>
|
||||
public Node Body => body;
|
||||
|
||||
/// <summary>The Control used for layout. For Widget this is the node itself, enabling it to serve as both layout root and widget.</summary>
|
||||
public Control Rect => this;
|
||||
|
||||
/// <summary>Called each time <see cref="Show"/> runs after initial construction. Override to refresh state (e.g. reload data, re-enable input).</summary>
|
||||
protected virtual void ShowConstruct()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>Called each time <see cref="Hide"/> runs when constructed. Override to clean up display-only state without destroying permanent resources.</summary>
|
||||
protected virtual void HideDestruct()
|
||||
{
|
||||
}
|
||||
|
||||
#if TOOLS
|
||||
/// <summary>Keeps the inspector in sync with the overridden visibility: touching <c>visible</c> or <c>isVisible</c> in the editor routes through the lifecycle.</summary>
|
||||
public override void _ValidateProperty(Godot.Collections.Dictionary property)
|
||||
{
|
||||
base._ValidateProperty(property);
|
||||
if (property.TryGetValue("visible", out var _))
|
||||
{
|
||||
isVisible = base.Visible;
|
||||
if (isVisible)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
else if (property.TryGetValue("isVisible", out var _))
|
||||
{
|
||||
if (isVisible)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
namespace Cthangover.Mods.Interface.Base.Lists
|
||||
{
|
||||
/// <summary>
|
||||
/// Base widget with a lazy construct/destruct lifecycle around Show/Hide.
|
||||
/// On first Show(), OnceConstruct() fires once via EnsureConstructed — subsequent
|
||||
/// Show/Hide calls trigger ShowConstruct/HideDestruct instead, allowing repeated
|
||||
/// state reset without full reconstruction. Overrides Godot's built-in Visible
|
||||
/// property to intercept visibility changes and route them through the lifecycle.
|
||||
/// Maintains an independent isVisible flag because Godot's visibility has quirks
|
||||
/// (e.g. parent visibility propagation) that would break the state machine.
|
||||
/// The #if TOOLS _ValidateProperty syncs the editor inspector with the override.
|
||||
/// </summary>
|
||||
public abstract partial class Widget : Control, IWidget
|
||||
{
|
||||
private bool isConstructed;
|
||||
|
||||
/// <summary>Syncs the internal visibility flag with the scene-file state and hides properly when the widget starts hidden.</summary>
|
||||
public override void _Ready()
|
||||
{
|
||||
GameLogger.Log("WIDGET", $"_Ready: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
isVisible = base.Visible;
|
||||
if (!isVisible)
|
||||
Hide();
|
||||
OnReady();
|
||||
}
|
||||
|
||||
/// <summary>Tears down a constructed widget when it leaves the tree, so hidden-while-freed widgets still release their resources.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (isConstructed)
|
||||
OnceDestruct();
|
||||
OnExitTree();
|
||||
}
|
||||
|
||||
/// <summary>Engine callback; forwards to <see cref="OnInput"/> so mod subclasses receive input without their own engine bindings.</summary>
|
||||
public override void _Input(InputEvent @event) => OnInput(@event);
|
||||
|
||||
/// <summary>Forwarded from <see cref="_Ready"/>. Override for mod widget initialization.</summary>
|
||||
protected virtual void OnReady() { }
|
||||
|
||||
/// <summary>Forwarded from <see cref="_ExitTree"/>. Override for mod widget teardown.</summary>
|
||||
protected virtual void OnExitTree() { }
|
||||
|
||||
/// <summary>Forwarded from <see cref="_Input"/>. Override to handle input in mod widgets.</summary>
|
||||
protected virtual void OnInput(InputEvent @event) { }
|
||||
|
||||
/// <summary>Toggles visibility: calls <see cref="Hide"/> if visible, <see cref="Show"/> otherwise.</summary>
|
||||
public void Switch()
|
||||
{
|
||||
if (Visible)
|
||||
Hide();
|
||||
else
|
||||
Show();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Makes visible and runs lifecycle. On first call, <see cref="EnsureConstructed"/> fires <see cref="OnceConstruct"/>.
|
||||
/// Subsequent calls trigger <see cref="ShowConstruct"/> without reconstruction. Sets both the internal isVisible flag
|
||||
/// and Godot's native visibility, then explicitly shows the Body canvas item.
|
||||
/// </summary>
|
||||
public new virtual void Show()
|
||||
{
|
||||
GameLogger.Log("WIDGET", $"Show ENTER: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
var wasConstructed = isConstructed;
|
||||
EnsureConstructed();
|
||||
|
||||
if (Visible)
|
||||
{
|
||||
if (!wasConstructed)
|
||||
ShowConstruct();
|
||||
GameLogger.Log("WIDGET", $"Show SKIP: already visible", LogLevel.Debug);
|
||||
return;
|
||||
}
|
||||
|
||||
ShowConstruct();
|
||||
|
||||
isVisible = true;
|
||||
base.Visible = true;
|
||||
|
||||
var canvasBody = Body as CanvasItem;
|
||||
if (canvasBody != null)
|
||||
canvasBody.Visible = true;
|
||||
|
||||
(Body as Control)?.QueueRedraw();
|
||||
|
||||
GameLogger.Log("WIDGET", $"Show EXIT: name={Name}, isVisible={isVisible}, GodotVisible={base.Visible}", LogLevel.Debug);
|
||||
}
|
||||
|
||||
/// <summary>Hides the widget, fires <see cref="HideDestruct"/> if constructed, sets internal and Godot visibility to false, and hides the Body canvas item.</summary>
|
||||
public new virtual void Hide()
|
||||
{
|
||||
if (!Visible)
|
||||
return;
|
||||
|
||||
if (isConstructed)
|
||||
HideDestruct();
|
||||
|
||||
isVisible = false;
|
||||
base.Visible = false;
|
||||
|
||||
var canvasBody = Body as CanvasItem;
|
||||
if (canvasBody != null)
|
||||
canvasBody.Visible = false;
|
||||
}
|
||||
|
||||
/// <summary>Idempotent construction gate: calls <see cref="OnceConstruct"/> exactly once, on the first invocation.</summary>
|
||||
public void EnsureConstructed()
|
||||
{
|
||||
if (!isConstructed)
|
||||
{
|
||||
isConstructed = true;
|
||||
OnceConstruct();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Called exactly once on the first <see cref="Show"/>. Override to perform one-time initialization.</summary>
|
||||
protected virtual void OnceConstruct()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>Called once on tree exit if constructed. Override for one-time cleanup of resources allocated in <see cref="OnceConstruct"/>.</summary>
|
||||
protected virtual void OnceDestruct()
|
||||
{
|
||||
}
|
||||
|
||||
[Export] private bool isVisible = true;
|
||||
|
||||
[Export] private Node body;
|
||||
|
||||
/// <summary>
|
||||
/// Shadows Godot's built-in visibility. Setting to true calls <see cref="Show"/>, setting to false calls <see cref="Hide"/>.
|
||||
/// Maintains an independent <c>isVisible</c> flag because Godot's native visibility propagates through the parent chain,
|
||||
/// which would break the explicit lifecycle state machine.
|
||||
/// </summary>
|
||||
public new bool Visible
|
||||
{
|
||||
get => isVisible;
|
||||
set
|
||||
{
|
||||
if (isVisible == value)
|
||||
return;
|
||||
|
||||
if (value)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The rendered content subtree. May be a child node separate from the Rect layout root.</summary>
|
||||
public Node Body => body;
|
||||
|
||||
/// <summary>The Control used for layout. For Widget this is the node itself, enabling it to serve as both layout root and widget.</summary>
|
||||
public Control Rect => this;
|
||||
|
||||
/// <summary>Called each time <see cref="Show"/> runs after initial construction. Override to refresh state (e.g. reload data, re-enable input).</summary>
|
||||
protected virtual void ShowConstruct()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>Called each time <see cref="Hide"/> runs when constructed. Override to clean up display-only state without destroying permanent resources.</summary>
|
||||
protected virtual void HideDestruct()
|
||||
{
|
||||
}
|
||||
|
||||
#if TOOLS
|
||||
/// <summary>Keeps the inspector in sync with the overridden visibility: touching <c>visible</c> or <c>isVisible</c> in the editor routes through the lifecycle.</summary>
|
||||
public override void _ValidateProperty(Godot.Collections.Dictionary property)
|
||||
{
|
||||
base._ValidateProperty(property);
|
||||
if (property.TryGetValue("visible", out var _))
|
||||
{
|
||||
isVisible = base.Visible;
|
||||
if (isVisible)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
else if (property.TryGetValue("isVisible", out var _))
|
||||
{
|
||||
if (isVisible)
|
||||
Show();
|
||||
else
|
||||
Hide();
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
+137
-137
@@ -1,137 +1,137 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Event
|
||||
{
|
||||
/// <summary>
|
||||
/// Stateless input abstraction that maps mouse to a virtual single-touch source.
|
||||
/// Tracks mouse-down state between frames to derive touch phases (Began/Moved/
|
||||
/// Ended/Stationary), enabling touch-aware code to work with mouse-only devices.
|
||||
/// Provides both UI-space (UITouchPosition) and screen-space (TouchPosition)
|
||||
/// coordinate access. Update() must be called each frame to refresh the
|
||||
/// wasMouseDownLastFrame flag.
|
||||
/// </summary>
|
||||
public static class DeviceInput
|
||||
{
|
||||
/// <summary>
|
||||
/// Index of the active touch (always 0 for the mouse-backed single-touch
|
||||
/// model). Exposed for API compatibility with potential multi-touch support.
|
||||
/// </summary>
|
||||
public static int CurrentTouchIndex { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Derives a <see cref="TouchPhase"/> from mouse button state across frames.
|
||||
/// Compares the current left-button state against <c>wasMouseDownLastFrame</c>:
|
||||
/// Began on fresh press, Moved on hold, Ended on release.
|
||||
/// </summary>
|
||||
public static TouchPhase GetTouchPhase
|
||||
{
|
||||
get
|
||||
{
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left))
|
||||
{
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left) && !wasMouseDownLastFrame)
|
||||
return TouchPhase.Began;
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left) && wasMouseDownLastFrame)
|
||||
return TouchPhase.Moved;
|
||||
}
|
||||
else
|
||||
{
|
||||
if (wasMouseDownLastFrame)
|
||||
return TouchPhase.Ended;
|
||||
}
|
||||
return TouchPhase.Stationary;
|
||||
}
|
||||
}
|
||||
|
||||
private static bool wasMouseDownLastFrame;
|
||||
|
||||
/// <summary>
|
||||
/// Must be called each frame to snapshot the mouse button state. The saved
|
||||
/// state drives <see cref="GetTouchPhase"/> for press/release transitions.
|
||||
/// </summary>
|
||||
public static void Update()
|
||||
{
|
||||
wasMouseDownLastFrame = Input.IsMouseButtonPressed(MouseButton.Left);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns 1 when the left mouse button is pressed, 0 otherwise.
|
||||
/// Maps the mouse to a single-touch model.
|
||||
/// </summary>
|
||||
public static int TouchCount
|
||||
{
|
||||
get
|
||||
{
|
||||
return Input.IsMouseButtonPressed(MouseButton.Left) ? 1 : 0;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mouse position in UI space (top-left origin, Control coordinate system).
|
||||
/// Used for hit-testing against Control nodes in the UI layer.
|
||||
/// </summary>
|
||||
public static Vector2 UITouchPosition
|
||||
{
|
||||
get
|
||||
{
|
||||
var mp = GetViewport()?.GetMousePosition() ?? Vector2.Zero;
|
||||
// In Godot, UI coordinates match mouse coordinates (top-left origin in Control nodes)
|
||||
return mp;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mouse position in screen space. Used for raycasting against 2D/3D
|
||||
/// world objects.
|
||||
/// </summary>
|
||||
public static Vector2 TouchPosition
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetViewport()?.GetMousePosition() ?? Vector2.Zero;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts <see cref="TouchPosition"/> to a 3D vector (z=0) for ray-origin
|
||||
/// calculations in the 3D input pipeline.
|
||||
/// </summary>
|
||||
public static Vector3 TouchPosition3D
|
||||
{
|
||||
get
|
||||
{
|
||||
var pos = TouchPosition;
|
||||
return new Vector3(pos.X, pos.Y, 0);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Last-frame mouse velocity from Godot's <c>Input.GetLastMouseVelocity()</c>.
|
||||
/// Used by drag handlers to compute movement deltas.
|
||||
/// </summary>
|
||||
public static Vector2 TouchDelta
|
||||
{
|
||||
get
|
||||
{
|
||||
return Input.GetLastMouseVelocity();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the current touch position. The <paramref name="index"/> parameter
|
||||
/// is ignored in the single-touch model — always returns <see cref="TouchPosition"/>.
|
||||
/// Exists for multi-touch API compatibility.
|
||||
/// </summary>
|
||||
/// <param name="index">Touch index (ignored in current implementation).</param>
|
||||
public static Vector2 GetTouchPosition(int index)
|
||||
{
|
||||
return TouchPosition;
|
||||
}
|
||||
|
||||
private static Viewport GetViewport()
|
||||
{
|
||||
var tree = Godot.Engine.GetMainLoop() as SceneTree;
|
||||
return tree?.Root?.GetViewport();
|
||||
}
|
||||
}
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Event
|
||||
{
|
||||
/// <summary>
|
||||
/// Stateless input abstraction that maps mouse to a virtual single-touch source.
|
||||
/// Tracks mouse-down state between frames to derive touch phases (Began/Moved/
|
||||
/// Ended/Stationary), enabling touch-aware code to work with mouse-only devices.
|
||||
/// Provides both UI-space (UITouchPosition) and screen-space (TouchPosition)
|
||||
/// coordinate access. Update() must be called each frame to refresh the
|
||||
/// wasMouseDownLastFrame flag.
|
||||
/// </summary>
|
||||
public static class DeviceInput
|
||||
{
|
||||
/// <summary>
|
||||
/// Index of the active touch (always 0 for the mouse-backed single-touch
|
||||
/// model). Exposed for API compatibility with potential multi-touch support.
|
||||
/// </summary>
|
||||
public static int CurrentTouchIndex { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Derives a <see cref="TouchPhase"/> from mouse button state across frames.
|
||||
/// Compares the current left-button state against <c>wasMouseDownLastFrame</c>:
|
||||
/// Began on fresh press, Moved on hold, Ended on release.
|
||||
/// </summary>
|
||||
public static TouchPhase GetTouchPhase
|
||||
{
|
||||
get
|
||||
{
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left))
|
||||
{
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left) && !wasMouseDownLastFrame)
|
||||
return TouchPhase.Began;
|
||||
if (Input.IsMouseButtonPressed(MouseButton.Left) && wasMouseDownLastFrame)
|
||||
return TouchPhase.Moved;
|
||||
}
|
||||
else
|
||||
{
|
||||
if (wasMouseDownLastFrame)
|
||||
return TouchPhase.Ended;
|
||||
}
|
||||
return TouchPhase.Stationary;
|
||||
}
|
||||
}
|
||||
|
||||
private static bool wasMouseDownLastFrame;
|
||||
|
||||
/// <summary>
|
||||
/// Must be called each frame to snapshot the mouse button state. The saved
|
||||
/// state drives <see cref="GetTouchPhase"/> for press/release transitions.
|
||||
/// </summary>
|
||||
public static void Update()
|
||||
{
|
||||
wasMouseDownLastFrame = Input.IsMouseButtonPressed(MouseButton.Left);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns 1 when the left mouse button is pressed, 0 otherwise.
|
||||
/// Maps the mouse to a single-touch model.
|
||||
/// </summary>
|
||||
public static int TouchCount
|
||||
{
|
||||
get
|
||||
{
|
||||
return Input.IsMouseButtonPressed(MouseButton.Left) ? 1 : 0;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mouse position in UI space (top-left origin, Control coordinate system).
|
||||
/// Used for hit-testing against Control nodes in the UI layer.
|
||||
/// </summary>
|
||||
public static Vector2 UITouchPosition
|
||||
{
|
||||
get
|
||||
{
|
||||
var mp = GetViewport()?.GetMousePosition() ?? Vector2.Zero;
|
||||
// In Godot, UI coordinates match mouse coordinates (top-left origin in Control nodes)
|
||||
return mp;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mouse position in screen space. Used for raycasting against 2D/3D
|
||||
/// world objects.
|
||||
/// </summary>
|
||||
public static Vector2 TouchPosition
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetViewport()?.GetMousePosition() ?? Vector2.Zero;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts <see cref="TouchPosition"/> to a 3D vector (z=0) for ray-origin
|
||||
/// calculations in the 3D input pipeline.
|
||||
/// </summary>
|
||||
public static Vector3 TouchPosition3D
|
||||
{
|
||||
get
|
||||
{
|
||||
var pos = TouchPosition;
|
||||
return new Vector3(pos.X, pos.Y, 0);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Last-frame mouse velocity from Godot's <c>Input.GetLastMouseVelocity()</c>.
|
||||
/// Used by drag handlers to compute movement deltas.
|
||||
/// </summary>
|
||||
public static Vector2 TouchDelta
|
||||
{
|
||||
get
|
||||
{
|
||||
return Input.GetLastMouseVelocity();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the current touch position. The <paramref name="index"/> parameter
|
||||
/// is ignored in the single-touch model — always returns <see cref="TouchPosition"/>.
|
||||
/// Exists for multi-touch API compatibility.
|
||||
/// </summary>
|
||||
/// <param name="index">Touch index (ignored in current implementation).</param>
|
||||
public static Vector2 GetTouchPosition(int index)
|
||||
{
|
||||
return TouchPosition;
|
||||
}
|
||||
|
||||
private static Viewport GetViewport()
|
||||
{
|
||||
var tree = Godot.Engine.GetMainLoop() as SceneTree;
|
||||
return tree?.Root?.GetViewport();
|
||||
}
|
||||
}
|
||||
}
|
||||
+119
-119
@@ -1,121 +1,121 @@
|
||||
using Cthangover.Core.Events;
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Cthangover.Core.Utils;
|
||||
using Godot;
|
||||
using Cthangover.Core.Events;
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Cthangover.Core.Utils;
|
||||
using Godot;
|
||||
using Cthangover.Core.UI.Messages;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Messages
|
||||
{
|
||||
/// <summary>
|
||||
/// Static factory for floating UI messages (like "Quest updated" or item
|
||||
/// pickup notifications). Manages a cycling position index of 0-5 so
|
||||
/// consecutive messages stack vertically without overlapping. Each message
|
||||
/// is instantiated from message.tscn and parented to the Background node
|
||||
/// (found via scene tree search). Messages auto-fade and self-destruct
|
||||
/// via UiMessage's OnUpdate.
|
||||
/// </summary>
|
||||
public static class MessagesHelper
|
||||
{
|
||||
private const int maxMessageIndex = 5;
|
||||
private static int lastMessageIndex = 0;
|
||||
|
||||
private static ModScenePrefab prefab;
|
||||
|
||||
private static int GetNextIndex(int index)
|
||||
{
|
||||
if (index++ >= maxMessageIndex)
|
||||
index = 0;
|
||||
return index;
|
||||
}
|
||||
|
||||
private static float GetPositionByLastIndex(int index)
|
||||
{
|
||||
return (index - 1) * 60;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Resets the cycling position index to 0. Call when UI state resets
|
||||
/// to prevent messages from accumulating at high Y positions.
|
||||
/// </summary>
|
||||
public static void ClearLastIndex()
|
||||
{
|
||||
lastMessageIndex = 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message in the default warning colour at the next vertical slot.
|
||||
/// </summary>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="speed">Fade speed multiplier (higher = faster fade, default 1).</param>
|
||||
public static void AddMessage(string text, float speed = 1f)
|
||||
{
|
||||
AddMessage(text, UiTokens.Warning, speed);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message with a custom color at the next vertical slot.
|
||||
/// Messages auto-fade and self-destruct after ~3 seconds of display plus
|
||||
/// a fade duration determined by <paramref name="speed"/>.
|
||||
/// </summary>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
/// <param name="speed">Fade speed multiplier (higher = faster fade, default 1).</param>
|
||||
public static void AddMessage(string text, Color color, float speed = 1f)
|
||||
{
|
||||
var nextIndex = GetNextIndex(lastMessageIndex);
|
||||
AddMessage(GetPositionByLastIndex(nextIndex), text, color, speed);
|
||||
lastMessageIndex = nextIndex;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message in the default warning colour at a specific vertical
|
||||
/// position, bypassing the cycling slot system.
|
||||
/// </summary>
|
||||
/// <param name="position">Y-offset in pixels for this message.</param>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="speed">Fade speed multiplier (default 1).</param>
|
||||
public static void AddMessage(float position, string text, float speed = 1f)
|
||||
{
|
||||
AddMessage(position, text, UiTokens.Warning, speed);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Instantiates a <see cref="UiMessage"/> from <c>message.tscn</c>, parents
|
||||
/// it to the Background node, and configures it for display and auto-fade.
|
||||
/// </summary>
|
||||
/// <param name="position">Y-offset in pixels for this message.</param>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
/// <param name="speed">Fade speed multiplier (default 1).</param>
|
||||
public static void AddMessage(float position, string text, Color color, float speed = 1f)
|
||||
{
|
||||
if (prefab == null)
|
||||
|
||||
namespace Cthangover.Mods.Interface.Messages
|
||||
{
|
||||
/// <summary>
|
||||
/// Static factory for floating UI messages (like "Quest updated" or item
|
||||
/// pickup notifications). Manages a cycling position index of 0-5 so
|
||||
/// consecutive messages stack vertically without overlapping. Each message
|
||||
/// is instantiated from message.tscn and parented to the Background node
|
||||
/// (found via scene tree search). Messages auto-fade and self-destruct
|
||||
/// via UiMessage's OnUpdate.
|
||||
/// </summary>
|
||||
public static class MessagesHelper
|
||||
{
|
||||
private const int maxMessageIndex = 5;
|
||||
private static int lastMessageIndex = 0;
|
||||
|
||||
private static ModScenePrefab prefab;
|
||||
|
||||
private static int GetNextIndex(int index)
|
||||
{
|
||||
if (index++ >= maxMessageIndex)
|
||||
index = 0;
|
||||
return index;
|
||||
}
|
||||
|
||||
private static float GetPositionByLastIndex(int index)
|
||||
{
|
||||
return (index - 1) * 60;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Resets the cycling position index to 0. Call when UI state resets
|
||||
/// to prevent messages from accumulating at high Y positions.
|
||||
/// </summary>
|
||||
public static void ClearLastIndex()
|
||||
{
|
||||
lastMessageIndex = 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message in the default warning colour at the next vertical slot.
|
||||
/// </summary>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="speed">Fade speed multiplier (higher = faster fade, default 1).</param>
|
||||
public static void AddMessage(string text, float speed = 1f)
|
||||
{
|
||||
AddMessage(text, UiTokens.Warning, speed);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message with a custom color at the next vertical slot.
|
||||
/// Messages auto-fade and self-destruct after ~3 seconds of display plus
|
||||
/// a fade duration determined by <paramref name="speed"/>.
|
||||
/// </summary>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
/// <param name="speed">Fade speed multiplier (higher = faster fade, default 1).</param>
|
||||
public static void AddMessage(string text, Color color, float speed = 1f)
|
||||
{
|
||||
var nextIndex = GetNextIndex(lastMessageIndex);
|
||||
AddMessage(GetPositionByLastIndex(nextIndex), text, color, speed);
|
||||
lastMessageIndex = nextIndex;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Shows a message in the default warning colour at a specific vertical
|
||||
/// position, bypassing the cycling slot system.
|
||||
/// </summary>
|
||||
/// <param name="position">Y-offset in pixels for this message.</param>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="speed">Fade speed multiplier (default 1).</param>
|
||||
public static void AddMessage(float position, string text, float speed = 1f)
|
||||
{
|
||||
AddMessage(position, text, UiTokens.Warning, speed);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Instantiates a <see cref="UiMessage"/> from <c>message.tscn</c>, parents
|
||||
/// it to the Background node, and configures it for display and auto-fade.
|
||||
/// </summary>
|
||||
/// <param name="position">Y-offset in pixels for this message.</param>
|
||||
/// <param name="text">The message text to display.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
/// <param name="speed">Fade speed multiplier (default 1).</param>
|
||||
public static void AddMessage(float position, string text, Color color, float speed = 1f)
|
||||
{
|
||||
if (prefab == null)
|
||||
prefab = new ModScenePrefab("scenes/ui/message.tscn");
|
||||
|
||||
var instance = prefab.Instantiate<UiMessage>();
|
||||
var background = SceneContextNode.FindNode<Control>("Background");
|
||||
if (background == null)
|
||||
{
|
||||
background = SceneContextNode.Instance?.GetTree()?.GetFirstNodeInGroup("Background") as Control;
|
||||
if (background == null)
|
||||
{
|
||||
GameLogger.Log("UI", "Background node not found for messages", LogLevel.Error);
|
||||
return;
|
||||
}
|
||||
}
|
||||
background.AddChild(instance);
|
||||
instance.Setup(position, text, speed, color);
|
||||
|
||||
ModEventBus.Publish(new NotificationRequestedEvent
|
||||
{
|
||||
Text = text,
|
||||
Category = "message",
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
var instance = prefab.Instantiate<UiMessage>();
|
||||
var background = SceneContextNode.FindNode<Control>("Background");
|
||||
if (background == null)
|
||||
{
|
||||
background = SceneContextNode.Instance?.GetTree()?.GetFirstNodeInGroup("Background") as Control;
|
||||
if (background == null)
|
||||
{
|
||||
GameLogger.Log("UI", "Background node not found for messages", LogLevel.Error);
|
||||
return;
|
||||
}
|
||||
}
|
||||
background.AddChild(instance);
|
||||
instance.Setup(position, text, speed, color);
|
||||
|
||||
ModEventBus.Publish(new NotificationRequestedEvent
|
||||
{
|
||||
Text = text,
|
||||
Category = "message",
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
+103
-103
@@ -1,104 +1,104 @@
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.UI.Event;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.UI.Event;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
using Cthangover.Core.UI.Messages;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Messages
|
||||
{
|
||||
/// <summary>
|
||||
/// Floating text message with auto-fade. Appears at a vertical position,
|
||||
/// stays visible for 3 seconds, then fades over 2/Speed seconds. Self-
|
||||
/// destructs (QueueFree) when fully transparent. Registers with
|
||||
/// SceneEventController for per-frame updates; unregisters on tree exit
|
||||
/// to prevent leaks. Speed affects only the fade duration, not the display
|
||||
/// duration, so faster speed = shorter fade = message disappears more quickly.
|
||||
/// </summary>
|
||||
public partial class UiMessage : Control, IOnUpdateEvent
|
||||
{
|
||||
|
||||
[Export] private Label textField;
|
||||
/// <summary>Tint of the message text; defaults to the warning colour.</summary>
|
||||
[Export] public Color Color { get; set; } = UiTokens.Warning;
|
||||
/// <summary>Fade speed multiplier — 1 is normal; higher values shorten the fade-out.</summary>
|
||||
[Export] public float Speed { get; set; } = 1f;
|
||||
private float timestamp;
|
||||
|
||||
/// <summary>
|
||||
/// The text content displayed by this message. Reads/writes the child
|
||||
/// <c>textField</c> label directly.
|
||||
/// </summary>
|
||||
public string Text
|
||||
{
|
||||
get => textField.Text;
|
||||
set => textField.Text = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the message: positions it, sets text/speed/color, records
|
||||
/// the start timestamp, and registers with the <see cref="SceneEventController"/>
|
||||
/// for per-frame updates. Called by <see cref="MessagesHelper"/>.
|
||||
/// </summary>
|
||||
/// <param name="pos">Vertical Y-offset in pixels.</param>
|
||||
/// <param name="text">The message text.</param>
|
||||
/// <param name="speed">Fade speed multiplier.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
public void Setup(float pos, string text, float speed, Color color)
|
||||
{
|
||||
OffsetLeft = 50;
|
||||
OffsetRight = -10;
|
||||
Size = new Vector2(Size.X, 50);
|
||||
Position = new Vector2(0, pos + 200);
|
||||
|
||||
Text = text;
|
||||
Speed = speed;
|
||||
Color = color;
|
||||
timestamp = (float)Godot.Time.GetTicksMsec() / 1000f;
|
||||
|
||||
if (SceneContextNode.Instance != null)
|
||||
{
|
||||
var eventController = SceneContextNode.FindNode<SceneEventController>("EventController");
|
||||
eventController?.AddUpdateEventListener(this);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Detaches from the event controller so a freed message stops receiving updates.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (SceneContextNode.Instance != null)
|
||||
{
|
||||
var eventController = SceneContextNode.FindNode<SceneEventController>("EventController");
|
||||
eventController?.RemoveUpdateEventListener(this);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Priority <c>1</c> — lightweight enough for many concurrent messages.
|
||||
/// </summary>
|
||||
public int Priority => 1;
|
||||
|
||||
/// <summary>
|
||||
/// Per-frame update: displays for 3 seconds, then fades out over
|
||||
/// <c>2 / <see cref="Speed"/></c> seconds. Self-destructs via
|
||||
/// <c>QueueFree</c> when fully transparent.
|
||||
/// </summary>
|
||||
public void OnUpdate()
|
||||
{
|
||||
var currentTime = (float)Godot.Time.GetTicksMsec() / 1000f;
|
||||
var elapsed = currentTime - timestamp;
|
||||
|
||||
if (elapsed < 3f)
|
||||
return;
|
||||
|
||||
var fadeDuration = 2f / Speed;
|
||||
var fadeElapsed = elapsed - 3f;
|
||||
var progress = Mathf.Clamp(fadeElapsed / fadeDuration, 0f, 1f);
|
||||
textField.SelfModulate = UiTokens.Alpha(Colors.White, 1f - progress);
|
||||
|
||||
if (progress >= 1f)
|
||||
QueueFree();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
namespace Cthangover.Mods.Interface.Messages
|
||||
{
|
||||
/// <summary>
|
||||
/// Floating text message with auto-fade. Appears at a vertical position,
|
||||
/// stays visible for 3 seconds, then fades over 2/Speed seconds. Self-
|
||||
/// destructs (QueueFree) when fully transparent. Registers with
|
||||
/// SceneEventController for per-frame updates; unregisters on tree exit
|
||||
/// to prevent leaks. Speed affects only the fade duration, not the display
|
||||
/// duration, so faster speed = shorter fade = message disappears more quickly.
|
||||
/// </summary>
|
||||
public partial class UiMessage : Control, IOnUpdateEvent
|
||||
{
|
||||
|
||||
[Export] private Label textField;
|
||||
/// <summary>Tint of the message text; defaults to the warning colour.</summary>
|
||||
[Export] public Color Color { get; set; } = UiTokens.Warning;
|
||||
/// <summary>Fade speed multiplier — 1 is normal; higher values shorten the fade-out.</summary>
|
||||
[Export] public float Speed { get; set; } = 1f;
|
||||
private float timestamp;
|
||||
|
||||
/// <summary>
|
||||
/// The text content displayed by this message. Reads/writes the child
|
||||
/// <c>textField</c> label directly.
|
||||
/// </summary>
|
||||
public string Text
|
||||
{
|
||||
get => textField.Text;
|
||||
set => textField.Text = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the message: positions it, sets text/speed/color, records
|
||||
/// the start timestamp, and registers with the <see cref="SceneEventController"/>
|
||||
/// for per-frame updates. Called by <see cref="MessagesHelper"/>.
|
||||
/// </summary>
|
||||
/// <param name="pos">Vertical Y-offset in pixels.</param>
|
||||
/// <param name="text">The message text.</param>
|
||||
/// <param name="speed">Fade speed multiplier.</param>
|
||||
/// <param name="color">The text color.</param>
|
||||
public void Setup(float pos, string text, float speed, Color color)
|
||||
{
|
||||
OffsetLeft = 50;
|
||||
OffsetRight = -10;
|
||||
Size = new Vector2(Size.X, 50);
|
||||
Position = new Vector2(0, pos + 200);
|
||||
|
||||
Text = text;
|
||||
Speed = speed;
|
||||
Color = color;
|
||||
timestamp = (float)Godot.Time.GetTicksMsec() / 1000f;
|
||||
|
||||
if (SceneContextNode.Instance != null)
|
||||
{
|
||||
var eventController = SceneContextNode.FindNode<SceneEventController>("EventController");
|
||||
eventController?.AddUpdateEventListener(this);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Detaches from the event controller so a freed message stops receiving updates.</summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
if (SceneContextNode.Instance != null)
|
||||
{
|
||||
var eventController = SceneContextNode.FindNode<SceneEventController>("EventController");
|
||||
eventController?.RemoveUpdateEventListener(this);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Priority <c>1</c> — lightweight enough for many concurrent messages.
|
||||
/// </summary>
|
||||
public int Priority => 1;
|
||||
|
||||
/// <summary>
|
||||
/// Per-frame update: displays for 3 seconds, then fades out over
|
||||
/// <c>2 / <see cref="Speed"/></c> seconds. Self-destructs via
|
||||
/// <c>QueueFree</c> when fully transparent.
|
||||
/// </summary>
|
||||
public void OnUpdate()
|
||||
{
|
||||
var currentTime = (float)Godot.Time.GetTicksMsec() / 1000f;
|
||||
var elapsed = currentTime - timestamp;
|
||||
|
||||
if (elapsed < 3f)
|
||||
return;
|
||||
|
||||
var fadeDuration = 2f / Speed;
|
||||
var fadeElapsed = elapsed - 3f;
|
||||
var progress = Mathf.Clamp(fadeElapsed / fadeDuration, 0f, 1f);
|
||||
textField.SelfModulate = UiTokens.Alpha(Colors.White, 1f - progress);
|
||||
|
||||
if (progress >= 1f)
|
||||
QueueFree();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,30 +1,30 @@
|
||||
using Cthangover.Core.Factories.Impls;
|
||||
using Godot;
|
||||
using Cthangover.Core.Factories.Impls;
|
||||
using Godot;
|
||||
using Cthangover.Core.UI.Tool;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Tool
|
||||
{
|
||||
/// <summary>
|
||||
/// Mod-aware TextureButton: resolves IconId through UIIconFactory at _Ready
|
||||
/// and applies the result to TextureNormal. Allows tool buttons to reference
|
||||
/// icons by logical ID that mods can override.
|
||||
/// </summary>
|
||||
public partial class ButtonModIconLoader : TextureButton
|
||||
{
|
||||
/// <summary>
|
||||
/// Logical icon ID resolved through <see cref="UIIconFactory"/>. Set in the editor
|
||||
/// or via mod to reference a mod-overridable icon texture.
|
||||
/// </summary>
|
||||
[Export] public string IconId { get; set; }
|
||||
|
||||
public override void _Ready()
|
||||
{
|
||||
if (string.IsNullOrEmpty(IconId))
|
||||
return;
|
||||
|
||||
var texture = UIIconFactory.Instance.Get(IconId);
|
||||
if (texture != null)
|
||||
TextureNormal = texture;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
namespace Cthangover.Mods.Interface.Tool
|
||||
{
|
||||
/// <summary>
|
||||
/// Mod-aware TextureButton: resolves IconId through UIIconFactory at _Ready
|
||||
/// and applies the result to TextureNormal. Allows tool buttons to reference
|
||||
/// icons by logical ID that mods can override.
|
||||
/// </summary>
|
||||
public partial class ButtonModIconLoader : TextureButton
|
||||
{
|
||||
/// <summary>
|
||||
/// Logical icon ID resolved through <see cref="UIIconFactory"/>. Set in the editor
|
||||
/// or via mod to reference a mod-overridable icon texture.
|
||||
/// </summary>
|
||||
[Export] public string IconId { get; set; }
|
||||
|
||||
public override void _Ready()
|
||||
{
|
||||
if (string.IsNullOrEmpty(IconId))
|
||||
return;
|
||||
|
||||
var texture = UIIconFactory.Instance.Get(IconId);
|
||||
if (texture != null)
|
||||
TextureNormal = texture;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,30 +1,30 @@
|
||||
using Cthangover.Core.Factories.Impls;
|
||||
using Godot;
|
||||
using Cthangover.Core.Factories.Impls;
|
||||
using Godot;
|
||||
using Cthangover.Core.UI.Tool;
|
||||
|
||||
namespace Cthangover.Mods.Interface.Tool
|
||||
{
|
||||
/// <summary>
|
||||
/// Mod-aware TextureRect: resolves IconId through UIIconFactory at _Ready
|
||||
/// and applies the result. Used as a base class for any TextureRect that
|
||||
/// needs mod-overridable textures without scene modification.
|
||||
/// </summary>
|
||||
public partial class TextureRectModIconLoader : TextureRect
|
||||
{
|
||||
/// <summary>
|
||||
/// Logical icon ID resolved through <see cref="UIIconFactory"/>. Set in the editor
|
||||
/// or via mod to reference a mod-overridable icon texture.
|
||||
/// </summary>
|
||||
[Export] public string IconId { get; set; }
|
||||
|
||||
public override void _Ready()
|
||||
{
|
||||
if (string.IsNullOrEmpty(IconId))
|
||||
return;
|
||||
|
||||
var texture = UIIconFactory.Instance.Get(IconId);
|
||||
if (texture != null)
|
||||
Texture = texture;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
namespace Cthangover.Mods.Interface.Tool
|
||||
{
|
||||
/// <summary>
|
||||
/// Mod-aware TextureRect: resolves IconId through UIIconFactory at _Ready
|
||||
/// and applies the result. Used as a base class for any TextureRect that
|
||||
/// needs mod-overridable textures without scene modification.
|
||||
/// </summary>
|
||||
public partial class TextureRectModIconLoader : TextureRect
|
||||
{
|
||||
/// <summary>
|
||||
/// Logical icon ID resolved through <see cref="UIIconFactory"/>. Set in the editor
|
||||
/// or via mod to reference a mod-overridable icon texture.
|
||||
/// </summary>
|
||||
[Export] public string IconId { get; set; }
|
||||
|
||||
public override void _Ready()
|
||||
{
|
||||
if (string.IsNullOrEmpty(IconId))
|
||||
return;
|
||||
|
||||
var texture = UIIconFactory.Instance.Get(IconId);
|
||||
if (texture != null)
|
||||
Texture = texture;
|
||||
}
|
||||
}
|
||||
}
|
||||
+32
-32
@@ -1,32 +1,32 @@
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// 9-point alignment grid for viewport content positioning. The naming
|
||||
/// uses horizontal-first, vertical-second convention (LeftTop, CenterCenter,
|
||||
/// RightBottom) — matching the intuitive order for CSS-like layout.
|
||||
/// </summary>
|
||||
public enum AlignType
|
||||
{
|
||||
/// <summary>Content aligned to top-left corner of the viewport.</summary>
|
||||
LeftTop,
|
||||
/// <summary>Content horizontally left, vertically centered in the viewport.</summary>
|
||||
LeftCenter,
|
||||
/// <summary>Content horizontally left, vertically at the bottom of the viewport.</summary>
|
||||
LeftBottom,
|
||||
|
||||
/// <summary>Content horizontally centered, vertically at the top of the viewport.</summary>
|
||||
CenterTop,
|
||||
/// <summary>Content centered both horizontally and vertically in the viewport.</summary>
|
||||
CenterCenter,
|
||||
/// <summary>Content horizontally centered, vertically at the bottom of the viewport.</summary>
|
||||
CenterBottom,
|
||||
|
||||
/// <summary>Content horizontally right, vertically at the top of the viewport.</summary>
|
||||
RightTop,
|
||||
/// <summary>Content horizontally right, vertically centered in the viewport.</summary>
|
||||
RightCenter,
|
||||
/// <summary>Content aligned to the bottom-right corner of the viewport.</summary>
|
||||
RightBottom,
|
||||
}
|
||||
|
||||
}
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// 9-point alignment grid for viewport content positioning. The naming
|
||||
/// uses horizontal-first, vertical-second convention (LeftTop, CenterCenter,
|
||||
/// RightBottom) — matching the intuitive order for CSS-like layout.
|
||||
/// </summary>
|
||||
public enum AlignType
|
||||
{
|
||||
/// <summary>Content aligned to top-left corner of the viewport.</summary>
|
||||
LeftTop,
|
||||
/// <summary>Content horizontally left, vertically centered in the viewport.</summary>
|
||||
LeftCenter,
|
||||
/// <summary>Content horizontally left, vertically at the bottom of the viewport.</summary>
|
||||
LeftBottom,
|
||||
|
||||
/// <summary>Content horizontally centered, vertically at the top of the viewport.</summary>
|
||||
CenterTop,
|
||||
/// <summary>Content centered both horizontally and vertically in the viewport.</summary>
|
||||
CenterCenter,
|
||||
/// <summary>Content horizontally centered, vertically at the bottom of the viewport.</summary>
|
||||
CenterBottom,
|
||||
|
||||
/// <summary>Content horizontally right, vertically at the top of the viewport.</summary>
|
||||
RightTop,
|
||||
/// <summary>Content horizontally right, vertically centered in the viewport.</summary>
|
||||
RightCenter,
|
||||
/// <summary>Content aligned to the bottom-right corner of the viewport.</summary>
|
||||
RightBottom,
|
||||
}
|
||||
|
||||
}
|
||||
+284
-284
@@ -1,284 +1,284 @@
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.Mods.Resolvers;
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.Utils;
|
||||
using Cthangover.Core.UI;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Core viewport container: manages background/foreground TextureRects with
|
||||
/// a shared shader material (timed_sprite from mods) for time-of-day lighting.
|
||||
/// Supports smooth background transitions via a black ColorRect overlay that
|
||||
/// fades in, swaps the texture mid-transition, then fades out — a classic
|
||||
/// crossfade approach that doesn't require a second TextureRect. The zoom
|
||||
/// system scales the content Control between minZoom and maxZoom based on
|
||||
/// a 0–1 input value. Alignment positions content within the viewport using
|
||||
/// ViewBoxNavigator's 9-point grid. The #if TOOLS block forces content size
|
||||
/// to defaultResolution for editor preview.
|
||||
///
|
||||
/// Interactive layers are Control containers placed between Background and
|
||||
/// Foreground (and above Foreground for UI) that host interactive scene objects.
|
||||
/// </summary>
|
||||
public partial class ViewBox : Control, IBackgroundView
|
||||
{
|
||||
[Export] private Vector2I defaultResolution = new(1920, 1024);
|
||||
[Export] private Control content;
|
||||
[Export] private float minZoom;
|
||||
[Export] private float maxZoom;
|
||||
|
||||
/// <summary>
|
||||
/// The content node that holds all scene visuals. Scaling and alignment are applied
|
||||
/// directly to this node.
|
||||
/// </summary>
|
||||
public Control Content => content;
|
||||
|
||||
/// <summary>Logical resolution of the content area (default 1920x1024). Used for normalised coordinate calculations.</summary>
|
||||
public Vector2I LogicalSize => defaultResolution;
|
||||
|
||||
/// <summary>
|
||||
/// The background <see cref="TextureRect"/> rendered behind all interactive layers.
|
||||
/// Receives a <c>timed_sprite</c> shader material for time-of-day lighting when
|
||||
/// no material is already assigned.
|
||||
/// </summary>
|
||||
public TextureRect Background { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// The foreground <see cref="TextureRect"/> rendered above interactive layers.
|
||||
/// Receives the same <c>timed_sprite</c> shader as the background.
|
||||
/// </summary>
|
||||
public TextureRect Foreground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered behind the foreground.</summary>
|
||||
public Control InteractiveLayerBackground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered above the foreground.</summary>
|
||||
public Control InteractiveLayerForeground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered above all scene visuals (UI layer).</summary>
|
||||
public Control InteractiveLayerUI { get; private set; }
|
||||
|
||||
private ColorRect transitionOverlay;
|
||||
private Tween transitionTween;
|
||||
|
||||
/// <summary>Resolves the background and foreground nodes and assigns the time-of-day shader when no material is set.</summary>
|
||||
public override void _Ready()
|
||||
{
|
||||
Background ??= GetNodeOrNull<TextureRect>("Background");
|
||||
Foreground ??= GetNodeOrNull<TextureRect>("Foreground");
|
||||
|
||||
var timedShader = Shaders.Resolve("timed_sprite");
|
||||
|
||||
if (timedShader != null)
|
||||
{
|
||||
if (Background != null && Background.Material == null)
|
||||
{
|
||||
Background.Material = new ShaderMaterial { Shader = timedShader };
|
||||
GameLogger.Log("LIGHT", "ViewBox._Ready: created ShaderMaterial for Background", LogLevel.Debug);
|
||||
}
|
||||
if (Foreground != null && Foreground.Material == null)
|
||||
{
|
||||
Foreground.Material = new ShaderMaterial { Shader = timedShader };
|
||||
GameLogger.Log("LIGHT", "ViewBox._Ready: created ShaderMaterial for Foreground", LogLevel.Debug);
|
||||
}
|
||||
}
|
||||
|
||||
SetZoom(0f);
|
||||
SetAlign(AlignType.CenterCenter);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the interactive layer container for the given logical layer name.
|
||||
/// Creates the layer lazily as a direct child of ViewBox if it doesn't exist yet.
|
||||
/// </summary>
|
||||
/// <param name="layerName">"background", "foreground" or "ui".</param>
|
||||
/// <returns>The matching Control container.</returns>
|
||||
public Control GetInteractiveLayer(string layerName)
|
||||
{
|
||||
var result = layerName?.ToLowerInvariant() switch
|
||||
{
|
||||
"background" => InteractiveLayerBackground ??= CreateLayerDirect("InteractiveLayer_Background", 1),
|
||||
"foreground" => InteractiveLayerForeground ??= CreateLayerDirect("InteractiveLayer_Foreground", 3),
|
||||
"ui" => InteractiveLayerUI ??= CreateLayerDirect("InteractiveLayer_UI", 5),
|
||||
_ => InteractiveLayerForeground ??= CreateLayerDirect("InteractiveLayer_Foreground", 3)
|
||||
};
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
private Control CreateLayerDirect(string name, int zIndex)
|
||||
{
|
||||
var layer = new Control
|
||||
{
|
||||
Name = name,
|
||||
MouseFilter = MouseFilterEnum.Ignore,
|
||||
ZIndex = zIndex,
|
||||
Size = new Vector2(defaultResolution.X, defaultResolution.Y)
|
||||
};
|
||||
AddChild(layer);
|
||||
return layer;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Assigns a texture to the background <see cref="TextureRect"/>. This is the
|
||||
/// primary mechanism for scenes to set the backdrop visual. Logs the new background
|
||||
/// ID from <see cref="SceneContextNode.LastBackgroundID"/> for debugging.
|
||||
/// </summary>
|
||||
public void SetBackgroundTexture(Texture2D texture)
|
||||
{
|
||||
if (Background != null)
|
||||
{
|
||||
Background.Texture = texture;
|
||||
GameLogger.Log("VIEW", $"set background '" + SceneContextNode.LastBackgroundID + "'");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Assigns a texture to the foreground <see cref="TextureRect"/>. Typically used
|
||||
/// for scene overlays rendered above interactive objects but below UI.
|
||||
/// </summary>
|
||||
public void SetForegroundTexture(Texture2D texture)
|
||||
{
|
||||
if (Foreground != null)
|
||||
{
|
||||
Foreground.Texture = texture;
|
||||
GameLogger.Log("VIEW", $"set foreground");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the currently assigned background texture, or <c>null</c> if none is set
|
||||
/// or the <see cref="Background"/> node is missing.
|
||||
/// </summary>
|
||||
public Texture2D GetBackgroundTexture()
|
||||
{
|
||||
return Background?.Texture;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Smoothly transitions the background to a new texture using a black overlay crossfade:
|
||||
/// fades a <see cref="ColorRect"/> to full opacity over the first half of <paramref name="duration"/>,
|
||||
/// swaps the background texture mid-transition, then fades back out over the second half.
|
||||
/// If the target texture is already set or the background node is missing, no-op.
|
||||
/// <see cref="KillTransitionTween"/> cancels any in-progress transition first.
|
||||
/// </summary>
|
||||
/// <param name="newTexture">The replacement background texture.</param>
|
||||
/// <param name="duration">Total crossfade duration in seconds (default 0.5).</param>
|
||||
public void TransitionBackground(Texture2D newTexture)
|
||||
{
|
||||
TransitionBackground(newTexture, 0.5f);
|
||||
}
|
||||
|
||||
public void TransitionBackground(Texture2D newTexture, float duration = 0.5f)
|
||||
{
|
||||
if (Background == null)
|
||||
{
|
||||
if (newTexture != null)
|
||||
SetBackgroundTexture(newTexture);
|
||||
return;
|
||||
}
|
||||
|
||||
if (Background.Texture == newTexture)
|
||||
return;
|
||||
|
||||
KillTransitionTween();
|
||||
|
||||
var overlay = GetOrCreateTransitionOverlay();
|
||||
overlay.Visible = true;
|
||||
overlay.Modulate = UiTokens.Alpha(Colors.Black, 0f);
|
||||
overlay.MouseFilter = MouseFilterEnum.Ignore;
|
||||
|
||||
var halfDuration = duration / 2f;
|
||||
|
||||
transitionTween = CreateTween();
|
||||
transitionTween.TweenProperty(overlay, "modulate:a", 1f, halfDuration);
|
||||
transitionTween.TweenCallback(Callable.From(() =>
|
||||
{
|
||||
SetBackgroundTexture(newTexture);
|
||||
}));
|
||||
transitionTween.TweenProperty(overlay, "modulate:a", 0f, halfDuration);
|
||||
transitionTween.TweenCallback(Callable.From(() =>
|
||||
{
|
||||
overlay.Visible = false;
|
||||
transitionTween = null;
|
||||
}));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Aborts any in-progress background transition by killing the tween and resetting
|
||||
/// the overlay to invisible. Safe to call when no transition is active.
|
||||
/// </summary>
|
||||
public void KillTransitionTween()
|
||||
{
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
if (transitionOverlay != null)
|
||||
{
|
||||
transitionOverlay.Visible = false;
|
||||
transitionOverlay.Modulate = UiTokens.Alpha(Colors.Black, 0f);
|
||||
}
|
||||
}
|
||||
|
||||
private ColorRect GetOrCreateTransitionOverlay()
|
||||
{
|
||||
if (transitionOverlay == null)
|
||||
{
|
||||
transitionOverlay = new ColorRect
|
||||
{
|
||||
Name = "TransitionOverlay",
|
||||
Color = UiTokens.Alpha(Colors.Black, 1f),
|
||||
MouseFilter = MouseFilterEnum.Ignore,
|
||||
Visible = false
|
||||
};
|
||||
transitionOverlay.AnchorRight = 1f;
|
||||
transitionOverlay.AnchorBottom = 1f;
|
||||
transitionOverlay.GrowHorizontal = GrowDirection.Both;
|
||||
transitionOverlay.GrowVertical = GrowDirection.Both;
|
||||
AddChild(transitionOverlay);
|
||||
}
|
||||
return transitionOverlay;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Applies a zoom level to the content node. The <paramref name="value"/> is a 0–1 lerp
|
||||
/// factor between <c>minZoom</c> and <c>maxZoom</c>. Scale is uniform (X and Y are equal).
|
||||
/// </summary>
|
||||
/// <param name="value">Normalized zoom factor: 0 = minZoom, 1 = maxZoom.</param>
|
||||
public void SetZoom(float value)
|
||||
{
|
||||
var zoom = minZoom + (maxZoom - minZoom) * value;
|
||||
if (content != null)
|
||||
content.Scale = Vector2.One * zoom;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Positions the content node within the viewport using the 9-point alignment grid
|
||||
/// from <see cref="ViewBoxNavigator.GetPositionByAlign"/>.
|
||||
/// </summary>
|
||||
/// <param name="align">Which corner/edge/center to align to.</param>
|
||||
public void SetAlign(AlignType align)
|
||||
{
|
||||
if (content != null)
|
||||
content.Position = ViewBoxNavigator.GetPositionByAlign(align, content.Size);
|
||||
}
|
||||
|
||||
#if TOOLS && DEBUG
|
||||
/// <summary>Editor-only: forces the content back to the default resolution rect while inspecting properties.</summary>
|
||||
public override void _ValidateProperty(Godot.Collections.Dictionary property)
|
||||
{
|
||||
base._ValidateProperty(property);
|
||||
if (content != null)
|
||||
content.Size = defaultResolution;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.Mods.Resolvers;
|
||||
using Cthangover.Core.Scenes;
|
||||
using Cthangover.Core.Utils;
|
||||
using Cthangover.Core.UI;
|
||||
using Cthangover.Core.UI.Theming;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Core viewport container: manages background/foreground TextureRects with
|
||||
/// a shared shader material (timed_sprite from mods) for time-of-day lighting.
|
||||
/// Supports smooth background transitions via a black ColorRect overlay that
|
||||
/// fades in, swaps the texture mid-transition, then fades out — a classic
|
||||
/// crossfade approach that doesn't require a second TextureRect. The zoom
|
||||
/// system scales the content Control between minZoom and maxZoom based on
|
||||
/// a 0–1 input value. Alignment positions content within the viewport using
|
||||
/// ViewBoxNavigator's 9-point grid. The #if TOOLS block forces content size
|
||||
/// to defaultResolution for editor preview.
|
||||
///
|
||||
/// Interactive layers are Control containers placed between Background and
|
||||
/// Foreground (and above Foreground for UI) that host interactive scene objects.
|
||||
/// </summary>
|
||||
public partial class ViewBox : Control, IBackgroundView
|
||||
{
|
||||
[Export] private Vector2I defaultResolution = new(1920, 1024);
|
||||
[Export] private Control content;
|
||||
[Export] private float minZoom;
|
||||
[Export] private float maxZoom;
|
||||
|
||||
/// <summary>
|
||||
/// The content node that holds all scene visuals. Scaling and alignment are applied
|
||||
/// directly to this node.
|
||||
/// </summary>
|
||||
public Control Content => content;
|
||||
|
||||
/// <summary>Logical resolution of the content area (default 1920x1024). Used for normalised coordinate calculations.</summary>
|
||||
public Vector2I LogicalSize => defaultResolution;
|
||||
|
||||
/// <summary>
|
||||
/// The background <see cref="TextureRect"/> rendered behind all interactive layers.
|
||||
/// Receives a <c>timed_sprite</c> shader material for time-of-day lighting when
|
||||
/// no material is already assigned.
|
||||
/// </summary>
|
||||
public TextureRect Background { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// The foreground <see cref="TextureRect"/> rendered above interactive layers.
|
||||
/// Receives the same <c>timed_sprite</c> shader as the background.
|
||||
/// </summary>
|
||||
public TextureRect Foreground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered behind the foreground.</summary>
|
||||
public Control InteractiveLayerBackground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered above the foreground.</summary>
|
||||
public Control InteractiveLayerForeground { get; private set; }
|
||||
|
||||
/// <summary>Container for interactive objects rendered above all scene visuals (UI layer).</summary>
|
||||
public Control InteractiveLayerUI { get; private set; }
|
||||
|
||||
private ColorRect transitionOverlay;
|
||||
private Tween transitionTween;
|
||||
|
||||
/// <summary>Resolves the background and foreground nodes and assigns the time-of-day shader when no material is set.</summary>
|
||||
public override void _Ready()
|
||||
{
|
||||
Background ??= GetNodeOrNull<TextureRect>("Background");
|
||||
Foreground ??= GetNodeOrNull<TextureRect>("Foreground");
|
||||
|
||||
var timedShader = Shaders.Resolve("timed_sprite");
|
||||
|
||||
if (timedShader != null)
|
||||
{
|
||||
if (Background != null && Background.Material == null)
|
||||
{
|
||||
Background.Material = new ShaderMaterial { Shader = timedShader };
|
||||
GameLogger.Log("LIGHT", "ViewBox._Ready: created ShaderMaterial for Background", LogLevel.Debug);
|
||||
}
|
||||
if (Foreground != null && Foreground.Material == null)
|
||||
{
|
||||
Foreground.Material = new ShaderMaterial { Shader = timedShader };
|
||||
GameLogger.Log("LIGHT", "ViewBox._Ready: created ShaderMaterial for Foreground", LogLevel.Debug);
|
||||
}
|
||||
}
|
||||
|
||||
SetZoom(0f);
|
||||
SetAlign(AlignType.CenterCenter);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the interactive layer container for the given logical layer name.
|
||||
/// Creates the layer lazily as a direct child of ViewBox if it doesn't exist yet.
|
||||
/// </summary>
|
||||
/// <param name="layerName">"background", "foreground" or "ui".</param>
|
||||
/// <returns>The matching Control container.</returns>
|
||||
public Control GetInteractiveLayer(string layerName)
|
||||
{
|
||||
var result = layerName?.ToLowerInvariant() switch
|
||||
{
|
||||
"background" => InteractiveLayerBackground ??= CreateLayerDirect("InteractiveLayer_Background", 1),
|
||||
"foreground" => InteractiveLayerForeground ??= CreateLayerDirect("InteractiveLayer_Foreground", 3),
|
||||
"ui" => InteractiveLayerUI ??= CreateLayerDirect("InteractiveLayer_UI", 5),
|
||||
_ => InteractiveLayerForeground ??= CreateLayerDirect("InteractiveLayer_Foreground", 3)
|
||||
};
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
private Control CreateLayerDirect(string name, int zIndex)
|
||||
{
|
||||
var layer = new Control
|
||||
{
|
||||
Name = name,
|
||||
MouseFilter = MouseFilterEnum.Ignore,
|
||||
ZIndex = zIndex,
|
||||
Size = new Vector2(defaultResolution.X, defaultResolution.Y)
|
||||
};
|
||||
AddChild(layer);
|
||||
return layer;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Assigns a texture to the background <see cref="TextureRect"/>. This is the
|
||||
/// primary mechanism for scenes to set the backdrop visual. Logs the new background
|
||||
/// ID from <see cref="SceneContextNode.LastBackgroundID"/> for debugging.
|
||||
/// </summary>
|
||||
public void SetBackgroundTexture(Texture2D texture)
|
||||
{
|
||||
if (Background != null)
|
||||
{
|
||||
Background.Texture = texture;
|
||||
GameLogger.Log("VIEW", $"set background '" + SceneContextNode.LastBackgroundID + "'");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Assigns a texture to the foreground <see cref="TextureRect"/>. Typically used
|
||||
/// for scene overlays rendered above interactive objects but below UI.
|
||||
/// </summary>
|
||||
public void SetForegroundTexture(Texture2D texture)
|
||||
{
|
||||
if (Foreground != null)
|
||||
{
|
||||
Foreground.Texture = texture;
|
||||
GameLogger.Log("VIEW", $"set foreground");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the currently assigned background texture, or <c>null</c> if none is set
|
||||
/// or the <see cref="Background"/> node is missing.
|
||||
/// </summary>
|
||||
public Texture2D GetBackgroundTexture()
|
||||
{
|
||||
return Background?.Texture;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Smoothly transitions the background to a new texture using a black overlay crossfade:
|
||||
/// fades a <see cref="ColorRect"/> to full opacity over the first half of <paramref name="duration"/>,
|
||||
/// swaps the background texture mid-transition, then fades back out over the second half.
|
||||
/// If the target texture is already set or the background node is missing, no-op.
|
||||
/// <see cref="KillTransitionTween"/> cancels any in-progress transition first.
|
||||
/// </summary>
|
||||
/// <param name="newTexture">The replacement background texture.</param>
|
||||
/// <param name="duration">Total crossfade duration in seconds (default 0.5).</param>
|
||||
public void TransitionBackground(Texture2D newTexture)
|
||||
{
|
||||
TransitionBackground(newTexture, 0.5f);
|
||||
}
|
||||
|
||||
public void TransitionBackground(Texture2D newTexture, float duration = 0.5f)
|
||||
{
|
||||
if (Background == null)
|
||||
{
|
||||
if (newTexture != null)
|
||||
SetBackgroundTexture(newTexture);
|
||||
return;
|
||||
}
|
||||
|
||||
if (Background.Texture == newTexture)
|
||||
return;
|
||||
|
||||
KillTransitionTween();
|
||||
|
||||
var overlay = GetOrCreateTransitionOverlay();
|
||||
overlay.Visible = true;
|
||||
overlay.Modulate = UiTokens.Alpha(Colors.Black, 0f);
|
||||
overlay.MouseFilter = MouseFilterEnum.Ignore;
|
||||
|
||||
var halfDuration = duration / 2f;
|
||||
|
||||
transitionTween = CreateTween();
|
||||
transitionTween.TweenProperty(overlay, "modulate:a", 1f, halfDuration);
|
||||
transitionTween.TweenCallback(Callable.From(() =>
|
||||
{
|
||||
SetBackgroundTexture(newTexture);
|
||||
}));
|
||||
transitionTween.TweenProperty(overlay, "modulate:a", 0f, halfDuration);
|
||||
transitionTween.TweenCallback(Callable.From(() =>
|
||||
{
|
||||
overlay.Visible = false;
|
||||
transitionTween = null;
|
||||
}));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Aborts any in-progress background transition by killing the tween and resetting
|
||||
/// the overlay to invisible. Safe to call when no transition is active.
|
||||
/// </summary>
|
||||
public void KillTransitionTween()
|
||||
{
|
||||
if (transitionTween != null)
|
||||
{
|
||||
transitionTween.Kill();
|
||||
transitionTween = null;
|
||||
}
|
||||
|
||||
if (transitionOverlay != null)
|
||||
{
|
||||
transitionOverlay.Visible = false;
|
||||
transitionOverlay.Modulate = UiTokens.Alpha(Colors.Black, 0f);
|
||||
}
|
||||
}
|
||||
|
||||
private ColorRect GetOrCreateTransitionOverlay()
|
||||
{
|
||||
if (transitionOverlay == null)
|
||||
{
|
||||
transitionOverlay = new ColorRect
|
||||
{
|
||||
Name = "TransitionOverlay",
|
||||
Color = UiTokens.Alpha(Colors.Black, 1f),
|
||||
MouseFilter = MouseFilterEnum.Ignore,
|
||||
Visible = false
|
||||
};
|
||||
transitionOverlay.AnchorRight = 1f;
|
||||
transitionOverlay.AnchorBottom = 1f;
|
||||
transitionOverlay.GrowHorizontal = GrowDirection.Both;
|
||||
transitionOverlay.GrowVertical = GrowDirection.Both;
|
||||
AddChild(transitionOverlay);
|
||||
}
|
||||
return transitionOverlay;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Applies a zoom level to the content node. The <paramref name="value"/> is a 0–1 lerp
|
||||
/// factor between <c>minZoom</c> and <c>maxZoom</c>. Scale is uniform (X and Y are equal).
|
||||
/// </summary>
|
||||
/// <param name="value">Normalized zoom factor: 0 = minZoom, 1 = maxZoom.</param>
|
||||
public void SetZoom(float value)
|
||||
{
|
||||
var zoom = minZoom + (maxZoom - minZoom) * value;
|
||||
if (content != null)
|
||||
content.Scale = Vector2.One * zoom;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Positions the content node within the viewport using the 9-point alignment grid
|
||||
/// from <see cref="ViewBoxNavigator.GetPositionByAlign"/>.
|
||||
/// </summary>
|
||||
/// <param name="align">Which corner/edge/center to align to.</param>
|
||||
public void SetAlign(AlignType align)
|
||||
{
|
||||
if (content != null)
|
||||
content.Position = ViewBoxNavigator.GetPositionByAlign(align, content.Size);
|
||||
}
|
||||
|
||||
#if TOOLS && DEBUG
|
||||
/// <summary>Editor-only: forces the content back to the default resolution rect while inspecting properties.</summary>
|
||||
public override void _ValidateProperty(Godot.Collections.Dictionary property)
|
||||
{
|
||||
base._ValidateProperty(property);
|
||||
if (content != null)
|
||||
content.Size = defaultResolution;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -1,73 +1,73 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Static utility that calculates content positioning offsets for the 9-point
|
||||
/// AlignType grid. Uses the viewport's visible rect as the camera/view area
|
||||
/// and computes offsets so the content aligns correctly within it. The
|
||||
/// CenterCenter case negates X because the content position is treated as
|
||||
/// a negative offset from top-left in Godot's coordinate space.
|
||||
/// </summary>
|
||||
public static class ViewBoxNavigator
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Calculates the content node position offset for the given 9-point <see cref="AlignType"/>.
|
||||
/// Uses the visible viewport rect size as the camera area and computes offsets relative
|
||||
/// to the top-left corner. Negative X coordinates are intentional: Godot positions content
|
||||
/// relative to the container origin, so aligning center or right requires negative offsets
|
||||
/// when content is larger than the viewport.
|
||||
/// </summary>
|
||||
/// <param name="align">The target alignment from the 9-point grid.</param>
|
||||
/// <param name="contentSize">The size of the content node being positioned.</param>
|
||||
/// <returns>A position offset that places the content correctly for the chosen alignment.</returns>
|
||||
public static Vector2 GetPositionByAlign(AlignType align, Vector2 contentSize)
|
||||
{
|
||||
var viewport = Godot.Engine.GetMainLoop() as SceneTree;
|
||||
var screenSize = viewport?.Root?.GetVisibleRect().Size ?? new Vector2(1920, 1024);
|
||||
var cameraSize = screenSize;
|
||||
var alignPos = Vector2.Zero;
|
||||
|
||||
switch (align)
|
||||
{
|
||||
case AlignType.LeftTop:
|
||||
break;
|
||||
case AlignType.LeftCenter:
|
||||
alignPos.Y = (contentSize.Y - cameraSize.Y) * 0.5f;
|
||||
break;
|
||||
case AlignType.LeftBottom:
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
|
||||
case AlignType.CenterTop:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X) * 0.5f;
|
||||
break;
|
||||
case AlignType.CenterCenter:
|
||||
alignPos = (contentSize - cameraSize) * 0.5f;
|
||||
alignPos.X = -alignPos.X;
|
||||
break;
|
||||
case AlignType.CenterBottom:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X) * 0.5f;
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
|
||||
case AlignType.RightTop:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
break;
|
||||
case AlignType.RightCenter:
|
||||
alignPos.Y = (contentSize.Y - cameraSize.Y) * 0.5f;
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
break;
|
||||
case AlignType.RightBottom:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
}
|
||||
|
||||
return alignPos;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Static utility that calculates content positioning offsets for the 9-point
|
||||
/// AlignType grid. Uses the viewport's visible rect as the camera/view area
|
||||
/// and computes offsets so the content aligns correctly within it. The
|
||||
/// CenterCenter case negates X because the content position is treated as
|
||||
/// a negative offset from top-left in Godot's coordinate space.
|
||||
/// </summary>
|
||||
public static class ViewBoxNavigator
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Calculates the content node position offset for the given 9-point <see cref="AlignType"/>.
|
||||
/// Uses the visible viewport rect size as the camera area and computes offsets relative
|
||||
/// to the top-left corner. Negative X coordinates are intentional: Godot positions content
|
||||
/// relative to the container origin, so aligning center or right requires negative offsets
|
||||
/// when content is larger than the viewport.
|
||||
/// </summary>
|
||||
/// <param name="align">The target alignment from the 9-point grid.</param>
|
||||
/// <param name="contentSize">The size of the content node being positioned.</param>
|
||||
/// <returns>A position offset that places the content correctly for the chosen alignment.</returns>
|
||||
public static Vector2 GetPositionByAlign(AlignType align, Vector2 contentSize)
|
||||
{
|
||||
var viewport = Godot.Engine.GetMainLoop() as SceneTree;
|
||||
var screenSize = viewport?.Root?.GetVisibleRect().Size ?? new Vector2(1920, 1024);
|
||||
var cameraSize = screenSize;
|
||||
var alignPos = Vector2.Zero;
|
||||
|
||||
switch (align)
|
||||
{
|
||||
case AlignType.LeftTop:
|
||||
break;
|
||||
case AlignType.LeftCenter:
|
||||
alignPos.Y = (contentSize.Y - cameraSize.Y) * 0.5f;
|
||||
break;
|
||||
case AlignType.LeftBottom:
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
|
||||
case AlignType.CenterTop:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X) * 0.5f;
|
||||
break;
|
||||
case AlignType.CenterCenter:
|
||||
alignPos = (contentSize - cameraSize) * 0.5f;
|
||||
alignPos.X = -alignPos.X;
|
||||
break;
|
||||
case AlignType.CenterBottom:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X) * 0.5f;
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
|
||||
case AlignType.RightTop:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
break;
|
||||
case AlignType.RightCenter:
|
||||
alignPos.Y = (contentSize.Y - cameraSize.Y) * 0.5f;
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
break;
|
||||
case AlignType.RightBottom:
|
||||
alignPos.X = -(contentSize.X - cameraSize.X);
|
||||
alignPos.Y = contentSize.Y - cameraSize.Y;
|
||||
break;
|
||||
}
|
||||
|
||||
return alignPos;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,31 +1,31 @@
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Thin adapter that exposes ViewBox.SetZoom to external callers (e.g. UI
|
||||
/// sliders or scroll handlers) through a single method. Exists as a Node
|
||||
/// so it can be placed in the scene tree and receive signals.
|
||||
/// </summary>
|
||||
public partial class ZoomViewBoxController : Node
|
||||
{
|
||||
|
||||
[Export] private ViewBox viewBox;
|
||||
|
||||
/// <summary>
|
||||
/// Delegates to <see cref="ViewBox.SetZoom"/> on the linked <see cref="ViewBox"/>.
|
||||
/// Intended to be connected to a slider or scroll input signal. No-op if
|
||||
/// <c>viewBox</c> is not assigned.
|
||||
/// </summary>
|
||||
/// <param name="value">Normalized zoom factor (0–1).</param>
|
||||
public void OnChangeZoom(float value)
|
||||
{
|
||||
if (viewBox == null)
|
||||
return;
|
||||
|
||||
viewBox.SetZoom(value);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Mods.Interface.View
|
||||
{
|
||||
/// <summary>
|
||||
/// Thin adapter that exposes ViewBox.SetZoom to external callers (e.g. UI
|
||||
/// sliders or scroll handlers) through a single method. Exists as a Node
|
||||
/// so it can be placed in the scene tree and receive signals.
|
||||
/// </summary>
|
||||
public partial class ZoomViewBoxController : Node
|
||||
{
|
||||
|
||||
[Export] private ViewBox viewBox;
|
||||
|
||||
/// <summary>
|
||||
/// Delegates to <see cref="ViewBox.SetZoom"/> on the linked <see cref="ViewBox"/>.
|
||||
/// Intended to be connected to a slider or scroll input signal. No-op if
|
||||
/// <c>viewBox</c> is not assigned.
|
||||
/// </summary>
|
||||
/// <param name="value">Normalized zoom factor (0–1).</param>
|
||||
public void OnChangeZoom(float value)
|
||||
{
|
||||
if (viewBox == null)
|
||||
return;
|
||||
|
||||
viewBox.SetZoom(value);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in new issue
Block a user