Ybbaigo asset provider

README.md

@@ -12,7 +12,7 @@ This repository has three primary branches:
   - This is the branch we publish to pub from. 
   - This branch and the associated pub packages are guaranteed to work on the flutter stable channel.
   ```
-  flare_flutter: ^1.7.1
+  flare_flutter: ^1.8.3
   ```
 - dev
   - This branch has the latest changes should work with the flutter dev channel.

example/simple/lib/main.dart

@@ -1,6 +1,8 @@
 import "package:flare_flutter/flare_actor.dart";
 import "package:flare_flutter/flare_cache_builder.dart";
 import "package:flutter/material.dart";
+import 'package:flutter/services.dart';
+import 'package:flare_flutter/provider/asset_flare.dart';
 
 void main() => runApp(MyApp());
 
@@ -27,6 +29,8 @@ class MyHomePage extends StatefulWidget {
 class _MyHomePageState extends State<MyHomePage> {
   String _animationName = "idle";
 
+  final asset = AssetFlare(bundle: rootBundle, name: "assets/Filip.flr");
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -39,12 +43,12 @@ class _MyHomePageState extends State<MyHomePage> {
             children: [
               Expanded(
                 child: FlareCacheBuilder(
-                  ["assets/Filip.flr"],
+                  [asset],
                   builder: (BuildContext context, bool isWarm) {
                     return !isWarm
-                        ? Container(child:Text("NO"))
-                        : FlareActor(
-                            "assets/Filip.flr",
+                        ? Container(child: Text("NO"))
+                        : FlareActor.asset(
+                            asset,
                             alignment: Alignment.center,
                             fit: BoxFit.contain,
                             animation: _animationName,

flare_flutter/lib/asset_provider.dart

@@ -0,0 +1,9 @@
+import 'dart:typed_data';
+
+/// Identifies an asset, to obtain asset from an [AssetProvider], call [load].
+abstract class AssetProvider {
+  const AssetProvider();
+
+  /// Loads the asset.
+  Future<ByteData> load();
+}

flare_flutter/lib/cache.dart

@@ -1,11 +1,13 @@
 import 'dart:async';
+
+import 'asset_provider.dart';
 import 'cache_asset.dart';
 
 typedef CacheAsset AssetFactoryMethod();
 
 /// A base class for loading cached resources
 abstract class Cache<T extends CacheAsset> {
-  final Map<String, T> _assets = {};
+  final Map<AssetProvider, T> _assets = {};
   final Set<T> _toPrune = Set<T>();
   Timer _pruneTimer;
 
@@ -16,7 +18,7 @@ abstract class Cache<T extends CacheAsset> {
 
   void _prune() {
     for (final T asset in _toPrune) {
-      _assets.removeWhere((String filename, T cached) {
+      _assets.removeWhere((AssetProvider assetProvider, T cached) {
         return cached == asset;
       });
     }
@@ -39,34 +41,27 @@ abstract class Cache<T extends CacheAsset> {
   }
 
   /// Get an asset from the cache or load it.
-  Future<T> getAsset(String filename) async {
-    T asset = _assets[filename];
+  Future<T> getAsset(AssetProvider assetProvider) async {
+    T asset = _assets[assetProvider];
     if (asset != null) {
       if (asset.isAvailable) {
         return asset;
       } else {
         return await asset.onLoaded() as T;
       }
     }
-    int lastDot = filename.lastIndexOf(".");
-    if (lastDot != -1) {
-      asset = makeAsset();
-      if (asset != null) {
-        _assets[filename] = asset;
-        asset.load(this, filename);
-        if (asset.isAvailable) {
-          return asset;
-        } else {
-          return await asset.onLoaded() as T;
-        }
-      }
-    }
-    return asset;
+
+    asset = makeAsset();
+    assert(asset != null);
+
+    _assets[assetProvider] = asset;
+    asset.load(this, assetProvider);
+    return asset.isAvailable ? asset : await asset.onLoaded() as T;
   }
 
   /// Get an asset from the cache.
-  T getWarmAsset(String filename) {
-    T asset = _assets[filename];
+  T getWarmAsset(AssetProvider assetProvider) {
+    T asset = _assets[assetProvider];
     return (asset?.isAvailable ?? false) ? asset : null;
   }
 }

flare_flutter/lib/cache_asset.dart

@@ -1,4 +1,6 @@
 import 'dart:async';
+
+import 'asset_provider.dart';
 import 'cache.dart';
 
 /// A reference counted asset in a cache.
@@ -32,9 +34,7 @@ abstract class CacheAsset {
     return completer.future;
   }
 
-  void load(Cache cache, String filename) {
-    _cache = cache;
-  }
+  void load(Cache cache, AssetProvider assetProvider) => _cache = cache;
 
   void completeLoad() {
     if (_callbacks != null) {

flare_flutter/lib/flare_actor.dart

@@ -6,15 +6,29 @@ import 'package:flutter/rendering.dart';
 import 'package:flare_dart/actor_drawable.dart';
 import 'package:flare_dart/math/mat2d.dart';
 import 'package:flare_dart/math/aabb.dart';
+import 'package:flutter/services.dart';
+
+import 'asset_provider.dart';
 import 'flare.dart';
 import 'flare_controller.dart';
+import 'provider/asset_flare.dart';
 
 typedef void FlareCompletedCallback(String name);
 
+/// A widget that displays a Flare.
+///
+/// Several constructors are provided for the various ways that a Flare can be
+/// specified:
+///  * [FlareActor], for obtaining a Flare from an asset [filename].
+///  * [FlareActor.asset], for obtaining a Flare from an [AssetBundle]
+///    using a key.
 class FlareActor extends LeafRenderObjectWidget {
   /// Name of the Flare file to be loaded from the AssetBundle.
   final String filename;
 
+  /// The Flare asset to display.
+  final AssetProvider flareProvider;
+
   /// The name of the artboard to display.
   final String artboard;
 
@@ -72,13 +86,46 @@ class FlareActor extends LeafRenderObjectWidget {
     this.shouldClip = true,
     this.sizeFromArtboard = false,
     this.artboard,
-  });
+  }) : flareProvider = null;
+
+  FlareActor.rootBundle(
+    String name, {
+    this.boundsNode,
+    this.animation,
+    this.fit = BoxFit.contain,
+    this.alignment = Alignment.center,
+    this.isPaused = false,
+    this.snapToEnd = false,
+    this.controller,
+    this.callback,
+    this.color,
+    this.shouldClip = true,
+    this.sizeFromArtboard = false,
+    this.artboard,
+  })  : filename = null,
+        flareProvider = AssetFlare(bundle: rootBundle, name: name);
+
+  const FlareActor.asset(
+    this.flareProvider, {
+    this.boundsNode,
+    this.animation,
+    this.fit = BoxFit.contain,
+    this.alignment = Alignment.center,
+    this.isPaused = false,
+    this.snapToEnd = false,
+    this.controller,
+    this.callback,
+    this.color,
+    this.shouldClip = true,
+    this.sizeFromArtboard = false,
+    this.artboard,
+  })  : filename = null;
 
   @override
   RenderObject createRenderObject(BuildContext context) {
     return FlareActorRenderObject()
-      ..assetBundle = DefaultAssetBundle.of(context)
-      ..filename = filename
+      ..assetProvider =
+          flareProvider ?? AssetFlare(bundle: rootBundle, name: filename)
       ..fit = fit
       ..alignment = alignment
       ..animationName = animation
@@ -97,8 +144,8 @@ class FlareActor extends LeafRenderObjectWidget {
   void updateRenderObject(
       BuildContext context, covariant FlareActorRenderObject renderObject) {
     renderObject
-      ..assetBundle = DefaultAssetBundle.of(context)
-      ..filename = filename
+      ..assetProvider =
+          flareProvider ?? AssetFlare(bundle: rootBundle, name: filename)
       ..fit = fit
       ..alignment = alignment
       ..animationName = animation
@@ -131,7 +178,7 @@ class FlareAnimationLayer {
 
 class FlareActorRenderObject extends FlareRenderBox {
   Mat2D _lastControllerViewTransform;
-  String _filename;
+  AssetProvider _assetProvider;
   String _artboardName;
   String _animationName;
   String _boundsNodeName;
@@ -248,14 +295,14 @@ class FlareActorRenderObject extends FlareRenderBox {
     _animationLayers.clear();
   }
 
-  String get filename => _filename;
-  set filename(String value) {
-    if (value == _filename) {
+  AssetProvider get assetProvider => _assetProvider;
+  set assetProvider(AssetProvider value) {
+    if (value == _assetProvider) {
       return;
     }
-    _filename = value;
+    _assetProvider = value;
 
-    if (_filename == null) {
+    if (_assetProvider == null) {
       markNeedsPaint();
     }
     // file will change, let's clear out old animations.
@@ -298,28 +345,28 @@ class FlareActorRenderObject extends FlareRenderBox {
 
   @override
   bool get canLoad {
-    return super.canLoad && _filename != null;
+    return super.canLoad && _assetProvider != null;
   }
 
-  /// Attempt a warm load, thfis is the optimal case when the
+  /// Attempt a warm load, this is the optimal case when the
   /// required asset is already in the cache.
   @override
   bool warmLoad() {
-    if (_filename == null) {
+    if (_assetProvider == null) {
       return false;
     }
-    _actor = getWarmFlare(_filename);
+    _actor = getWarmFlare(_assetProvider);
     return _instanceArtboard();
   }
 
-  /// Load the necessary Flare file specified by _filename.
+  /// Load the necessary Flare file specified by [AssetProvider].
   /// this occurs when the optimal warmLoad fails to find an asset in cache.
   @override
   Future<void> coldLoad() async {
-    if (_filename == null) {
+    if (_assetProvider == null) {
       return;
     }
-    _actor = await loadFlare(_filename);
+    _actor = await loadFlare(_assetProvider);
     _instanceArtboard();
   }
 

flare_flutter/lib/flare_cache.dart

@@ -1,13 +1,11 @@
 import 'dart:async';
-import 'package:flutter/services.dart';
 
-import 'asset_bundle_cache.dart';
+import 'asset_provider.dart';
+import 'cache.dart';
 import 'flare_cache_asset.dart';
 
-/// Cache that instances flare assets from ".flr" extension.
-class FlareCache extends AssetBundleCache<FlareCacheAsset> {
-  FlareCache(AssetBundle bundle) : super(bundle);
-
+/// Cache that instances Flare assets from ".flr" extension.
+class FlareCache extends Cache<FlareCacheAsset> {
   static bool doesPrune = true;
   static Duration pruneDelay = const Duration(seconds: 2);
 
@@ -18,24 +16,16 @@ class FlareCache extends AssetBundleCache<FlareCacheAsset> {
   Duration get pruneAfter => pruneDelay;
 
   @override
-  FlareCacheAsset makeAsset() {
-    return FlareCacheAsset();
-  }
+  FlareCacheAsset makeAsset() => FlareCacheAsset();
 }
 
-/// A mapping of loaded Flare assets.
-final Map<AssetBundle, FlareCache> _cache = {};
+/// Cache for loaded Flare assets.
+final _cache = FlareCache();
 
 /// Get a cached Flare actor, or load it if it's not yet available.
-Future<FlareCacheAsset> cachedActor(AssetBundle bundle, String filename) async {
-  FlareCache cache = _cache[bundle];
-  if (cache == null) {
-    _cache[bundle] = cache = FlareCache(bundle);
-  }
-  return cache.getAsset(filename);
-}
+Future<FlareCacheAsset> cachedActor(AssetProvider assetProvider) =>
+    _cache.getAsset(assetProvider);
 
 /// Get a warm Flare actor that's already in the cache.
-FlareCacheAsset getWarmActor(AssetBundle bundle, String filename) {
-  return _cache[bundle]?.getWarmAsset(filename);
-}
+FlareCacheAsset getWarmActor(AssetProvider assetProvider) =>
+    _cache.getWarmAsset(assetProvider);