MutableSegment

Added in 1.0.0

Kotlin |Java

Cmn
```
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)	Cmn
`MutableSegment(start: MutableVec, end: MutableVec)` Create the `MutableSegment` from two existing `MutableVec` instances.	Cmn

Public functions
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`MutableSegment`	`populateFrom(input: Segment)` Fills this `MutableSegment` with the same values contained in `input`.	Cmn
`open ImmutableSegment`	`toImmutable()` Returns an immutable copy of this object.	Cmn
`open String`	`toString()`	Cmn

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

Inherited functions

From androidx.ink.geometry.Segment

`ImmutableBox`	`computeBoundingBox()` Returns the minimum bounding box containing the `Segment`.	Cmn
`MutableBox`	`computeBoundingBox(outBox: MutableBox)` Populates `outBox` with the minimum bounding box containing the `Segment`.	Cmn
`ImmutableVec`	`computeDisplacement()` Returns an ImmutableVec with the displacement from start to end.	Cmn
`MutableVec`	`computeDisplacement(outVec: MutableVec)` Populates `outVec` with the displacement from start to end.	Cmn
`@FloatRange(from = 0.0) Float`	`computeLength()` The length of the `Segment`.	Cmn
`ImmutableVec`	`computeLerpPoint(ratio: Float)` Returns the point on the segment at the given ratio of the segment's length, measured from the start point.	Cmn
`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.	Cmn
`ImmutableVec`	`computeMidpoint()` Returns an `ImmutableVec` that lies halfway along the segment.	Cmn
`MutableVec`	`computeMidpoint(outVec: MutableVec)` Populates `outVec` with the point halfway along the segment.	Cmn
`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.	Cmn
`Float`	`project(pointToProject: Vec)` Returns the multiple of the segment's length at which the infinite extrapolation of this segment is closest to `pointToProject`.	Cmn

Public constructors

MutableSegment

Cmn

Added in 1.0.0

MutableSegment()

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

MutableSegment

Cmn

Added in 1.0.0

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

Cmn

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

hashCode

Cmn

open fun hashCode(): Int

populateFrom

Cmn

Added in 1.0.0

fun populateFrom(input: Segment): MutableSegment

Fills this MutableSegment with the same values contained in input.

Returns the modified instance to allow chaining calls.

Returns
`MutableSegment`	`this`

toImmutable

Cmn

open fun toImmutable(): ImmutableSegment

Returns an immutable copy of this object. This will return itself if called on an immutable instance.

toString

Cmn

open fun toString(): String

Public properties

end

Cmn

open var end: MutableVec

start

Cmn

open var start: MutableVec