tools.aqua.bgw.animation.DiceAnimation.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bgw-core Show documentation

A framework for board game applications.

There is a newer version: 0.5

/*
 *    Copyright 2021 The BoardGameWork Authors
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    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.
 */

@file:Suppress("unused")

package tools.aqua.bgw.animation

import tools.aqua.bgw.components.gamecomponentviews.DiceView
import tools.aqua.bgw.core.DEFAULT_ANIMATION_DURATION
import tools.aqua.bgw.core.DEFAULT_ANIMATION_SPEED

/**
 * A dice roll [Animation].
 *
 * Shuffles through die visuals for given [duration] and shows [toSide] in the end. Use the [speed] parameter
 * to define how many steps the animation should have.
 *
 * For example:
 *
 * An animation with [duration] = 1s and [speed] = 50 will change the visual 50 times within the [duration] of one
 * second.
 *
 * @constructor Creates a [DiceAnimation] for the given [DiceView].
 *
 * @param dice [DiceView] to animate.
 * @param toSide Resulting side after roll.
 * @param duration Duration in milliseconds. Default: [DEFAULT_ANIMATION_DURATION].
 * @param speed Count of steps. Default: [DEFAULT_ANIMATION_SPEED].
 */
class DiceAnimation(
	dice: T,
	val toSide: Int,
	duration: Int = DEFAULT_ANIMATION_DURATION,
	speed: Int = DEFAULT_ANIMATION_SPEED
) : SteppedComponentAnimation(componentView = dice, duration = duration, speed = speed)