UnityMirror/spine-runtimes
1
0
Fork 0
mirror of https://github.com/EsotericSoftware/spine-runtimes.git synced 2026-02-04 14:24:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Make overlayAssignedPromise private.

Browse Source
This commit is contained in:
Davide Tantillo 2025-04-29 16:29:38 +02:00
parent b1370ceae3
commit 7759b501e5
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
spine-ts/spine-webgl/src/SpineWebComponentWidget.ts
View File

@ -237,21 +237,6 @@ interface WidgetInternalProperties {
export class SpineWebComponentWidget extends HTMLElement implements Disposable, WidgetAttributes, WidgetOverridableMethods, WidgetInternalProperties, Partial<WidgetPublicProperties> { export class SpineWebComponentWidget extends HTMLElement implements Disposable, WidgetAttributes, WidgetOverridableMethods, WidgetInternalProperties, Partial<WidgetPublicProperties> {
// this promise in necessary only for manual start. Before calling manual start is necessary that the overlay has been assigned to the widget.
// overlay assignment is asynchronous due to webcomponent promotion and dom load termination.
// When manual start is false, loadSkeleton is invoked after the overlay is assigned. loadSkeleton needs the assetManager that is owned by the overlay.
// the overlay owns the assetManager because the overly owns the gl context.
// if it wasn't for the gl context with which textures are created, we could:
// - have a unique asset manager independent from the overlay (we literally reload the same assets in two different overlays)
// - remove overlayAssignedPromise and the needs to wait for its resolving
// - remove appendTo that is just to avoid the user to use the overlayAssignedPromise when the widget is created using js
public overlayAssignedPromise: Promise<void>;
public async appendTo (element: HTMLElement): Promise<void> {
element.appendChild(this);
await this.overlayAssignedPromise;
}
/** /**
* If true, enables a top-left span showing FPS (it has black text) * If true, enables a top-left span showing FPS (it has black text)
*/ */
@ -768,6 +753,16 @@ export class SpineWebComponentWidget extends HTMLElement implements Disposable,
// Invoked when widget has an overlay assigned // Invoked when widget has an overlay assigned
private resolveOverlayAssignedPromise!: () => void; private resolveOverlayAssignedPromise!: () => void;
// this promise in necessary only for manual start. Before calling manual start is necessary that the overlay has been assigned to the widget.
// overlay assignment is asynchronous due to webcomponent promotion and dom load termination.
// When manual start is false, loadSkeleton is invoked after the overlay is assigned. loadSkeleton needs the assetManager that is owned by the overlay.
// the overlay owns the assetManager because the overly owns the gl context.
// if it wasn't for the gl context with which textures are created, we could:
// - have a unique asset manager independent from the overlay (we literally reload the same assets in two different overlays)
// - remove overlayAssignedPromise and the needs to wait for its resolving
// - remove appendTo that is just to avoid the user to use the overlayAssignedPromise when the widget is created using js
private overlayAssignedPromise: Promise<void>;
static attributesDescription: Record<string, { propertyName: keyof WidgetAttributes, type: AttributeTypes, defaultValue?: any }> = { static attributesDescription: Record<string, { propertyName: keyof WidgetAttributes, type: AttributeTypes, defaultValue?: any }> = {
atlas: { propertyName: "atlasPath", type: "string" }, atlas: { propertyName: "atlasPath", type: "string" },
skeleton: { propertyName: "skeletonPath", type: "string" }, skeleton: { propertyName: "skeletonPath", type: "string" },
@ -936,6 +931,15 @@ export class SpineWebComponentWidget extends HTMLElement implements Disposable,
: this; : this;
} }
/**
* Append the widget to the given `HTMLElement`.
* @param atlas the `HTMLElement` to append this widget to.
*/
public async appendTo (element: HTMLElement): Promise<void> {
element.appendChild(this);
await this.overlayAssignedPromise;
}
/** /**
* Recalculates and sets the bounds of the current animation on track 0. * Recalculates and sets the bounds of the current animation on track 0.
* Useful when animations or skins are set programmatically. * Useful when animations or skins are set programmatically.
@ -993,6 +997,9 @@ export class SpineWebComponentWidget extends HTMLElement implements Disposable,
} }
} }
// this ensure there is an overlay assigned because the overlay owns the asset manager
await this.overlayAssignedPromise;
// skeleton and atlas txt are loaded immeaditely // skeleton and atlas txt are loaded immeaditely
// textures are loaeded depending on the 'pages' param: // textures are loaeded depending on the 'pages' param:
// - [0,2]: only pages at index 0 and 2 are loaded // - [0,2]: only pages at index 0 and 2 are loaded