All Implemented Interfaces:: kotlin.Cloneable , kotlin.Comparable


public class Vec2
 implements Comparable<Vec2>, Cloneable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public abstract class`	`Vec2.Sourced`
`public final class`	`Vec2.Relative`
`public final class`	`Vec2.Based`	⣿⣿⣿⣿⣿⣿⣿⣿⡿⠿⠛⠛⠛⠋⠉⠈⠉⠉⠉⠉⠛⠻⢿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⡿⠋⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠛⢿⣿⣿⣿⣿ ⣿⣿⣿⣿⡏⣀⠀⠀⠀⠀⠀⠀⠀⣀⣤⣤⣤⣄⡀⠀⠀⠀⠀⠀⠀⠀⠙⢿⣿⣿ ⣿⣿⣿⢏⣴⣿⣷⠀⠀⠀⠀⠀⢾⣿⣿⣿⣿⣿⣿⡆⠀⠀⠀⠀⠀⠀⠀⠈⣿⣿ ⣿⣿⣟⣾⣿⡟⠁⠀⠀⠀⠀⠀⢀⣾⣿⣿⣿⣿⣿⣷⢢⠀⠀⠀⠀⠀⠀⠀⢸⣿ ⣿⣿⣿⣿⣟⠀⡴⠄⠀⠀⠀⠀⠀⠀⠙⠻⣿⣿⣿⣿⣷⣄⠀⠀⠀⠀⠀⠀⠀⣿ ⣿⣿⣿⠟⠻⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠶⢴⣿⣿⣿⣿⣿⣧⠀⠀⠀⠀⠀⠀⣿ ⣿⣁⡀⠀⠀⢰⢠⣦⠀⠀⠀⠀⠀⠀⠀⠀⢀⣼⣿⣿⣿⣿⣿⡄⠀⣴⣶⣿⡄⣿ ⣿⡋⠀⠀⠀⠎⢸⣿⡆⠀⠀⠀⠀⠀⠀⣴⣿⣿⣿⣿⣿⣿⣿⠗⢘⣿⣟⠛⠿⣼ ⣿⣿⠋⢀⡌⢰⣿⡿⢿⡀⠀⠀⠀⠀⠀⠙⠿⣿⣿⣿⣿⣿⡇⠀⢸⣿⣿⣧⢀⣼ ⣿⣿⣷⢻⠄⠘⠛⠋⠛⠃⠀⠀⠀⠀⠀⢿⣧⠈⠉⠙⠛⠋⠀⠀⠀⣿⣿⣿⣿⣿ ⣿⣿⣧⠀⠈⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠟⠀⠀⠀⠀⢀⢃⠀⠀⢸⣿⣿⣿⣿ ⣿⣿⡿⠀⠴⢗⣠⣤⣴⡶⠶⠖⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⡸⠀⣿⣿⣿⣿ ⣿⣿⣿⡀⢠⣾⣿⠏⠀⠠⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠛⠉⠀⣿⣿⣿⣿ ⣿⣿⣿⣧⠈⢹⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣰⣿⣿⣿⣿ ⣿⣿⣿⣿⡄⠈⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣠⣴⣾⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣧⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣷⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⣦⣄⣀⣀⣀⣀⠀⠀⠀⠀⠘⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡄⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣧⠀⠀⠀⠙⣿⣿⡟⢻⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠇⠀⠁⠀⠀⠹⣿⠃⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⣿⣿⣿⣿⡿⠛⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⢐⣿⣿⣿⣿⣿⣿⣿⣿⣿ ⣿⣿⣿⣿⠿⠛⠉⠉⠁⠀⢻⣿⡇⠀⠀⠀⠀⠀⠀⢀⠈⣿⣿⡿⠉⠛⠛⠛⠉⠉ ⣿⡿⠋⠁⠀⠀⢀⣀⣠⡴⣸⣿⣇⡄⠀⠀⠀⠀⢀⡿⠄⠙⠛⠀⣀⣠⣤⣤⠄⠀
`public final class`	`Vec2.Percent`
`public final class`	`Vec2.Immutable`	Immutable Vec2 wrapper. Attempts to set will result in a compilation error in Kotlin, and an UnsupportedOperationException.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Vec2.Immutable`	`ONE`
`public final static Vec2.Immutable`	`ZERO`
`public final static Vec2.Immutable`	`RES_1080P`
`public final static Vec2.Immutable`	`RES_1440P`
`public final static Vec2.Immutable`	`RES_4K`
`private Float`	`width`
`private Float`	`height`
`private final Boolean`	`isZero`
`private final Boolean`	`hasZero`
`private final Boolean`	`isNegative`
`private final Float`	`magnitude2`
`private final Float`	`magnitude`
`private Float`	`x`
`private Float`	`y`

Constructor Summary

Constructors
Constructor	Description
`Vec2(Float x, Float y)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Float`	`getWidth()`
`final Unit`	`setWidth(Float width)`
`final Float`	`getHeight()`
`final Unit`	`setHeight(Float height)`
`final Boolean`	`isZero()`
`final Boolean`	`getHasZero()`
`final Boolean`	`isNegative()`
`Float`	`getMagnitude2()`
`Float`	`getMagnitude()`
`Float`	`getX()`
`Unit`	`setX(Float x)`
`Float`	`getY()`
`Unit`	`setY(Float y)`
`final Unit`	`normalize()`	Normalize this vector.
`final Unit`	`min(Float x, Float y, Boolean respectRatio)`
`final Unit`	`ensureSmallerThan(Vec2 other)`
`final Unit`	`ensureLargerThan(Vec2 other)`
`final Unit`	`max(Float x, Float y, Boolean respectRatio)`
`final Unit`	`resize(Float x, Float y, Boolean respectRatio)`
`Unit`	`scale(Float xScale, Float yScale)`
`final Unit`	`timesAssign(Vec2 other)`
`final Unit`	`timesAssign(Float other)`
`final Unit`	`divAssign(Float other)`
`final Unit`	`plusAssign(Vec2 other)`
`final Unit`	`minusAssign(Vec2 other)`
`final Unit`	`set(Integer index, Float value)`
`final Unit`	`set(Vec2 other)`
`final Float`	`get(Integer index)`
`Integer`	`compareTo(Vec2 other)`	Compares the two Vec2 instances according to the magnitude of the vectors.
`final Integer`	`compareTo(Float fl)`	Compares the magnitude of this to the given float, which should be a magnitude of a vector itself.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`Vec2`	`clone()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Vec2
```
Vec2(Float x, Float y)
```

Method Detail

getWidth
```
 final Float getWidth()
```

setWidth
```
 final Unit setWidth(Float width)
```

getHeight
```
 final Float getHeight()
```

setHeight
```
 final Unit setHeight(Float height)
```

isZero
```
 final Boolean isZero()
```

getHasZero
```
 final Boolean getHasZero()
```

isNegative
```
 final Boolean isNegative()
```

getMagnitude2
```
 Float getMagnitude2()
```

getMagnitude
```
 Float getMagnitude()
```

getX
```
 Float getX()
```

setX
```
 Unit setX(Float x)
```

getY
```
 Float getY()
```

setY
```
 Unit setY(Float y)
```

normalize

@ApiStatus.Experimental() final Unit normalize()

Normalize this vector.

min

 final Unit min(Float x, Float y, Boolean respectRatio)

ensureSmallerThan

 final Unit ensureSmallerThan(Vec2 other)

ensureLargerThan

 final Unit ensureLargerThan(Vec2 other)

max

 final Unit max(Float x, Float y, Boolean respectRatio)

resize

 final Unit resize(Float x, Float y, Boolean respectRatio)

scale

 Unit scale(Float xScale, Float yScale)

timesAssign
```
 final Unit timesAssign(Vec2 other)
```

timesAssign
```
 final Unit timesAssign(Float other)
```

divAssign
```
 final Unit divAssign(Float other)
```

plusAssign
```
 final Unit plusAssign(Vec2 other)
```

minusAssign
```
 final Unit minusAssign(Vec2 other)
```

set

 final Unit set(Integer index, Float value)

set
```
 final Unit set(Vec2 other)
```

get
```
 final Float get(Integer index)
```

compareTo
```
 Integer compareTo(Vec2 other)
```
Compares the two Vec2 instances according to the magnitude of the vectors. A positive number is returned if this magnitude is larger than other, negative if it is smaller than other, and 0 if it is equal to other.
Note that two different vectors can have the same magnitude.

compareTo
```
 final Integer compareTo(Float fl)
```
Compares the magnitude of this to the given float, which should be a magnitude of a vector itself.

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

clone
```
 Vec2 clone()
```

Class Vec2

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vec2

Method Detail

getWidth

setWidth

getHeight

setHeight

isZero

getHasZero

isNegative

getMagnitude2

getMagnitude

getX

setX

getY

setY

normalize

min

ensureSmallerThan

ensureLargerThan

max

resize

scale

timesAssign

timesAssign

divAssign

plusAssign

minusAssign

set

set

get

compareTo

compareTo

equals

hashCode

toString

clone