MutableParallelogram
-
android
class MutableParallelogram : Parallelogram
Mutable parallelogram (i.e. a quadrilateral with parallel sides), defined by its center, width, height, rotation, and shearFactor.
Summary
Public constructors |
|
|---|---|
|
Constructs an empty |
android
|
Public properties |
||
|---|---|---|
open MutableVec |
android
|
|
open Float |
A |
android
|
open Float |
android
|
|
open Float |
A |
android
|
open Float |
A |
android
|
Inherited functions |
|||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
MutableParallelogram
MutableParallelogram()
Constructs an empty MutableParallelogram with a center at the origin, a zero width, a zero height, zero rotation, and zero shear factor. This is intended for subsequent population with one of the populateFrom methods.
Public functions
populateFrom
fun populateFrom(input: Parallelogram): MutableParallelogram
Fills this MutableParallelogram with the same values contained in input.
Returns the modified instance to allow chaining calls.
| Returns | |
|---|---|
MutableParallelogram |
|
populateFromCenterAndDimensions
fun populateFromCenterAndDimensions(
center: MutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float
): MutableParallelogram
Populates a MutableParallelogram to have 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.
| Returns | |
|---|---|
MutableParallelogram |
|
populateFromCenterDimensionsAndRotation
fun populateFromCenterDimensionsAndRotation(
center: MutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float,
rotation: @AngleRadiansFloat Float
): MutableParallelogram
Populates the MutableParallelogram to have a given center, width, height and rotation and zero shearFactor. If the width is less than zero or if the rotation is not in the range [0, 2π), it will be normalized.
| Returns | |
|---|---|
MutableParallelogram |
|
populateFromCenterDimensionsRotationAndShear
fun populateFromCenterDimensionsRotationAndShear(
center: MutableVec,
width: @FloatRange(from = 0.0) Float,
height: Float,
rotation: @AngleRadiansFloat Float,
shearFactor: Float
): MutableParallelogram
Populates the MutableParallelogram to have 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π), it will be normalized.
| Returns | |
|---|---|
MutableParallelogram |
|
populateFromSegmentAndPadding
fun populateFromSegmentAndPadding(segment: Segment, padding: Float): MutableParallelogram
Populates the MutableParallelogram to be aligned with the segment with its bounds padding units away from the segment and shear of zero.
| Returns | |
|---|---|
MutableParallelogram |
|
Public properties
height
open var 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 var 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 var 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π).