tools.aqua.bgw.core.AspectRatio.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.
 */

package tools.aqua.bgw.core

/**
 * Class representing an aspect ratio between the window sides.
 *
 * @constructor Creates an aspect ratio out of width and height.
 * May be for example 1920 : 1080 as well as 16 : 9.
 *
 * @param width Width of ratio. Default: [DEFAULT_WINDOW_WIDTH].
 * @param height Height of ratio. Default: [DEFAULT_WINDOW_HEIGHT].
 */
class AspectRatio(width: Number = DEFAULT_WINDOW_WIDTH, height: Number = DEFAULT_WINDOW_HEIGHT) {
	/**
	 * Width of ratio.
	 */
	internal val width: Double = width.toDouble()
	
	/**
	 * Height of ratio.
	 */
	internal val height: Double = height.toDouble()
	
	/**
	 * Ratio as fraction.
	 */
	internal val ratio: Double = width.toDouble() / height.toDouble()
}