commonMain.com.lt.compose_views.util.MAnimator.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ComposeViews Show documentation
Jatpack(JetBrains) Compose views
There is a newer version: 1.6.11.4
/*
 * Copyright lt 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.lt.compose_views.util

import androidx.compose.animation.core.AnimationConstants
import androidx.compose.runtime.ExperimentalComposeApi
import androidx.compose.runtime.MutableState
import androidx.compose.runtime.monotonicFrameClock
import com.lt.data_structure.util._currentTimeMillis
import kotlin.coroutines.coroutineContext
import kotlin.math.pow

/**
 * creator: lt  2022/7/31  [email protected]
 * effect : 自定义的动画播放器,逻辑更简单
 *          Easier animation usage
 * warning: 推荐使用系统的动画api
 *          It is recommended to use the system api
 * @param initialValueWithState 动画要改变的状态,起始动画值为其value值
 *                              The [State] to be changed by the animation
 * @param targetValue 要通过动画转化到的目标值
 *                    Target value
 * @param duration 动画的持续时间
 *                 duration
 * @param animInterpolator 动画差值器
 *                         Animation interpolator
 */
suspend fun animateWithFloat(
    initialValueWithState: MutableState,
    targetValue: Float,
    duration: Int = AnimationConstants.DefaultDurationMillis,
    animInterpolator: MAnimInterpolator = DecelerateInterpolator(),
) {
    animateWithFloat(
        initialValueWithState.value,
        targetValue,
        duration,
        animInterpolator,
        initialValueWithState::value::set
    )
}

@OptIn(ExperimentalComposeApi::class)
suspend inline fun animateWithFloat(
    startValue: Float,
    targetValue: Float,
    duration: Int = AnimationConstants.DefaultDurationMillis,
    animInterpolator: MAnimInterpolator = DecelerateInterpolator(),
    crossinline onValueChange: (Float) -> Unit,
) {
    val valueToBeTransformed = targetValue - startValue
    val startTime = _currentTimeMillis()
    val duration = duration.toLong()
    val frameClock = coroutineContext.monotonicFrameClock
    while (_currentTimeMillis() <= startTime + duration) {
        frameClock.withFrameNanos {
            val progress = animInterpolator.getInterpolation(
                minOf(it - startTime, duration).toFloat() / duration
            )
            val increase = progress * valueToBeTransformed
            onValueChange(startValue + increase)
        }
    }
    onValueChange(targetValue)
}

/**
 * 动画差值器
 * Animation interpolator
 */
fun interface MAnimInterpolator {
    /**
     * 根据输入的动画进度[input]计算动画进度
     * Calculate the animation progress based on the input animation progress [input]
     */
    fun getInterpolation(input: Float): Float
}

/**
 * An interpolator where the rate of change starts out quickly and and then decelerates.
 * ps:参考[DecelerateInterpolator],先快后慢
 * [mFactor]Degree to which the animation should be eased. Setting factor to 1.0f produces an upside-down y=x^2 parabola. Increasing factor above 1.0f exaggerates the ease-out effect (i.e., it starts even faster and ends evens slower).
 */
class DecelerateInterpolator(private val mFactor: Float = 1.0f) : MAnimInterpolator {
    override fun getInterpolation(input: Float): Float {
        return if (mFactor == 1.0f) {
            (1.0f - (1.0f - input) * (1.0f - input))
        } else {
            (1.0f - (1.0f - input).toDouble().pow((2 * mFactor).toDouble())).toFloat()
        }
    }
}

/**
 * An interpolator where the rate of change is constant
 */
class LinearInterpolator() : MAnimInterpolator {
    override fun getInterpolation(input: Float): Float = input
}