SquareBoundary

data class SquareBoundary(minDimensions: Pair<Double, Double>, width: Double, height: Double, maxSize: Int) : BoundaryShape

Square boundary

Constructors

SquareBoundary

fun SquareBoundary(minDimensions: Pair<Double, Double> = Pair(4.0, 4.0), width: Double = minDimensions.first.toDouble(), height: Double = minDimensions.second.toDouble(), maxSize: Int = 0)

Create empty Square boundary

Functions

area

fun area(): Double

Get area of of shape

clone

open override fun clone(): SquareBoundary

Clone

component1

operator fun component1(): Pair<Double, Double>

component2

operator fun component2(): Double

component3

operator fun component3(): Double

component4

operator fun component4(): Int

coordInShape

fun coordInShape(x: Double, y: Double): Boolean

Check if coordinate is in shape

copy

fun copy(minDimensions: Pair<Double, Double> = Pair(4.0, 4.0), width: Double = minDimensions.first.toDouble(), height: Double = minDimensions.second.toDouble(), maxSize: Int = 0): SquareBoundary

corners

fun corners(): List<Pair<Double, Double>>

List of 4 corners

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

offsetHeight

fun offsetHeight(offset: Int = 1): BoundaryShape

Offset height

offsetWidth

fun offsetWidth(offset: Int = 1): BoundaryShape

Offset width

overlapsShape

fun overlapsShape(otherShape: BoundaryShape): Boolean

Overlaps Shape

positioning

fun positioning(): PositionProperties

Returns position property of shape

setCoords

open override fun setCoords(x: Double, y: Double): SquareBoundary

Set coords

shiftHorizontalToRight

fun shiftHorizontalToRight(offset: Double): BoundaryShape

Shift horizontal to right

shiftVerticalUpwards

fun shiftVerticalUpwards(offset: Double): BoundaryShape

Shift vertical upwards

toString

open override fun toString(): String

Properties

canCentralise

var canCentralise: Boolean = true

: boolean to decide whether the shape can be centralised (code and variable block cannot for example)

dynamicHeight

open override val dynamicHeight: Boolean = true

dynamicWidth

open override val dynamicWidth: Boolean = true

height

open override var height: Double

maxSize

open override var maxSize: Int = 0

minDimensions

open override val minDimensions: Pair<Double, Double>

strictRatio

open override val strictRatio: Boolean = false

width

open override var width: Double

x1

var x1: Double = 0.0

: x coordinate of lower left corner for boundary

y1

var y1: Double = 0.0

: y coordinate of lower left corner for boundary