| | | 1 | | using System; |
| | | 2 | | using UnityEngine; |
| | | 3 | | |
| | | 4 | | namespace DCL |
| | | 5 | | { |
| | | 6 | | public enum AssetPromiseState |
| | | 7 | | { |
| | | 8 | | IDLE_AND_EMPTY, |
| | | 9 | | WAITING, |
| | | 10 | | LOADING, |
| | | 11 | | FINISHED |
| | | 12 | | } |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// AssetPromise is in charge of handling all the logic related to loading the specified AssetType. |
| | | 16 | | /// It also should return the cached asset if applicable. |
| | | 17 | | /// |
| | | 18 | | /// If we need settings related to how the asset should be loaded/handled, we add them here. |
| | | 19 | | /// |
| | | 20 | | /// If we need many ways of loading the same Asset type, we can create different AssetPromise |
| | | 21 | | /// subclasses to do so. This can be useful to attach the GLTFSceneImporter loading logic for |
| | | 22 | | /// materials/textures to system. |
| | | 23 | | /// </summary> |
| | | 24 | | /// <typeparam name="AssetType">The Asset type to be loaded.</typeparam> |
| | | 25 | | public abstract class AssetPromise<AssetType> : CustomYieldInstruction |
| | | 26 | | where AssetType : Asset, new() |
| | | 27 | | { |
| | | 28 | | internal bool isDirty = false; |
| | | 29 | | internal AssetLibrary<AssetType> library; |
| | 0 | 30 | | public AssetType asset { get; protected set; } |
| | | 31 | | |
| | 0 | 32 | | public AssetPromiseState state { get; protected set; } |
| | 0 | 33 | | public bool isForgotten { get; protected set; } |
| | | 34 | | |
| | | 35 | | internal event Action<AssetPromise<AssetType>> OnPreFinishEvent; |
| | | 36 | | public event Action<AssetType> OnSuccessEvent; |
| | | 37 | | public event Action<AssetType> OnFailEvent; |
| | | 38 | | |
| | 4877 | 39 | | public override bool keepWaiting { get { return state == AssetPromiseState.LOADING || state == AssetPromiseState |
| | | 40 | | |
| | | 41 | | public void ClearEvents() |
| | | 42 | | { |
| | 0 | 43 | | OnSuccessEvent = null; |
| | 0 | 44 | | OnFailEvent = null; |
| | 0 | 45 | | } |
| | | 46 | | |
| | | 47 | | internal void ForceFail() |
| | | 48 | | { |
| | 8 | 49 | | OnPreFinishEvent = null; |
| | 8 | 50 | | CallAndClearEvents(false); |
| | 8 | 51 | | state = AssetPromiseState.IDLE_AND_EMPTY; |
| | 8 | 52 | | } |
| | | 53 | | |
| | | 54 | | internal void SetWaitingState() |
| | | 55 | | { |
| | | 56 | | //TODO(Brian): This is made to make the promises yielding not return automatically when the promise is block |
| | | 57 | | // |
| | | 58 | | // Managing the blocked promises handling entirely in the AssetPromiseKeeper is coupling the cod |
| | | 59 | | // It's better to have a "WaitForPromise" method here and lighten the APK logic a bit. For now t |
| | 0 | 60 | | state = AssetPromiseState.WAITING; |
| | 0 | 61 | | } |
| | | 62 | | |
| | | 63 | | protected void CallAndClearEvents(bool isSuccess = true) |
| | | 64 | | { |
| | 320 | 65 | | if (asset == null) |
| | | 66 | | { |
| | 28 | 67 | | isSuccess = false; |
| | | 68 | | } |
| | | 69 | | |
| | 320 | 70 | | OnPreFinishEvent?.Invoke(this); |
| | 320 | 71 | | OnPreFinishEvent = null; |
| | | 72 | | |
| | 320 | 73 | | Action<AssetType> finalEvent = isSuccess ? OnSuccessEvent : OnFailEvent; |
| | | 74 | | |
| | 320 | 75 | | finalEvent?.Invoke(asset); |
| | | 76 | | |
| | 320 | 77 | | ClearEvents(); |
| | 320 | 78 | | } |
| | | 79 | | |
| | | 80 | | internal virtual void Load() |
| | | 81 | | { |
| | 346 | 82 | | if (state == AssetPromiseState.LOADING || state == AssetPromiseState.FINISHED) |
| | 2 | 83 | | return; |
| | | 84 | | |
| | 344 | 85 | | state = AssetPromiseState.LOADING; |
| | | 86 | | |
| | | 87 | | // NOTE(Brian): Get existent library element |
| | 344 | 88 | | object libraryAssetCheckId = GetLibraryAssetCheckId(); |
| | 344 | 89 | | if (library.Contains(libraryAssetCheckId)) |
| | | 90 | | { |
| | 125 | 91 | | asset = GetAsset(libraryAssetCheckId); |
| | | 92 | | |
| | 125 | 93 | | if (asset != null) |
| | | 94 | | { |
| | 125 | 95 | | OnBeforeLoadOrReuse(); |
| | 125 | 96 | | OnReuse(OnReuseFinished); |
| | 125 | 97 | | } |
| | | 98 | | else |
| | | 99 | | { |
| | 0 | 100 | | CallAndClearEvents(false); |
| | | 101 | | } |
| | | 102 | | |
| | 0 | 103 | | return; |
| | | 104 | | } |
| | | 105 | | |
| | | 106 | | // NOTE(Brian): Get new library element |
| | 219 | 107 | | asset = new AssetType(); |
| | 219 | 108 | | OnBeforeLoadOrReuse(); |
| | 219 | 109 | | asset.id = GetId(); |
| | | 110 | | |
| | 219 | 111 | | OnLoad(OnLoadSuccess, OnLoadFailure); |
| | 219 | 112 | | } |
| | | 113 | | |
| | 273 | 114 | | protected virtual object GetLibraryAssetCheckId() { return GetId(); } |
| | | 115 | | |
| | 107 | 116 | | protected virtual AssetType GetAsset(object id) { return library.Get(id); } |
| | | 117 | | |
| | 148 | 118 | | protected virtual void OnReuse(Action OnFinish) { OnFinish?.Invoke(); } |
| | | 119 | | |
| | | 120 | | protected void OnReuseFinished() |
| | | 121 | | { |
| | 123 | 122 | | OnAfterLoadOrReuse(); |
| | 123 | 123 | | state = AssetPromiseState.FINISHED; |
| | 123 | 124 | | CallAndClearEvents(isSuccess: true); |
| | 123 | 125 | | } |
| | | 126 | | |
| | | 127 | | protected void OnLoadSuccess() |
| | | 128 | | { |
| | 134 | 129 | | if (AddToLibrary()) |
| | | 130 | | { |
| | 134 | 131 | | OnAfterLoadOrReuse(); |
| | 134 | 132 | | state = AssetPromiseState.FINISHED; |
| | 134 | 133 | | CallAndClearEvents(isSuccess: true); |
| | 134 | 134 | | } |
| | | 135 | | else |
| | | 136 | | { |
| | 0 | 137 | | OnLoadFailure(); |
| | | 138 | | } |
| | 0 | 139 | | } |
| | | 140 | | |
| | | 141 | | protected void OnLoadFailure() |
| | | 142 | | { |
| | 55 | 143 | | CallAndClearEvents(isSuccess: false); |
| | 55 | 144 | | Cleanup(); |
| | 55 | 145 | | } |
| | | 146 | | |
| | 7 | 147 | | protected virtual bool AddToLibrary() { return library.Add(asset); } |
| | | 148 | | |
| | | 149 | | internal void Unload() |
| | | 150 | | { |
| | 193 | 151 | | if (state == AssetPromiseState.IDLE_AND_EMPTY) |
| | 6 | 152 | | return; |
| | | 153 | | |
| | 187 | 154 | | Cleanup(); |
| | 187 | 155 | | } |
| | | 156 | | |
| | | 157 | | public void Cleanup() |
| | | 158 | | { |
| | 251 | 159 | | if (state == AssetPromiseState.LOADING) |
| | | 160 | | { |
| | 85 | 161 | | OnCancelLoading(); |
| | 85 | 162 | | ClearEvents(); |
| | | 163 | | } |
| | | 164 | | |
| | 251 | 165 | | state = AssetPromiseState.IDLE_AND_EMPTY; |
| | | 166 | | |
| | 251 | 167 | | if (asset != null) |
| | | 168 | | { |
| | 226 | 169 | | if (library.Contains(asset)) |
| | 143 | 170 | | library.Release(asset); |
| | | 171 | | else |
| | 83 | 172 | | asset.Cleanup(); |
| | | 173 | | |
| | 226 | 174 | | asset = null; |
| | | 175 | | } |
| | 251 | 176 | | } |
| | | 177 | | |
| | | 178 | | internal virtual void OnForget() |
| | | 179 | | { |
| | 486 | 180 | | isForgotten = true; |
| | 486 | 181 | | ClearEvents(); |
| | 486 | 182 | | } |
| | | 183 | | |
| | | 184 | | protected abstract void OnCancelLoading(); |
| | | 185 | | protected abstract void OnLoad(Action OnSuccess, Action OnFail); |
| | | 186 | | protected abstract void OnBeforeLoadOrReuse(); |
| | | 187 | | protected abstract void OnAfterLoadOrReuse(); |
| | | 188 | | public abstract object GetId(); |
| | | 189 | | } |
| | | 190 | | } |