divkit.dsl.ColorAnimator.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation
DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.
There is a newer version: 30.32.0
Show newest version
@file:Suppress(
    "unused",
    "UNUSED_PARAMETER",
)

package divkit.dsl

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Color animator.
 * 
 * Can be created using the method [colorAnimator].
 * 
 * Required parameters: `variable_name, type, id, end_value, duration`.
 */
@Generated
class ColorAnimator internal constructor(
    @JsonIgnore
    val properties: Properties,
) : Animator {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(
        mapOf("type" to "color_animator")
    )

    operator fun plus(additive: Properties): ColorAnimator = ColorAnimator(
        Properties(
            cancelActions = additive.cancelActions ?: properties.cancelActions,
            direction = additive.direction ?: properties.direction,
            duration = additive.duration ?: properties.duration,
            endActions = additive.endActions ?: properties.endActions,
            endValue = additive.endValue ?: properties.endValue,
            id = additive.id ?: properties.id,
            interpolator = additive.interpolator ?: properties.interpolator,
            repeatCount = additive.repeatCount ?: properties.repeatCount,
            startDelay = additive.startDelay ?: properties.startDelay,
            startValue = additive.startValue ?: properties.startValue,
            variableName = additive.variableName ?: properties.variableName,
        )
    )

    class Properties internal constructor(
        /**
         * Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
         */
        val cancelActions: Property>?,
        /**
         * Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
         * Default value: `normal`.
         */
        val direction: Property?,
        /**
         * Animation duration in milliseconds.
         */
        val duration: Property?,
        /**
         * Actions performed when the animator completes animation.
         */
        val endActions: Property>?,
        /**
         * Value that will be set at the end of animation.
         */
        val endValue: Property?,
        /**
         * Animator identificator
         */
        val id: Property?,
        /**
         * Interpolation function.
         * Default value: `linear`.
         */
        val interpolator: Property?,
        /**
         * The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
         * Default value: `1`.
         */
        val repeatCount: Property?,
        /**
         * Animation start delay in milliseconds.
         * Default value: `0`.
         */
        val startDelay: Property?,
        /**
         * Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
         */
        val startValue: Property?,
        /**
         * Name of the variable being animated.
         */
        val variableName: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("cancel_actions", cancelActions)
            result.tryPutProperty("direction", direction)
            result.tryPutProperty("duration", duration)
            result.tryPutProperty("end_actions", endActions)
            result.tryPutProperty("end_value", endValue)
            result.tryPutProperty("id", id)
            result.tryPutProperty("interpolator", interpolator)
            result.tryPutProperty("repeat_count", repeatCount)
            result.tryPutProperty("start_delay", startDelay)
            result.tryPutProperty("start_value", startValue)
            result.tryPutProperty("variable_name", variableName)
            return result
        }
    }
}

/**
 * @param cancelActions Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endActions Actions performed when the animator completes animation.
 * @param endValue Value that will be set at the end of animation.
 * @param id Animator identificator
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 * @param variableName Name of the variable being animated.
 */
@Generated
fun DivScope.colorAnimator(
    `use named arguments`: Guard = Guard.instance,
    cancelActions: List? = null,
    direction: AnimationDirection? = null,
    duration: Long? = null,
    endActions: List? = null,
    endValue: Color? = null,
    id: String? = null,
    interpolator: AnimationInterpolator? = null,
    repeatCount: Int? = null,
    startDelay: Int? = null,
    startValue: Color? = null,
    variableName: String? = null,
): ColorAnimator = ColorAnimator(
    ColorAnimator.Properties(
        cancelActions = valueOrNull(cancelActions),
        direction = valueOrNull(direction),
        duration = valueOrNull(duration),
        endActions = valueOrNull(endActions),
        endValue = valueOrNull(endValue),
        id = valueOrNull(id),
        interpolator = valueOrNull(interpolator),
        repeatCount = valueOrNull(repeatCount),
        startDelay = valueOrNull(startDelay),
        startValue = valueOrNull(startValue),
        variableName = valueOrNull(variableName),
    )
)

/**
 * @param cancelActions Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endActions Actions performed when the animator completes animation.
 * @param endValue Value that will be set at the end of animation.
 * @param id Animator identificator
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 * @param variableName Name of the variable being animated.
 */
@Generated
fun DivScope.colorAnimatorProps(
    `use named arguments`: Guard = Guard.instance,
    cancelActions: List? = null,
    direction: AnimationDirection? = null,
    duration: Long? = null,
    endActions: List? = null,
    endValue: Color? = null,
    id: String? = null,
    interpolator: AnimationInterpolator? = null,
    repeatCount: Int? = null,
    startDelay: Int? = null,
    startValue: Color? = null,
    variableName: String? = null,
) = ColorAnimator.Properties(
    cancelActions = valueOrNull(cancelActions),
    direction = valueOrNull(direction),
    duration = valueOrNull(duration),
    endActions = valueOrNull(endActions),
    endValue = valueOrNull(endValue),
    id = valueOrNull(id),
    interpolator = valueOrNull(interpolator),
    repeatCount = valueOrNull(repeatCount),
    startDelay = valueOrNull(startDelay),
    startValue = valueOrNull(startValue),
    variableName = valueOrNull(variableName),
)

/**
 * @param cancelActions Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endActions Actions performed when the animator completes animation.
 * @param endValue Value that will be set at the end of animation.
 * @param id Animator identificator
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 * @param variableName Name of the variable being animated.
 */
@Generated
fun TemplateScope.colorAnimatorRefs(
    `use named arguments`: Guard = Guard.instance,
    cancelActions: ReferenceProperty>? = null,
    direction: ReferenceProperty? = null,
    duration: ReferenceProperty? = null,
    endActions: ReferenceProperty>? = null,
    endValue: ReferenceProperty? = null,
    id: ReferenceProperty? = null,
    interpolator: ReferenceProperty? = null,
    repeatCount: ReferenceProperty? = null,
    startDelay: ReferenceProperty? = null,
    startValue: ReferenceProperty? = null,
    variableName: ReferenceProperty? = null,
) = ColorAnimator.Properties(
    cancelActions = cancelActions,
    direction = direction,
    duration = duration,
    endActions = endActions,
    endValue = endValue,
    id = id,
    interpolator = interpolator,
    repeatCount = repeatCount,
    startDelay = startDelay,
    startValue = startValue,
    variableName = variableName,
)

/**
 * @param cancelActions Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endActions Actions performed when the animator completes animation.
 * @param endValue Value that will be set at the end of animation.
 * @param id Animator identificator
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 * @param variableName Name of the variable being animated.
 */
@Generated
fun ColorAnimator.override(
    `use named arguments`: Guard = Guard.instance,
    cancelActions: List? = null,
    direction: AnimationDirection? = null,
    duration: Long? = null,
    endActions: List? = null,
    endValue: Color? = null,
    id: String? = null,
    interpolator: AnimationInterpolator? = null,
    repeatCount: Int? = null,
    startDelay: Int? = null,
    startValue: Color? = null,
    variableName: String? = null,
): ColorAnimator = ColorAnimator(
    ColorAnimator.Properties(
        cancelActions = valueOrNull(cancelActions) ?: properties.cancelActions,
        direction = valueOrNull(direction) ?: properties.direction,
        duration = valueOrNull(duration) ?: properties.duration,
        endActions = valueOrNull(endActions) ?: properties.endActions,
        endValue = valueOrNull(endValue) ?: properties.endValue,
        id = valueOrNull(id) ?: properties.id,
        interpolator = valueOrNull(interpolator) ?: properties.interpolator,
        repeatCount = valueOrNull(repeatCount) ?: properties.repeatCount,
        startDelay = valueOrNull(startDelay) ?: properties.startDelay,
        startValue = valueOrNull(startValue) ?: properties.startValue,
        variableName = valueOrNull(variableName) ?: properties.variableName,
    )
)

/**
 * @param cancelActions Actions performed when the animator is cancelled. For example, when an action with `animator_stop` type is received
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endActions Actions performed when the animator completes animation.
 * @param endValue Value that will be set at the end of animation.
 * @param id Animator identificator
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 * @param variableName Name of the variable being animated.
 */
@Generated
fun ColorAnimator.defer(
    `use named arguments`: Guard = Guard.instance,
    cancelActions: ReferenceProperty>? = null,
    direction: ReferenceProperty? = null,
    duration: ReferenceProperty? = null,
    endActions: ReferenceProperty>? = null,
    endValue: ReferenceProperty? = null,
    id: ReferenceProperty? = null,
    interpolator: ReferenceProperty? = null,
    repeatCount: ReferenceProperty? = null,
    startDelay: ReferenceProperty? = null,
    startValue: ReferenceProperty? = null,
    variableName: ReferenceProperty? = null,
): ColorAnimator = ColorAnimator(
    ColorAnimator.Properties(
        cancelActions = cancelActions ?: properties.cancelActions,
        direction = direction ?: properties.direction,
        duration = duration ?: properties.duration,
        endActions = endActions ?: properties.endActions,
        endValue = endValue ?: properties.endValue,
        id = id ?: properties.id,
        interpolator = interpolator ?: properties.interpolator,
        repeatCount = repeatCount ?: properties.repeatCount,
        startDelay = startDelay ?: properties.startDelay,
        startValue = startValue ?: properties.startValue,
        variableName = variableName ?: properties.variableName,
    )
)

/**
 * @param direction Animation direction. This property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
 * @param duration Animation duration in milliseconds.
 * @param endValue Value that will be set at the end of animation.
 * @param interpolator Interpolation function.
 * @param repeatCount The number of times the animation will repeat before it finishes. `0` enables infinite repeats.
 * @param startDelay Animation start delay in milliseconds.
 * @param startValue Value that will be set at the start of animation. Can be omitted, in which case current value of the variable will be used.
 */
@Generated
fun ColorAnimator.evaluate(
    `use named arguments`: Guard = Guard.instance,
    direction: ExpressionProperty? = null,
    duration: ExpressionProperty? = null,
    endValue: ExpressionProperty? = null,
    interpolator: ExpressionProperty? = null,
    repeatCount: ExpressionProperty? = null,
    startDelay: ExpressionProperty? = null,
    startValue: ExpressionProperty? = null,
): ColorAnimator = ColorAnimator(
    ColorAnimator.Properties(
        cancelActions = properties.cancelActions,
        direction = direction ?: properties.direction,
        duration = duration ?: properties.duration,
        endActions = properties.endActions,
        endValue = endValue ?: properties.endValue,
        id = properties.id,
        interpolator = interpolator ?: properties.interpolator,
        repeatCount = repeatCount ?: properties.repeatCount,
        startDelay = startDelay ?: properties.startDelay,
        startValue = startValue ?: properties.startValue,
        variableName = properties.variableName,
    )
)

@Generated
fun ColorAnimator.asList() = listOf(this)