ImmutableSegment

Kotlin |Java

class ImmutableSegment : Segment

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

Represents a directed line segment between two points. See MutableSegment for mutable alternative.

Summary

Public constructors
`ImmutableSegment(start: Vec, end: Vec)`

Public properties
`open Vec`	`end`
`open Vec`	`start`

`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`.

ImmutableSegment(start: Vec, end: Vec)

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

open fun hashCode(): Int

open fun toString(): String

open val end: Vec

open val start: Vec