A framer.js DHO and RK4 spring animation port for Android. 4 | 5 | ### Features 6 | * Extends from `Animator`, providing a familiar API to use 7 | * Provides **DHO** and **RK4** algorithm from Framer.js 8 | * Bundled playground app, fine-tuning made easy 9 | 10 | ## Demo 11 | Checkout the playground here: [playground.apk](https://github.com/unixzii/android-SpringAnimator/releases/download/0.1.0-alpha1/playground.apk) 12 | 13 |
14 |
15 | ## Requirements
16 | SpringAnimator requires API 16 or higher.
17 |
18 | ## Download
19 | Gradle:
20 | ```groovy
21 | repositories {
22 | jcenter()
23 | }
24 |
25 | dependencies {
26 | compile 'me.cyandev:springanimator:0.1.0-alpha1'
27 | }
28 | ```
29 |
30 | Find out more releases [here](https://github.com/unixzii/android-SpringAnimator/releases).
31 |
32 | ## Get Started
33 | ```java
34 | DhoSpringAnimator animator = new DhoSpringAnimator();
35 | animator.setStiffness(200);
36 | animator.setDamping(10);
37 | animator.setMass(1);
38 | animator.setVelocity(0);
39 | animator.addUpdateListener(new AbsSpringAnimator.AnimatorUpdateListener() {
40 | @Override
41 | public void onAnimationUpdate(AbsSpringAnimator animation) {
42 | // Do something cool here...
43 | }
44 | });
45 | animator.start();
46 | ```
47 |
48 | Parameters are fully matched with Frame.js.
49 |
50 | ## Acknowledgement
51 | Thanks [koenbok](https://github.com/koenbok)/[Framer](https://github.com/koenbok/Framer) for providing original algorithms.
52 |
53 | Thanks [MartinRGB](https://github.com/MartinRGB) for designing user interface of the playground app and providing graphical resources.
54 |
55 | ## License
56 | ```
57 | Copyright 2017 Cyandev
58 |
59 | Licensed under the Apache License, Version 2.0 (the "License");
60 | you may not use this file except in compliance with the License.
61 | You may obtain a copy of the License at
62 |
63 | http://www.apache.org/licenses/LICENSE-2.0
64 |
65 | Unless required by applicable law or agreed to in writing, software
66 | distributed under the License is distributed on an "AS IS" BASIS,
67 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
68 | See the License for the specific language governing permissions and
69 | limitations under the License.
70 | ```
71 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/item_simple.xml:
--------------------------------------------------------------------------------
1 |
2 |
17 |
18 | 22 | * Reference: 23 | * See 24 | * https://github.com/koenbok/Framer/blob/master/framer/Animators/SpringDHOAnimator.coffee 25 | */ 26 | public class DhoSpringAnimator extends AbsSpringAnimator { 27 | 28 | private float mVelocity = 0; 29 | private float mTolerance = 1 / 10000.f; 30 | private float mStiffness = 120; 31 | private float mDamping = 5; 32 | private float mMass = 1; 33 | 34 | private boolean mIsFirstFrame = true; 35 | private float mValue = 0; 36 | private double mCurrentVelocity = 0; 37 | 38 | public float getVelocity() { 39 | return mVelocity; 40 | } 41 | 42 | public void setVelocity(float velocity) { 43 | mVelocity = velocity; 44 | } 45 | 46 | public float getTolerance() { 47 | return mTolerance; 48 | } 49 | 50 | public void setTolerance(float tolerance) { 51 | mTolerance = tolerance; 52 | } 53 | 54 | public float getStiffness() { 55 | return mStiffness; 56 | } 57 | 58 | public void setStiffness(float stiffness) { 59 | mStiffness = stiffness; 60 | } 61 | 62 | public float getDamping() { 63 | return mDamping; 64 | } 65 | 66 | public void setDamping(float damping) { 67 | mDamping = damping; 68 | } 69 | 70 | public float getMass() { 71 | return mMass; 72 | } 73 | 74 | public void setMass(float mass) { 75 | mMass = mass; 76 | } 77 | 78 | @Override 79 | protected long computeSettleDuration() { 80 | // TODO: Not implemented. 81 | return 0; 82 | } 83 | 84 | @Override 85 | protected void resetState() { 86 | mIsFirstFrame = true; 87 | mValue = 0; 88 | mCurrentVelocity = mVelocity; 89 | } 90 | 91 | @Override 92 | protected float enterFrame(long frameTime) { 93 | final float delta = Math.max(frameTime / 1000.f, 0.016f); 94 | 95 | // A trick to avoid jitter when frames dropped. 96 | // FIXME: Still encounter jitter sometimes... 97 | if (delta >= 0.024) { 98 | float last = 0; 99 | for (int i = 0, j = (int) Math.floor(delta / 0.016); i < j; i++) { 100 | last = enterFrame(16); 101 | } 102 | return last; 103 | } 104 | 105 | if (isFinished()) { 106 | return 1.f; 107 | } 108 | 109 | double k = 0 - mStiffness; 110 | double b = 0 - mDamping; 111 | 112 | double fSpring = k * (mValue - 1); 113 | double fDamper = b * mCurrentVelocity; 114 | 115 | mCurrentVelocity += ((fSpring + fDamper) / mMass) * delta; 116 | mValue += mCurrentVelocity * delta; 117 | 118 | mIsFirstFrame = false; 119 | 120 | return mValue; 121 | } 122 | 123 | protected boolean isFinished() { 124 | return (!mIsFirstFrame && Math.abs(mCurrentVelocity) < mTolerance); 125 | } 126 | 127 | } 128 | -------------------------------------------------------------------------------- /.idea/markdown-navigator.xml: -------------------------------------------------------------------------------- 1 | 2 |
25 | * Reference: 26 | * See 27 | * https://github.com/koenbok/Framer/blob/master/framer/Animators/SpringRK4Animator.coffee 28 | */ 29 | public class Rk4SpringAnimator extends AbsSpringAnimator { 30 | 31 | private static SparseArray
Notifies the occurrence of another frame of the animation.
350 | * 351 | * @param animation The animation which was repeated. 352 | */ 353 | void onAnimationUpdate(AbsSpringAnimator animation); 354 | 355 | } 356 | 357 | } 358 | 359 | 360 | -------------------------------------------------------------------------------- /app/src/main/java/me/cyandev/springanimatordemo/MainActivity.java: -------------------------------------------------------------------------------- 1 | package me.cyandev.springanimatordemo; 2 | 3 | import android.animation.Animator; 4 | import android.animation.ValueAnimator; 5 | import android.os.Build; 6 | import android.os.Bundle; 7 | 8 | import com.google.android.material.floatingactionbutton.FloatingActionButton; 9 | import androidx.fragment.app.Fragment; 10 | import androidx.fragment.app.FragmentManager; 11 | import androidx.fragment.app.FragmentPagerAdapter; 12 | import androidx.viewpager.widget.ViewPager; 13 | import androidx.interpolator.view.animation.FastOutLinearInInterpolator; 14 | import androidx.interpolator.view.animation.FastOutSlowInInterpolator; 15 | import androidx.appcompat.app.AppCompatActivity; 16 | import androidx.appcompat.widget.AppCompatSpinner; 17 | import androidx.appcompat.widget.Toolbar; 18 | import android.transition.Slide; 19 | import android.util.SparseArray; 20 | import android.util.TypedValue; 21 | import android.view.Gravity; 22 | import android.view.Menu; 23 | import android.view.MenuItem; 24 | import android.view.MotionEvent; 25 | import android.view.View; 26 | import android.view.ViewGroup; 27 | import android.view.ViewTreeObserver; 28 | import android.widget.AdapterView; 29 | import android.widget.ArrayAdapter; 30 | import android.widget.FrameLayout; 31 | 32 | import java.util.ArrayList; 33 | 34 | import me.cyandev.springanimator.AbsSpringAnimator; 35 | import me.cyandev.springanimatordemo.adjustment.BaseAdjustmentFragment; 36 | import me.cyandev.springanimatordemo.adjustment.DhoAdjustmentFragment; 37 | import me.cyandev.springanimatordemo.adjustment.Rk4AdjustmentFragment; 38 | import me.cyandev.springanimatordemo.preview.BasePreviewFragment; 39 | import me.cyandev.springanimatordemo.preview.RecyclerViewPreviewFragment; 40 | import me.cyandev.springanimatordemo.preview.TranslationPreviewFragment; 41 | import me.cyandev.springanimatordemo.util.SimpleAnimatorListener; 42 | 43 | public class MainActivity extends AppCompatActivity 44 | implements BasePreviewFragment.SpringAnimatorProvider, BaseAdjustmentFragment.OnAdjustmentCommitListener { 45 | 46 | private static final String TAG = "MainActivity"; 47 | private static final String KEY_CURRENT_CONFIGURATION = TAG + "_currentConfiguration"; 48 | private static final String KEY_SELECTED_ADJUSTMENT = TAG + "_selectedAdjustment"; 49 | 50 | private static final Class[] PREVIEW_FRAGMENT_CLASSES = { 51 | TranslationPreviewFragment.class, 52 | RecyclerViewPreviewFragment.class 53 | }; 54 | 55 | private static final String[][] ADJUSTMENT_METADATA = { 56 | { "Spring - DHO", DhoAdjustmentFragment.class.getName() }, 57 | { "Spring - RK4", Rk4AdjustmentFragment.class.getName() } 58 | }; 59 | 60 | private FloatingActionButton mFab; 61 | private ViewPager mPager; 62 | private ViewGroup mPanelLayout; 63 | private AppCompatSpinner mAdjustmentTypeSpinner; 64 | private FrameLayout mPanelContainer; 65 | 66 | private Bundle mCurrentConfiguration; 67 | 68 | private boolean mPanelClosed = false; 69 | private int mSelectedAdjustment = 0; 70 | 71 | @SuppressWarnings("unchecked") 72 | @Override 73 | protected void onCreate(Bundle savedInstanceState) { 74 | super.onCreate(savedInstanceState); 75 | setContentView(R.layout.activity_main); 76 | 77 | setSupportActionBar((Toolbar) findViewById(R.id.toolbar)); 78 | 79 | mFab = (FloatingActionButton) findViewById(R.id.fab); 80 | mPager = (ViewPager) findViewById(R.id.pager); 81 | mPanelLayout = (ViewGroup) findViewById(R.id.panel_layout); 82 | mAdjustmentTypeSpinner = (AppCompatSpinner) findViewById(R.id.spinner); 83 | mPanelContainer = (FrameLayout) findViewById(R.id.container2); 84 | 85 | mFab.setOnClickListener(new View.OnClickListener() { 86 | @Override 87 | public void onClick(View v) { 88 | openAdjustmentPanel(); 89 | } 90 | }); 91 | 92 | mPager.setAdapter(new PreviewPagerAdapter(getSupportFragmentManager())); 93 | 94 | mPanelLayout.setOnTouchListener(new View.OnTouchListener() { 95 | @Override 96 | public boolean onTouch(View v, MotionEvent event) { 97 | // Eat the event to prevent touching through. 98 | return true; 99 | } 100 | }); 101 | 102 | setupSpinner(); 103 | 104 | if (savedInstanceState == null) { 105 | mCurrentConfiguration = ConfigurationResolver.buildDhoConfiguration(200, 10, 1, 0); 106 | mPager.postDelayed(new Runnable() { 107 | @Override 108 | public void run() { 109 | peekPager(); 110 | } 111 | }, 1500); 112 | } 113 | } 114 | 115 | @Override 116 | protected void onStart() { 117 | super.onStart(); 118 | 119 | // Hide the panel for a while if it's not opened. 120 | if (!isAdjustmentPanelVisible()) { 121 | mPanelLayout.setVisibility(View.INVISIBLE); 122 | } 123 | } 124 | 125 | @Override 126 | public boolean onCreateOptionsMenu(Menu menu) { 127 | getMenuInflater().inflate(R.menu.activity_main, menu); 128 | 129 | return true; 130 | } 131 | 132 | @Override 133 | public boolean onOptionsItemSelected(MenuItem item) { 134 | switch (item.getItemId()) { 135 | case 0 /* placeholder */: 136 | break; 137 | default: 138 | return super.onOptionsItemSelected(item); 139 | } 140 | 141 | return true; 142 | } 143 | 144 | @Override 145 | protected void onSaveInstanceState(Bundle outState) { 146 | super.onSaveInstanceState(outState); 147 | 148 | outState.putBundle(KEY_CURRENT_CONFIGURATION, mCurrentConfiguration); 149 | outState.putInt(KEY_SELECTED_ADJUSTMENT, mSelectedAdjustment); 150 | } 151 | 152 | @Override 153 | protected void onRestoreInstanceState(Bundle savedInstanceState) { 154 | super.onRestoreInstanceState(savedInstanceState); 155 | 156 | mCurrentConfiguration = savedInstanceState.getBundle(KEY_CURRENT_CONFIGURATION); 157 | mSelectedAdjustment = savedInstanceState.getInt(KEY_SELECTED_ADJUSTMENT); 158 | } 159 | 160 | @Override 161 | public void onBackPressed() { 162 | if (closeAdjustmentPanel()) { 163 | return; 164 | } 165 | 166 | super.onBackPressed(); 167 | } 168 | 169 | private void setupSpinner() { 170 | ArrayList