ImmutableSegment

Added in 1.0.0

Kotlin |Java

Cmn
```
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)`	Cmn

Public functions
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`open ImmutableVec`	`end`	Cmn
`open ImmutableVec`	`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

ImmutableSegment

Cmn

Added in 1.0.0

ImmutableSegment(start: Vec, end: Vec)

Public functions

equals

Cmn

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

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

end

Cmn

open val end: ImmutableVec

start

Cmn

open val start: ImmutableVec