init
This commit is contained in:
@@ -0,0 +1,520 @@
|
||||
using Cthangover.Core.Mods;
|
||||
using Cthangover.Core.UI.Event;
|
||||
using Cthangover.Core.Utils;
|
||||
using Godot;
|
||||
|
||||
namespace Cthangover.Live2D.Cubism.Framework
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines how the Live2D model scales to fit its parent container.
|
||||
/// </summary>
|
||||
public enum FitMode { None, FitWidth, FitHeight, FitAuto }
|
||||
|
||||
/// <summary>
|
||||
/// The main Godot node that loads, updates, and renders a Live2D Cubism model.
|
||||
/// Represents a single character/avatar in the scene tree.
|
||||
///
|
||||
/// Orchestrates the full pipeline:
|
||||
/// <list type="number">
|
||||
/// <item>Loads .model3.json and .moc3 via <see cref="CubismNativeModel"/></item>
|
||||
/// <item>Sets up <see cref="CubismParameter"/> and <see cref="CubismPartOpacity"/> arrays</item>
|
||||
/// <item>Creates optional effect layers: <see cref="CubismEyeBlink"/>, <see cref="CubismBreath"/>,
|
||||
/// <see cref="CubismPose"/>, <see cref="CubismPhysics"/></item>
|
||||
/// <item>Builds 2D meshes through <see cref="CubismRenderer2D"/></item>
|
||||
/// <item>Every frame (<see cref="OnUpdate"/>): target point -> parameter injection ->
|
||||
/// motion/expression evaluation -> effect layers -> model update -> renderer update</item>
|
||||
/// </list>
|
||||
///
|
||||
/// The update order matters: motion values are applied first, then expression values
|
||||
/// blend on top, and finally effect layers (eye blink, breath, pose, physics) modify
|
||||
/// the result. The target point drives face-tracking parameters (ParamAngleX/Y, ParamEyeBallX/Y).
|
||||
/// </summary>
|
||||
public partial class CubismModelNode : Node2D, IOnUpdateEvent
|
||||
{
|
||||
public int Priority => 0;
|
||||
private CubismNativeModel _nativeModel;
|
||||
private CubismRenderer2D _renderer;
|
||||
private CubismModelSettingJson _modelSetting;
|
||||
|
||||
private CubismEyeBlink _eyeBlink;
|
||||
private CubismBreath _breath;
|
||||
private CubismPose _pose;
|
||||
private CubismPhysics _physics;
|
||||
private CubismTargetPoint _targetPoint = new();
|
||||
|
||||
private Vector2 _contentSize;
|
||||
private Vector2 _contentCenter;
|
||||
private bool _contentBoundsReady;
|
||||
|
||||
private CubismMotionQueueManager _motionManager = new();
|
||||
private CubismMotionQueueManager _expressionManager = new();
|
||||
|
||||
private float _userTimeSeconds;
|
||||
private string _modelDir;
|
||||
private IModFileProvider _fileProvider;
|
||||
private bool _layoutLogged;
|
||||
private readonly System.Collections.Generic.HashSet<string> _manualParameters = new();
|
||||
|
||||
/// <summary>
|
||||
/// All model parameters with their IDs, bounds, and current values.
|
||||
/// Directly references the native parameter arrays — modifying
|
||||
/// <see cref="CubismParameter.Value"/> and calling
|
||||
/// <see cref="CubismParameter.ApplyToModel"/> writes back to CubismCore.
|
||||
/// </summary>
|
||||
public CubismParameter[] Parameters { get; private set; } = System.Array.Empty<CubismParameter>();
|
||||
|
||||
/// <summary>
|
||||
/// All model part opacities, indexed by part index.
|
||||
/// Useful for showing/hiding parts (clothing layers, accessories, etc.).
|
||||
/// </summary>
|
||||
public CubismPartOpacity[] PartOpacities { get; private set; } = System.Array.Empty<CubismPartOpacity>();
|
||||
|
||||
/// <summary>Canvas pixel width from the model's .moc3 data. Available after loading.</summary>
|
||||
public float CanvasWidth => _nativeModel?.CanvasWidth ?? 0f;
|
||||
|
||||
/// <summary>Canvas pixel height from the model's .moc3 data. Available after loading.</summary>
|
||||
public float CanvasHeight => _nativeModel?.CanvasHeight ?? 0f;
|
||||
|
||||
/// <summary>
|
||||
/// Horizontal anchor point for layout positioning, 0..1.
|
||||
/// 0 = left edge, 0.5 = center, 1 = right edge. Default 0.5.
|
||||
/// Serialized as a Godot export property.
|
||||
/// </summary>
|
||||
[Export] public float AnchorX { get; set; } = 0.5f;
|
||||
|
||||
/// <summary>
|
||||
/// Vertical anchor point for layout positioning, 0..1.
|
||||
/// 0 = top edge, 0.5 = center, 1 = bottom edge. Default 0.5.
|
||||
/// </summary>
|
||||
[Export] public float AnchorY { get; set; } = 0.5f;
|
||||
|
||||
/// <summary>
|
||||
/// How the model scales to fit its parent container. Default <see cref="FitMode.FitAuto"/>.
|
||||
/// Used by <see cref="DeferredApplyLayout"/> on the first frame with a valid parent size.
|
||||
/// </summary>
|
||||
[Export] public FitMode ScaleFit { get; set; } = FitMode.FitAuto;
|
||||
|
||||
/// <summary>
|
||||
/// Enables automatic eye blink animation. Requires EyeBlink parameter groups
|
||||
/// in the model3.json. Default true.
|
||||
/// </summary>
|
||||
[Export] public bool EnableEyeBlink { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Enables breathing animation. Default false.
|
||||
/// Note: breath parameters are not currently loaded from model settings —
|
||||
/// enable this only if parameters are set externally via <see cref="CubismBreath.SetParameters"/>.
|
||||
/// </summary>
|
||||
[Export] public bool EnableBreath { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Enables physics simulation (hair, cloth, etc.) from the .physics3.json file.
|
||||
/// Default true.
|
||||
/// </summary>
|
||||
[Export] public bool EnablePhysics { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Enables pose-based part opacity management from the .pose3.json file.
|
||||
/// Default true.
|
||||
/// </summary>
|
||||
[Export] public bool EnablePose { get; set; } = true;
|
||||
|
||||
private bool _loaded;
|
||||
|
||||
/// <summary>
|
||||
/// Loads a Cubism model from within a registered mod.
|
||||
/// Reads the .model3.json file, resolves the .moc3 and textures, then
|
||||
/// calls <see cref="FinishSetup"/> to build parameters, parts, effects, and meshes.
|
||||
/// When <paramref name="modId"/> is <c>null</c>, all mods are searched in priority
|
||||
/// order for the first match.
|
||||
/// </summary>
|
||||
/// <param name="relativePath">Path to .model3.json relative to the mod root.</param>
|
||||
/// <param name="modId">Optional registered mod ID containing the model assets.</param>
|
||||
public void LoadModelFromMod(string relativePath, string modId = null)
|
||||
{
|
||||
var mods = ModManager.Instance?.Mods;
|
||||
if (mods == null)
|
||||
{
|
||||
GameLogger.Log("LIVE2D", $"LoadModelFromMod: no mods loaded", LogLevel.Error);
|
||||
return;
|
||||
}
|
||||
|
||||
IModInfo modInfo = null;
|
||||
|
||||
if (modId != null)
|
||||
{
|
||||
mods.TryGetValue(modId, out modInfo);
|
||||
}
|
||||
else
|
||||
{
|
||||
var orderedIds = ModRegistry.Instance.GetOrderedModIds();
|
||||
foreach (var id in orderedIds)
|
||||
{
|
||||
if (mods.TryGetValue(id, out var candidate) && candidate.FileProvider?.FileExists(relativePath) == true)
|
||||
{
|
||||
modInfo = candidate;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (modInfo == null)
|
||||
{
|
||||
GameLogger.Log("LIVE2D", $"LoadModelFromMod: file '{relativePath}' not found in any mod", LogLevel.Error);
|
||||
return;
|
||||
}
|
||||
|
||||
_fileProvider = modInfo.FileProvider;
|
||||
var jsonBytes = _fileProvider.ReadFileBinary(relativePath);
|
||||
if (jsonBytes == null)
|
||||
{
|
||||
GameLogger.Log("LIVE2D", $"LoadModelFromMod: file not found '{relativePath}' in mod '{modId ?? "?"}'", LogLevel.Error);
|
||||
return;
|
||||
}
|
||||
|
||||
_modelDir = relativePath.Contains('/')
|
||||
? relativePath.Substring(0, relativePath.LastIndexOf('/'))
|
||||
: "";
|
||||
|
||||
_nativeModel = new CubismNativeModel();
|
||||
_nativeModel.LoadFromProvider(jsonBytes, _modelDir, _fileProvider);
|
||||
FinishSetup(jsonBytes);
|
||||
}
|
||||
|
||||
private void FinishSetup(byte[] model3JsonBytes)
|
||||
{
|
||||
_modelSetting = new CubismModelSettingJson(model3JsonBytes);
|
||||
SetupParameters();
|
||||
SetupParts();
|
||||
SetupEffects();
|
||||
|
||||
_renderer = new CubismRenderer2D(this);
|
||||
_nativeModel.UpdateModel();
|
||||
_renderer.BuildModel(_nativeModel);
|
||||
|
||||
var bounds = _renderer.GetContentBounds();
|
||||
_contentSize = new Vector2(bounds.Size.X, bounds.Size.Y);
|
||||
_contentCenter = new Vector2(bounds.GetCenter().X, bounds.GetCenter().Y);
|
||||
_contentBoundsReady = true;
|
||||
GameLogger.Log("LIVE2D", $"contentBounds: center={_contentCenter} size={_contentSize}");
|
||||
|
||||
_loaded = true;
|
||||
|
||||
var ec = GetNodeOrNull<SceneEventController>("/root/EventController");
|
||||
if (ec != null)
|
||||
ec.AddUpdateEventListener(this);
|
||||
|
||||
GameLogger.Log("LIVE2D", $"Model loaded: {_nativeModel.ParameterCount} params, {_nativeModel.DrawableCount} drawables, canvas={_nativeModel.CanvasWidth}x{_nativeModel.CanvasHeight}");
|
||||
}
|
||||
|
||||
private ulong _lastTickMsec;
|
||||
|
||||
/// <summary>
|
||||
/// Per-frame update called by the SceneEventController.
|
||||
/// Execution order:
|
||||
/// <list type="number">
|
||||
/// <item>Apply deferred layout (first valid frame only)</item>
|
||||
/// <item>Update <see cref="_targetPoint"/> for face tracking</item>
|
||||
/// <item>Inject face-tracking parameters (ParamAngleX/Y, ParamEyeBallX/Y)
|
||||
/// into the native model</item>
|
||||
/// <item>Evaluate motion queue (character animations)</item>
|
||||
/// <item>Evaluate expression queue (facial expressions)</item>
|
||||
/// <item>Run effect layers in order: breath, eye blink, pose, physics</item>
|
||||
/// <item>Call <c>csmUpdateModel</c> on the native model</item>
|
||||
/// <item>Update the renderer (visibility, opacity, vertex positions)</item>
|
||||
/// </list>
|
||||
/// </summary>
|
||||
public void OnUpdate()
|
||||
{
|
||||
if (!_loaded) return;
|
||||
|
||||
var now = Time.GetTicksMsec();
|
||||
var dt = _lastTickMsec == 0 ? 0.016f : (now - _lastTickMsec) / 1000f;
|
||||
_lastTickMsec = now;
|
||||
|
||||
DeferredApplyLayout();
|
||||
|
||||
_userTimeSeconds += dt;
|
||||
|
||||
_targetPoint.Update(dt);
|
||||
var tx = _targetPoint.X;
|
||||
var ty = _targetPoint.Y;
|
||||
|
||||
unsafe
|
||||
{
|
||||
var values = _nativeModel.GetParameterValues();
|
||||
var idsPtr = _nativeModel.GetParameterIds();
|
||||
|
||||
for (int i = 0; i < _nativeModel.ParameterCount; i++)
|
||||
{
|
||||
var id = CubismNativeModel.ReadStringFromPtrArray(idsPtr, i);
|
||||
if (_manualParameters.Contains(id)) continue;
|
||||
switch (id)
|
||||
{
|
||||
case "ParamAngleX": values[i] = tx * 30f; break;
|
||||
case "ParamAngleY": values[i] = ty * 30f; break;
|
||||
case "ParamEyeBallX": values[i] = tx; break;
|
||||
case "ParamEyeBallY": values[i] = ty; break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_motionManager.DoUpdateMotion(_nativeModel, _userTimeSeconds);
|
||||
_expressionManager.DoUpdateMotion(_nativeModel, _userTimeSeconds);
|
||||
|
||||
_breath?.UpdateParameters(_nativeModel, dt);
|
||||
_eyeBlink?.UpdateParameters(_nativeModel, dt);
|
||||
_pose?.UpdateParameters(_nativeModel, dt);
|
||||
_physics?.Evaluate(_nativeModel, dt);
|
||||
|
||||
_nativeModel.UpdateModel();
|
||||
_renderer.UpdateModel();
|
||||
}
|
||||
|
||||
private void DeferredApplyLayout()
|
||||
{
|
||||
if (_layoutLogged) return;
|
||||
if (!_contentBoundsReady) return;
|
||||
|
||||
var parentSize = GetParentSize();
|
||||
if (parentSize.X <= 0f || parentSize.Y <= 0f) return;
|
||||
|
||||
var cw = _contentSize.X;
|
||||
var ch = _contentSize.Y;
|
||||
if (cw <= 0f || ch <= 0f) return;
|
||||
|
||||
float scale = 1f;
|
||||
switch (ScaleFit)
|
||||
{
|
||||
case FitMode.FitWidth: scale = parentSize.X / cw; break;
|
||||
case FitMode.FitHeight: scale = parentSize.Y / ch; break;
|
||||
case FitMode.FitAuto: scale = Mathf.Min(parentSize.X / cw, parentSize.Y / ch); break;
|
||||
}
|
||||
|
||||
Scale = new Vector2(scale, scale);
|
||||
Position = new Vector2(
|
||||
parentSize.X * AnchorX - _contentCenter.X * scale,
|
||||
parentSize.Y * AnchorY - _contentCenter.Y * scale);
|
||||
|
||||
_layoutLogged = true;
|
||||
GameLogger.Log("LIVE2D", $"ApplyLayout: parentSize={parentSize} contentSize={cw}x{ch} contentCenter={_contentCenter} scale={scale} pos={Position}");
|
||||
}
|
||||
|
||||
private Vector2 GetParentSize()
|
||||
{
|
||||
var parent = GetParent();
|
||||
if (parent is Control c && c.Size.X > 0f && c.Size.Y > 0f)
|
||||
return c.Size;
|
||||
return GetViewportRect().Size;
|
||||
}
|
||||
|
||||
private unsafe void SetupParameters()
|
||||
{
|
||||
var count = _nativeModel.ParameterCount;
|
||||
Parameters = new CubismParameter[count];
|
||||
var idsPtr = _nativeModel.GetParameterIds();
|
||||
var mins = _nativeModel.GetParameterMinimumValues();
|
||||
var maxs = _nativeModel.GetParameterMaximumValues();
|
||||
var defaults = _nativeModel.GetParameterDefaultValues();
|
||||
|
||||
for (int i = 0; i < count; i++)
|
||||
{
|
||||
Parameters[i] = new CubismParameter(_nativeModel)
|
||||
{
|
||||
Id = CubismNativeModel.ReadStringFromPtrArray(idsPtr, i),
|
||||
Index = i,
|
||||
MinimumValue = mins[i],
|
||||
MaximumValue = maxs[i],
|
||||
DefaultValue = defaults[i],
|
||||
Value = defaults[i]
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
private unsafe void SetupParts()
|
||||
{
|
||||
var count = _nativeModel.GetPartCount();
|
||||
PartOpacities = new CubismPartOpacity[count];
|
||||
var idsPtr = _nativeModel.GetPartIds();
|
||||
var opacities = _nativeModel.GetPartOpacities();
|
||||
|
||||
for (int i = 0; i < count; i++)
|
||||
{
|
||||
PartOpacities[i] = new CubismPartOpacity(_nativeModel)
|
||||
{
|
||||
Id = CubismNativeModel.ReadStringFromPtrArray(idsPtr, i),
|
||||
Index = i,
|
||||
Value = opacities[i]
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
private void SetupEffects()
|
||||
{
|
||||
if (EnableEyeBlink && _modelSetting.GetEyeBlinkParameterCount() > 0)
|
||||
{
|
||||
_eyeBlink = new CubismEyeBlink();
|
||||
var ids = new System.Collections.Generic.List<string>();
|
||||
for (int i = 0; i < _modelSetting.GetEyeBlinkParameterCount(); i++)
|
||||
ids.Add(_modelSetting.GetEyeBlinkParameterId(i));
|
||||
_eyeBlink.SetParameterIds(ids);
|
||||
}
|
||||
|
||||
var physicsPath = _modelSetting.GetPhysicsFileName();
|
||||
if (EnablePhysics && !string.IsNullOrEmpty(physicsPath))
|
||||
{
|
||||
var physBytes = ReadModFile(physicsPath);
|
||||
if (physBytes != null)
|
||||
_physics = new CubismPhysics(physBytes);
|
||||
else
|
||||
GameLogger.Log("LIVE2D", $"SetupEffects: failed to read physics '{physicsPath}'", LogLevel.Warning);
|
||||
}
|
||||
|
||||
var posePath = _modelSetting.GetPoseFileName();
|
||||
if (EnablePose && !string.IsNullOrEmpty(posePath))
|
||||
{
|
||||
var poseBytes = ReadModFile(posePath);
|
||||
if (poseBytes != null)
|
||||
_pose = new CubismPose(poseBytes);
|
||||
else
|
||||
GameLogger.Log("LIVE2D", $"SetupEffects: failed to read pose '{posePath}'", LogLevel.Warning);
|
||||
}
|
||||
}
|
||||
|
||||
private byte[] ReadModFile(string relativePath)
|
||||
{
|
||||
var normalized = relativePath.Replace('\\', '/');
|
||||
var combined = string.IsNullOrEmpty(_modelDir) ? normalized : $"{_modelDir}/{normalized}";
|
||||
var result = _fileProvider.ReadFileBinary(combined);
|
||||
if (result == null)
|
||||
GameLogger.Log("LIVE2D", $"ReadModFile: provider returned null for '{combined}'", LogLevel.Warning);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sets the face-tracking target. Drives eye/head movement parameters
|
||||
/// (ParamAngleX/Y, ParamEyeBallX/Y) through a smooth damped approach
|
||||
/// in <see cref="CubismTargetPoint"/>.
|
||||
/// </summary>
|
||||
public void SetTargetPoint(float x, float y) => _targetPoint.Set(x, y);
|
||||
|
||||
/// <summary>
|
||||
/// Finds a parameter by its Cubism ID string (e.g. "ParamAngleX").
|
||||
/// Returns null if not found.
|
||||
/// </summary>
|
||||
public CubismParameter FindParameter(string id)
|
||||
{
|
||||
foreach (var p in Parameters)
|
||||
if (p.Id == id) return p;
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finds a part by its Cubism ID string. Returns null if not found.
|
||||
/// </summary>
|
||||
public CubismPartOpacity FindPart(string id)
|
||||
{
|
||||
foreach (var p in PartOpacities)
|
||||
if (p.Id == id) return p;
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets a parameter value directly in the native model, bypassing the per-frame
|
||||
/// face-tracking injection in <see cref="OnUpdate"/>. Once a parameter is set
|
||||
/// via this method, <see cref="OnUpdate"/> stops overwriting it — the caller
|
||||
/// takes full control of that parameter's value.
|
||||
/// Safe to call before the model is loaded — silently ignored.
|
||||
/// </summary>
|
||||
/// <param name="id">Cubism parameter ID (e.g. "ParamAngleX").</param>
|
||||
/// <param name="value">Raw parameter value. Caller should clamp to the parameter's bounds.</param>
|
||||
public void SetLiveParameter(string id, float value)
|
||||
{
|
||||
if (!_loaded)
|
||||
{
|
||||
GameLogger.Log("LIVE2D", $"SetLiveParameter: model not loaded, ignoring id='{id}'", LogLevel.Warning);
|
||||
return;
|
||||
}
|
||||
|
||||
unsafe
|
||||
{
|
||||
var values = _nativeModel.GetParameterValues();
|
||||
var idsPtr = _nativeModel.GetParameterIds();
|
||||
|
||||
for (int i = 0; i < _nativeModel.ParameterCount; i++)
|
||||
{
|
||||
var paramId = CubismNativeModel.ReadStringFromPtrArray(idsPtr, i);
|
||||
if (paramId != id) continue;
|
||||
|
||||
values[i] = value;
|
||||
_manualParameters.Add(id);
|
||||
|
||||
if (i < Parameters.Length)
|
||||
Parameters[i].Value = value;
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
GameLogger.Log("LIVE2D", $"SetLiveParameter: parameter '{id}' not found", LogLevel.Warning);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a motion animation by group name and index.
|
||||
/// Loads the motion3.json from the model directory, applies the
|
||||
/// model-specified fade-in/fade-out times, and enqueues it.
|
||||
/// Safe to call before the model is loaded — the call is silently ignored.
|
||||
/// </summary>
|
||||
/// <param name="group">Motion group name from model3.json (e.g. "Idle", "TapBody").</param>
|
||||
/// <param name="no">Zero-based index within the group.</param>
|
||||
public void StartMotion(string group, int no)
|
||||
{
|
||||
if (!_loaded) return;
|
||||
if (no < 0 || no >= _modelSetting.GetMotionCount(group)) return;
|
||||
|
||||
var motionFileName = _modelSetting.GetMotionFileName(group, no);
|
||||
var motionBytes = ReadModFile(motionFileName);
|
||||
if (motionBytes == null) return;
|
||||
|
||||
var motion = new CubismMotion(motionBytes);
|
||||
|
||||
var fadeIn = _modelSetting.GetMotionFadeInTimeValue(group, no);
|
||||
var fadeOut = _modelSetting.GetMotionFadeOutTimeValue(group, no);
|
||||
if (fadeIn >= 0f) motion.FadeInSeconds = fadeIn;
|
||||
if (fadeOut >= 0f) motion.FadeOutSeconds = fadeOut;
|
||||
|
||||
_motionManager.StartMotion(motion, true, _userTimeSeconds);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts an expression by its name (as defined in the model3.json
|
||||
/// Expressions array). Looks up the expression file, loads the
|
||||
/// .exp3.json, and enqueues it in the expression manager.
|
||||
/// Safe to call before model loaded — silently ignored.
|
||||
/// </summary>
|
||||
public void StartExpression(string expressionId)
|
||||
{
|
||||
if (!_loaded) return;
|
||||
|
||||
for (int i = 0; i < _modelSetting.GetExpressionCount(); i++)
|
||||
{
|
||||
if (_modelSetting.GetExpressionName(i) == expressionId)
|
||||
{
|
||||
var expBytes = ReadModFile(_modelSetting.GetExpressionFileName(i));
|
||||
if (expBytes == null) return;
|
||||
|
||||
var expr = new CubismExpressionMotion(expBytes);
|
||||
_expressionManager.StartMotion(expr, true, _userTimeSeconds);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Stops all currently playing motion animations.</summary>
|
||||
public void StopMotion() => _motionManager.StopAllMotions();
|
||||
|
||||
/// <summary>Stops all currently playing expression animations.</summary>
|
||||
public void StopExpression() => _expressionManager.StopAllMotions();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user