Stroke order animations and quizzes for Chinese characters for use in Flutter apps

Last update: Dec 27, 2022

Related tags

Overview

Stroke order animator

This package implements stroke order animations and quizzes of Chinese characters based on the Make me a Hanzi data. That data is available under the ARPHIC public license.

The package uses a StrokeOrderAnimationController that handles the animation state and serves as an interface between your app and the stroke order animation. The stroke order data has to be passed in as a JSON string. In order to control animations, a TickerProvider must be passed to the controller, for example using a TickerProviderStateMixin. The controller is then passed as an argument to the StrokeOrderAnimator that displays the actual stroke order diagram.

When using the animations in a PageView or ListView, it is recommended to use a unique key for every StrokeOrderAnimator and cancel the animation when the selected page changes in order to avoid broken animation behaviour.

All attributes and actions of the stroke order diagram are controlled via the StrokeOrderAnimationController and can be changed anytime using the respective setter methods.

Attributes

Animation speed of stroke animations and hints in quiz mode (3 is pretty fast)
Whether to show/hide strokes
Whether to show/hide outlines
Whether to show/hide medians
Whether to show/hide the correct strokes the user writes during a quiz
Whether to highlight radicals
Stroke color
Outline color
Median color
Radical color
Brush color in quiz mode
Brush thickness in quiz mode
Number of wrong strokes before showing a hint in quiz mode
Hint color in quiz mode

Controls

Start/stop animation
Start/stop quiz
Show next/previous stroke
Show full character
Reset animation/quiz

Callbacks

To better integrate the quizzes, three callbacks can be either passed to the StrokeOrderAnimationController during instantiation or afterwards using the add...Callback method:

onWrongStrokeCallback
onCorrectStrokeCallback
onQuizCompleteCallback

The onQuizCompleteCallback receives a Quizsummary containing the number of mistakes on a per-stroke basis and the paths of the correct strokes (in a 1024x1024 coordinate system). The other two callbacks receive the index of the stroke that was written (in-)correctly. All indices are zero-based.

Example

To run an example showing several stroke order diagrams in a swipeable page view run the following:

git clone https://github.com/Mr-Pepe/stroke-order-animator
cd stroke-order-animator/example/
flutter run

Issues and feature requests

Please file an issue on the project page if something doesn't work as expected or if you have a feature request.

Contribute

Feel free to open a pull request. Just make sure to write extensive tests.

Comments

keeping the hand writing of user made

Hi, This is a nice to have feature, can Stroke-order-animator keep the correct paths of a user actually draw? this might be used to show to the user his actual hand writing. thanks

opened by sqllyw 5
Pressing blank space should not be counted as mistake

as the subject line,

A sample here: https://hanziwriter.org/docs.html go to Integrating Quizzes the testing character is 码, if press blank space, it will not count as mistake

opened by sqllyw 4
Use strokOrder instead of _strokeOrder

Line 365 in strokeOrderAnimationController.dart file void setStrokeOrder(String strokeOrder) { final parsedJson = json.decode(_strokeOrder.replaceAll("'", '"')); }

Could it use strokOrder instead of _strokeOrder? Plz void setStrokeOrder(String strokeOrder) { final parsedJson = json.decode(strokeOrder.replaceAll("'", '"')); }

I'd like to change strokeOrder after I get data from internet.

opened by Aaron2464 2
mistake count in onQuizCompleteCallback

hi, if mistake is in the same stroke, should be counted once, the example 永 has five strokes, if i make 10 mistakes in the first stroke, then the summary will show 10 mistakes, could be better to count only 1 stroke mistake. thanks

opened by sqllyw 1
Normalize animation speed

Currently all strokes take the same time to animate, which makes short strokes look very slow and long strokes look very fast. The animation speed for each stroke should be scaled according to the stroke length to get the impression of a constant drawing speed.

opened by Mr-Pepe 1
Wrong Strokes highlight

i thing there should be the option to show the wrong stroke with hint in quiz portion. Like we can show the wrong stroke with red colour and can also show the hint to user.

opened by varnica4 2

Stroke order animations and quizzes for Chinese characters for use in Flutter apps

Related tags

Overview

Stroke order animator

Attributes

Controls

Callbacks

Example

Issues and feature requests

Contribute

Comments

keeping the hand writing of user made

Pressing blank space should not be counted as mistake

Use strokOrder instead of _strokeOrder

mistake count in onQuizCompleteCallback

Normalize animation speed

Wrong Strokes highlight

Owner

Felipe Peter

A flutter application that allows users to test their knowledge through quizzes made for specific topics.

Multi-platform application to practice quizzes from the course Operations Research M.

This application displays the characters of the series Breaking Bad, has been used Cubit state and API .

Example de layout in Flutter inspiration in Netflix App + Woody Woodpecker Characters

Dart / Flutter package, which replaces characters in strings that are illegal/unsafe for filenames.

Redditech: use the Reddit API in order to build a mobile app

A customizable carousel slider for Flutter. Supports infinite sliding, custom indicators, and custom animations with many pre-built indicators and animations.

🚗 Apple CarPlay for Flutter Apps. Aims to make it safe to use apps made with Flutter in the car by integrating with CarPlay.

Face Mask Detection mobile application built with Flutter and TensorFlow lite in order to detect face masks using images and live camera.

A flutter list view which can drag & move item to change order.

My flutter (android, ios) UI design examples 🎈 - user profile UIs, food order ui, splashscreen, mask widget usage, settings page ui

Csv to list for web - Convert a CSV into a list in order to populate a firebase database

Practice building basic animations in apps along with managing app state by BLoC State Management, Flutter Slider.

Github-apps-flutter - Github Apps Build Using bloc 8.0 and Github API

[Example APPS] Basic Flutter apps, for flutter devs.

Flutter-Apps-Collection: a collection of apps made in flutter for learning purpose

Projeto do curso Criação de Apps Android e iOS com Flutter 2021-Crie 14 Apps. Professor: Daniel Ciolfi

Projeto do curso Criação de Apps Android e iOS com Flutter 2021-Crie 14 Apps. Professor: Daniel Ciolfi