tools.aqua.bgw.visual.ImageVisual.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.visual

import tools.aqua.bgw.observable.properties.Property
import java.awt.Image
import java.awt.image.BufferedImage
import java.io.File
import javax.imageio.ImageIO

/**
 * Visual showing an [Image].
 *
 * The image gets stretched to the size of the component that this visual is embedded in.
 *
 * A sub-image can be loaded by passing offsetX/offsetY for the TOP_LEFT corner and width/height for the sub-image size.
 * If width or height is passed as -1, the remaining image from offsetX/offsetY will be loaded.
 *
 * @constructor Loads an [ImageVisual] from a [BufferedImage].
 *
 * @param image Image to show.
 * @param width Width of sub-image. Pass -1 to use full width. Default: -1.
 * @param height Height of sub-image. Pass -1 to use full height. Default: -1.
 * @param offsetX Left bound of sub-image. Default: 0.
 * @param offsetY Top bound of sub-image. Default: 0.
 */
open class ImageVisual(
	image: BufferedImage,
	width: Int = -1,
	height: Int = -1,
	offsetX: Int = 0,
	offsetY: Int = 0
) : SingleLayerVisual() {
	
	/**
	 * [Property] for the displayed [image].
	 *
	 * @see image
	 */
	val imageProperty: Property
	
	/**
	 * The displayed [image].
	 *
	 * @see imageProperty
	 */
	var image: BufferedImage
		get() = imageProperty.value
		set(value) {
			imageProperty.value = value
		}
	
	init {
		require(offsetX < image.width) { "OffsetX is larger than image width." }
		require(offsetY < image.height) { "OffsetY is larger than image height." }
		
		require(width > 0 || width == -1) { "Width must be positive or -1." }
		require(height > 0 || height == -1) { "Height must be positive or -1." }
		
		val subWidth = if (width != -1) width else image.width - offsetX
		val subHeight = if (height != -1) height else image.height - offsetY
		
		require(subWidth > 0) { "Width exceeds image width." }
		require(subHeight > 0) { "Height exceeds image height." }
		
		require(offsetX + subWidth <= image.width) { "Width of SubImage exceeds image bounds." }
		require(offsetY + subHeight <= image.height) { "Height of SubImage exceeds image bounds." }
		
		val img = image.getSubimage(offsetX, offsetY, subWidth, subHeight)
		
		imageProperty = Property(img)
	}
	
	/**
	 * Loads an [ImageVisual] from a path.
	 *
	 * @param path Path to image file to show.
	 * @param width Width of sub-image. Pass -1 to use full width. Default: -1.
	 * @param height Height of sub-image. Pass -1 to use full height. Default: -1.
	 * @param offsetX Left bound of sub-image. Gets ignored if width is passed as -1. Default: 0.
	 * @param offsetY Top bound of sub-image. Gets ignored if height is passed as -1. Default: 0.
	 */
	constructor(
		path: String,
		width: Int = -1,
		height: Int = -1,
		offsetX: Int = 0,
		offsetY: Int = 0
	) : this(load(path), width, height, offsetX, offsetY)
	
	/**
	 * Loads an [ImageVisual] from a file.
	 *
	 * @param file Image file to show.
	 * @param width Width of sub-image. Pass -1 to use full width. Default: -1.
	 * @param height Height of sub-image. Pass -1 to use full height. Default: -1.
	 * @param offsetX Left bound of sub-image. Gets ignored if width is passed as -1. Default: 0.
	 * @param offsetY Top bound of sub-image. Gets ignored if height is passed as -1. Default: 0.
	 */
	constructor(
		file: File,
		width: Int = -1,
		height: Int = -1,
		offsetX: Int = 0,
		offsetY: Int = 0
	) : this(file.absolutePath, width, height, offsetX, offsetY)
	
	/**
	 * Copies this [ImageVisual] to a new object.
	 */
	override fun copy(): ImageVisual = ImageVisual(image).apply { transparency = [email protected] }
	
	companion object {
		/**
		 * Loads an image from a file.
		 */
		private fun load(file: String): BufferedImage = ImageIO.read(this::class.java.classLoader.getResource(file))
	}
}