MutableSegment

Kotlin |Java

class MutableSegment : Segment

kotlin.Any
↳	androidx.ink.geometry.Segment
	↳	androidx.ink.geometry.MutableSegment

Represents a mutable directed line segment between two points. See ImmutableSegment for the immutable alternative.

Summary

Public constructors
`MutableSegment()` Constructs a degenerate `MutableSegment` with both `start` and `end` set to (0f, 0f)
`MutableSegment(start: MutableVec, end: MutableVec)` Create the `MutableSegment` from two existing `MutableVec` instances.

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`MutableSegment`	`populateFrom(input: Segment)` Fills this `MutableSegment` with the same values contained in `input` and returns `this`.
`open String`	`toString()`

Public properties
`open MutableVec`	`end`
`open MutableVec`	`start`

Inherited functions

From androidx.ink.geometry.Segment

`ImmutableBox`	`computeBoundingBox()` Returns the minimum bounding box containing the `Segment`.
`MutableBox`	`computeBoundingBox(outBox: MutableBox)` Populates `outBox` with the minimum bounding box containing the `Segment`.
`ImmutableVec`	`computeDisplacement()` Returns an ImmutableVec with the displacement from start to end.
`MutableVec`	`computeDisplacement(outVec: MutableVec)` Populates `outVec` with the displacement from start to end.
`@FloatRange(from = 0.0) Float`	`computeLength()` The length of the `Segment`.
`ImmutableVec`	`computeLerpPoint(ratio: Float)` Returns the point on the segment at the given ratio of the segment's length, measured from the start point.
`MutableVec`	`computeLerpPoint(ratio: Float, outVec: MutableVec)` Fills `outVec` with the point on the segment at the given ratio of the segment's length, measured from the start point.
`ImmutableVec`	`computeMidpoint()` Returns an `ImmutableVec` that lies halfway along the segment.
`MutableVec`	`computeMidpoint(outVec: MutableVec)` Populates `outVec` with the point halfway along the segment.
`Boolean`	`isAlmostEqual(other: Segment, tolerance: @FloatRange(from = 0.0) Float)` Compares this `Segment` with `other`, and returns true if both `start` points are considered almost equal with the given `tolerance`, and likewise for both `end` points.
`Float`	`project(pointToProject: Vec)` Returns the multiple of the segment's length at which the infinite extrapolation of this segment is closest to `pointToProject`.

Public constructors

MutableSegment

Added in 1.0.0-alpha01

MutableSegment()

Constructs a degenerate MutableSegment with both start and end set to (0f, 0f)

MutableSegment

Added in 1.0.0-alpha01

MutableSegment(start: MutableVec, end: MutableVec)

Create the MutableSegment from two existing MutableVec instances. Note that these instances will become the internal state of this MutableSegment, so modifications made to them directly or through setters on this MutableSegment will modify the input MutableVec instances too. This is to allow performance-critical code to avoid any unnecessary allocations. This can be tricky to manage, especially in multithreaded code, so when calling code is unable to guarantee ownership of the nested mutable data at a particular time, it may be safest to construct this with copies of the data to give this MutableSegment exclusive ownership of those copies.

Public functions

equals

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

hashCode

open fun hashCode(): Int

populateFrom

Added in 1.0.0-alpha01

fun populateFrom(input: Segment): MutableSegment

Fills this MutableSegment with the same values contained in input and returns this.

toString

open fun toString(): String

Public properties

end

Added in 1.0.0-alpha01

open var end: MutableVec

start

Added in 1.0.0-alpha01

open var start: MutableVec