tools.aqua.bgw.components.gamecomponentviews.DiceView.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.components.gamecomponentviews

import tools.aqua.bgw.core.DEFAULT_DICE_HEIGHT
import tools.aqua.bgw.core.DEFAULT_DICE_WIDTH
import tools.aqua.bgw.observable.ObservableArrayList
import tools.aqua.bgw.visual.Visual

/**
 * A [DiceView] may be used to visualize a dice.
 *
 * Visualization:
 *
 * The Visual at the [currentSide] value is used to visualize the dice.
 *
 * @constructor Creates a [DiceView] with given [Visual]s.
 *
 * @param posX Horizontal coordinate for this [DiceView]. Default: 0.
 * @param posY Vertical coordinate for this [DiceView]. Default: 0.
 * @param width Width for this [DiceView]. Default: [DEFAULT_DICE_WIDTH].
 * @param height Height for this [DiceView]. Default: [DEFAULT_DICE_HEIGHT].
 * @param visuals List of visuals to represent the sides of the die.
 */
open class DiceView(
	posX: Number = 0,
	posY: Number = 0,
	width: Number = DEFAULT_DICE_WIDTH,
	height: Number = DEFAULT_DICE_HEIGHT,
	visuals: List
) : GameComponentView(posX = posX, posY = posY, width = width, height = height, visual = Visual.EMPTY) {
	
	/**
	 * [Visual]s for this [DiceView].
	 */
	internal val visuals: ObservableArrayList = ObservableArrayList(visuals.onEach { it.copy() })
	
	/**
	 * Current side that is displayed, 0-based.
	 *
	 * @throws IllegalArgumentException If index is greater than the amount of visuals stored in [visuals] or negative.
	 */
	var currentSide: Int = 0
		set(value) {
			if (field != value) {
				require(value in visuals.indices) { "No visual for side $value available." }
				
				field = value
				visualProperty.value = visuals[value]
			}
		}
	
	override var visual: Visual
		get() = super.visual
		set(_){
			throw UnsupportedOperationException("Setting a single Visual for a DiceView is not supported. " +
					"Use `visuals` setter instead.")
		}
	
	init {
		visualProperty.value = if (visuals.isNotEmpty())
			visuals.first()
		else
			Visual.EMPTY
	}
	
	/**
	 * Sets all visuals for this DiceView.
	 * Clears old visuals.
	 * All [visuals] get copied before being added.
	 * If [currentSide] is out of range, a [Visual.EMPTY] will be shown.
	 */
	fun setVisuals(visuals: List) {
		val snapshot = visuals.toList()
		this.visuals.setSilent(visuals.onEach { it.copy() })
		this.visuals.notifyChange(oldValue = snapshot, newValue = visuals.toList())
		
		visualProperty.value = if (currentSide in visuals.indices)
			visuals[currentSide]
		else
			Visual.EMPTY
	}
}