MutableVec

Added in 1.0.0

Kotlin |Java

android
```
class MutableVec : Vec
```

kotlin.Any
↳	androidx.ink.geometry.Vec
	↳	androidx.ink.geometry.MutableVec

A mutable two-dimensional vector, i.e. an (x, y) coordinate pair. It can be used to represent either:

A two-dimensional offset, i.e. the difference between two points
A point in space, i.e. treating the vector as an offset from the origin

This object is mutable and is not inherently thread-safe, so callers should apply their own synchronization logic or use this object from a single thread. See ImmutableVec for an immutable alternative.

Summary

Public constructors
`MutableVec()`	android
`MutableVec(x: Float, y: Float)`	android

Public functions
`open operator Boolean`	`equals(other: Any?)`	android
`open Int`	`hashCode()`	android
`MutableVec`	`populateFrom(input: Vec)` Fills this `MutableVec` with the same values contained in `input`.	android
`MutableVec`	`populateFromDirectionInDegreesAndMagnitude( directionDegrees: @AngleDegreesFloat Float, magnitude: Float )` Fills this `MutableVec` to have the given magnitude and direction in degrees rotated from the positive x-axis in the direction of positive y-axis.	android
`open String`	`toString()`	android

Public properties
`open Float`	`x` The `Vec`'s offset in the x-direction	android
`open Float`	`y` The `Vec`'s offset in the y-direction	android

Extension functions
`MutableVec`	`MutableVec.populateFrom(point: PointF)` Fills this `MutableVec` with the values from `point`.	android
`MutableVec`	`MutableVec.populateFrom(offset: Offset)` Writes the values from `offset` to this `MutableVec`.	android

Inherited functions

From androidx.ink.geometry.Vec

`@FloatRange(from = -180.0, to = 180.0) @AngleDegreesFloat Float`	`computeDirectionDegrees()` The angle between the positive x-axis and this vec, in the direction of the positive y-axis.	android
`@FloatRange(from = 0.0) Float`	`computeMagnitude()` The length of the `Vec`.	android
`@FloatRange(from = 0.0) Float`	`computeMagnitudeSquared()` The squared length of the `Vec`.	android
`ImmutableVec`	`computeNegation()` Returns a newly allocated vector with the same magnitude, but pointing in the opposite direction.	android
`MutableVec`	`computeNegation(outVec: MutableVec)` Modifies `outVec` into a vector with the same magnitude, but pointing in the opposite direction.	android
`ImmutableVec`	`computeOrthogonal()` Returns a newly allocated vector with the same magnitude as this one, but rotated by (positive) 90 degrees.	android
`MutableVec`	`computeOrthogonal(outVec: MutableVec)` Modifies `outVec` into a vector with the same magnitude as this one, but rotated by (positive) 90 degrees.	android
`ImmutableVec`	`computeUnitVec()` Returns a newly allocated vector with the same direction as this one, but with a magnitude of `1`.	android
`MutableVec`	`computeUnitVec(outVec: MutableVec)` Modifies `outVec` into a vector with the same direction as this one, but with a magnitude of `1`.	android
`Boolean`	`isAlmostEqual(other: Vec, tolerance: @FloatRange(from = 0.0) Float)` Compares this `Vec` with `other`, and returns true if the difference between `x` and other.x is less than `tolerance`, and likewise for `y`.	android
`Boolean`	`isParallelTo( other: Vec, toleranceDegrees: @AngleDegreesFloat @FloatRange(from = 0.0) Float )` Returns true if the angle formed by `this` and `other` is within `toleranceDegrees` of 0 degrees or 180 degrees.	android
`Boolean`	`isPerpendicularTo( other: Vec, toleranceDegrees: @AngleDegreesFloat @FloatRange(from = 0.0) Float )` Returns true if the angle formed by `this` and `other` is within `toleranceDegrees` of ±90 degrees.	android

Public constructors

MutableVec

android

Added in 1.0.0

MutableVec()

MutableVec

android

Added in 1.0.0

MutableVec(x: Float, y: Float)

Public functions

equals

android

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

hashCode

android

open fun hashCode(): Int

populateFrom

android

Added in 1.0.0

fun populateFrom(input: Vec): MutableVec

Fills this MutableVec with the same values contained in input.

populateFromDirectionInDegreesAndMagnitude

android

Added in 1.0.0

fun populateFromDirectionInDegreesAndMagnitude(
    directionDegrees: @AngleDegreesFloat Float,
    magnitude: Float
): MutableVec

Fills this MutableVec to have the given magnitude and direction in degrees rotated from the positive x-axis in the direction of positive y-axis.

toString

android

open fun toString(): String

Public properties

x

android

open var x: Float

The Vec's offset in the x-direction

y

android

open var y: Float

The Vec's offset in the y-direction

Extension functions

populateFrom

android

Artifact: androidx.ink:ink-geometry

View Source

fun MutableVec.populateFrom(point: PointF): MutableVec

Fills this MutableVec with the values from point.

Leaves point unchanged. Returns the modified instance to allow chaining calls.

Returns
`MutableVec`	`this`

populateFrom

android

Artifact: androidx.ink:ink-geometry-compose

View Source

fun MutableVec.populateFrom(offset: Offset): MutableVec

Writes the values from offset to this MutableVec.

Returns the modified instance to allow chaining function calls.

Returns
`MutableVec`	`this`