ImmutableParallelogram
class ImmutableParallelogram : Parallelogram
Immutable parallelogram (i.e. a quadrilateral with parallel sides), defined by its center, width, height, rotation, and shearFactor.
Summary
Public companion functions |
|
|---|---|
ImmutableParallelogram |
fromCenterAndDimensions(Constructs an |
ImmutableParallelogram |
fromCenterDimensionsAndRotation(Constructs an |
ImmutableParallelogram |
fromCenterDimensionsRotationAndShear(Constructs an |
Public properties |
|
|---|---|
open ImmutableVec |
|
open Float |
A |
open Float |
|
open Float |
A |
open Float |
A |
Inherited functions |
||
|---|---|---|
|
Public companion functions
fromCenterAndDimensions
fun fromCenterAndDimensions(
center: ImmutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float
): ImmutableParallelogram
Constructs an ImmutableParallelogram with a given center, width and height. The resulting Parallelogram has zero rotation and shearFactor. If the width is less than zero, the Parallelogram will be normalized.
fromCenterDimensionsAndRotation
fun fromCenterDimensionsAndRotation(
center: ImmutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float,
rotation: @AngleRadiansFloat Float
): ImmutableParallelogram
Constructs an ImmutableParallelogram with a given center, width, height and rotation. The resulting Parallelogram has zero shearFactor. If the width is less than zero or if the rotation is not in the range [0, 2π), the Parallelogram will be normalized.
fromCenterDimensionsRotationAndShear
fun fromCenterDimensionsRotationAndShear(
center: ImmutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float,
rotation: @AngleRadiansFloat Float,
shearFactor: Float
): ImmutableParallelogram
Constructs an ImmutableParallelogram with a given center, width, height, rotation and shearFactor. If the width is less than zero or if the rotation is not in the range [0, 2π), the Parallelogram will be normalized.
Public functions
Public properties
height
open val height: Float
A Parallelogram may have a positive or negative height; a positive height indicates that the angle from the first semi-axis to the second will also be positive.
shearFactor
open val shearFactor: Float
A Parallelogram] may have a positive or negative shear factor; a positive shear factor indicates a smaller absolute angle between the semi-axes (the shear factor is, in fact, the cotangent of that angle).
width
open val width: Float
A Parallelogram may not have a negative width. If an operation on a parallelogram would result in a negative width, it is instead normalized, by negating both the width and the height, adding π to the angle of rotation, and normalizing rotation to the range [0, 2π).