Cleanup and better README for Teddy

Author: umberto-sonnino

example/teddy/README.md

@@ -1,16 +1,41 @@
-# teddy
+# Teddy
 
-A new Flutter project.
+<img align="right" src="https://i.imgur.com/hJU9Obt.gif" height="250">
 
-## Getting Started
+An example built using [JCToon's](https://www.2dimensions.com/a/JuanCarlos/files/flare/teddy/preview) Flare File as a custom UI component. <br/>
+Teddy will follow the cursor as you type or move it around.
 
-This project is a starting point for a Flutter application.
+## Overview
 
-A few resources to get you started if this is your first Flutter project:
+The basic idea is to use the `ctrl_face` node in JCToon's file to change the direction of Teddy's gaze, as it's shown here in the gif to the right.
 
-- [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
+This is done by using [custom `FlareControls`](lib/teddy_controller.dart), available in `/lib/teddy_controller.dart`.
+
+`FlareControls` is a custom implementation of the `FlareController` interface. <br/>The interface and can be found in [flare_actor.dart](../../lib/flare_actor.dart#L13-L17) and it has three methods:
+
+```
+abstract class FlareController {
+  void initialize(FlutterActorArtboard artboard);
+  void setViewTransform(Mat2D viewTransform);
+  bool advance(FlutterActorArtboard artboard, double elapsed);
+}
+```
+
+<img align="right" src="https://i.imgur.com/WdjurVo.gif" width="300" />
+
+An instance of `TeddyController` is passed to the `FlareActor` in [`/lib/main.dart`](lib/main.dart#L77). This ties the controller to this widget, and allows it to use the three overrides to perform custom actions:
+
+```
+FlareActor(
+    "assets/Teddy.flr",
+    controller: _teddyController,
+    [...]
+)
+```
+
+In this example, `initialize()` will grab the reference to the `ctrl_face` node through the library call `artboard.getNode("ctrl_face")`. 
+
+Moreover, by [extending `FlareControls`](../../lib/flare_actor.dart#L462), `TeddyController` can take advantage of a concrete implementation of this interface:
+- `play(String animationName)`
+- `advance(double elapsed)` - a base implementation which advances and mixes multiple animations
 
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.io/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.

example/teddy/lib/main.dart

@@ -8,21 +8,11 @@ import 'package:teddy/tracking_text_input.dart';
 void main() => runApp(MyApp());
 
 class MyApp extends StatelessWidget {
-  // This widget is the root of your application.
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
       title: 'Flutter Demo',
       theme: ThemeData(
-        // This is the theme of your application.
-        //
-        // Try running your application with "flutter run". You'll see the
-        // application has a blue toolbar. Then, without quitting the app, try
-        // changing the primarySwatch below to Colors.green and then invoke
-        // "hot reload" (press "r" in the console where you ran "flutter run",
-        // or simply save your changes to "hot reload" in a Flutter IDE).
-        // Notice that the counter didn't reset back to zero; the application
-        // is not restarted.
         primarySwatch: Colors.blue,
       ),
       home: MyHomePage(title: 'Flutter Demo Home Page'),
@@ -33,15 +23,6 @@ class MyApp extends StatelessWidget {
 class MyHomePage extends StatefulWidget {
   MyHomePage({Key key, this.title}) : super(key: key);
 
-  // This widget is the home page of your application. It is stateful, meaning
-  // that it has a State object (defined below) that contains fields that affect
-  // how it looks.
-
-  // This class is the configuration for the state. It holds the values (in this
-  // case the title) provided by the parent (in this case the App widget) and
-  // used by the build method of the State. Fields in a Widget subclass are
-  // always marked "final".
-
   final String title;
 
   @override
@@ -58,12 +39,6 @@ class _MyHomePageState extends State<MyHomePage> {
 
   @override
   Widget build(BuildContext context) {
-    // This method is rerun every time setState is called, for instance as done
-    // by the _incrementCounter method above.
-    //
-    // The Flutter framework has been optimized to make rerunning build methods
-    // fast, so that you can just rebuild anything that needs updating rather
-    // than having to individually change instances of widgets.
     EdgeInsets devicePadding = MediaQuery.of(context).padding;
 
     return Scaffold(
@@ -101,11 +76,12 @@ class _MyHomePageState extends State<MyHomePage> {
                           height: 200,
                           child: FlareActor(
                             "assets/Teddy.flr",
+                            controller: _teddyController,
 							shouldClip: false,
                             alignment: Alignment.center,
-                            fit: BoxFit.contain,
-                            controller: _teddyController,
-                          )),
+                            fit: BoxFit.contain
+                          )
+                        ),
                       Container(
                           decoration: BoxDecoration(
                               color: Colors.white,
@@ -118,12 +94,6 @@ class _MyHomePageState extends State<MyHomePage> {
                               mainAxisAlignment: MainAxisAlignment.center,
                               crossAxisAlignment: CrossAxisAlignment.center,
                               children: <Widget>[
-                                // Row(
-                                //     mainAxisAlignment: MainAxisAlignment.center,
-                                //     children: <Widget>[
-                                //         Lurker(this._fieldPosition, TextSpan(text: this._textValue))
-                                //     ],
-                                // ),
                                 TrackingTextInput(
                                     label: "Email",
                                     hint: "What's your email address?",

example/teddy/lib/teddy_controller.dart

@@ -69,10 +69,10 @@ class TeddyController extends FlareControls {
 
     _faceControl.translation = frameTranslation;
 
-    //_originalPosition = Vec2D.clone(_faceControl.translation);
     return true;
   }
 
+  // Fetch references for the `ctrl_face` node and store a copy of its original translation.
   @override
   void initialize(FlutterActorArtboard artboard) {
     super.initialize(artboard);
@@ -88,11 +88,15 @@ class TeddyController extends FlareControls {
     play("idle");
   }
 
+  // Called every frame by the wrapping [FlareActor].
+  // Keep updating the matrix that transforms Global-Flutter-coordinates into Flare-World-coordinates.
   @override
   void setViewTransform(Mat2D viewTransform) {
     Mat2D.invert(_globalToFlareWorld, viewTransform);
   }
 
+  // Transform the [Offset] into a [Vec2D].
+  // If no caret is provided, lower the [_hasFocus] flag.
   void lookAt(Offset caret) {
     if (caret == null) {
       _hasFocus = false;

example/teddy/pubspec.yaml

@@ -1,12 +1,6 @@
 name: teddy
 description: A new Flutter project.
 
-# The following defines the version and build number for your application.
-# A version number is three numbers separated by dots, like 1.2.43
-# followed by an optional build number separated by a +.
-# Both the version and the builder number may be overridden in flutter
-# build by specifying --build-name and --build-number, respectively.
-# Read more about versioning at semver.org.
 version: 1.0.0+1
 
 environment:
@@ -18,24 +12,15 @@ dependencies:
   flare_flutter:
     path: ../../
 
-  # The following adds the Cupertino Icons font to your application.
-  # Use with the CupertinoIcons class for iOS style icons.
   cupertino_icons: ^0.1.2
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
 
 
-# For information on the generic Dart part of this file, see the
-# following page: https://www.dartlang.org/tools/pub/pubspec
-
-# The following section is specific to Flutter.
 flutter:
 
-  # The following line ensures that the Material Icons font is
-  # included with your application, so that you can use the icons in
-  # the material Icons class.
   uses-material-design: true
   fonts:
     - family: RobotoMedium