/
Android Studio Sign in

ImmutableVec

public final class ImmutableVec extends Vec

java.lang.Object
   ↳ androidx.ink.geometry.Vec
     ↳ androidx.ink.geometry.ImmutableVec

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

  1. A two-dimensional offset, i.e. the difference between two points

  2. A point in space, i.e. treating the vector as an offset from the origin

This object is immutable, so it is inherently thread-safe. See MutableVec for a mutable alternative.

Summary

Nested types
public static class ImmutableVec.Companion

Public constructors
ImmutableVec(float x, float y)

Public methods
boolean
equals(Object other)
static final @NonNull ImmutableVec
fromDirectionInDegreesAndMagnitude(
    @AngleDegreesFloat float directionDegrees,
    float magnitude
)

Returns an ImmutableVec with the given magnitude and direction in degrees rotated from the positive x-axis in the direction of positive y-axis.
float

The Vec's offset in the x-direction
float

The Vec's offset in the y-direction
int
@NonNull ImmutableVec

Returns an immutable copy of this object.
@NonNull String

Inherited methods
From androidx.ink.geometry.Vec
final @FloatRange(from = -180.0, to = 180.0) @AngleDegreesFloat float

The angle between the positive x-axis and this vec, in the direction of the positive y-axis.
final @FloatRange(from = 0.0) float

The length of the Vec.
final @FloatRange(from = 0.0) float

The squared length of the Vec.
final @NonNull ImmutableVec

Returns a newly allocated vector with the same magnitude, but pointing in the opposite direction.
final @NonNull MutableVec

Modifies outVec, which may be this, into a vector with the same magnitude, but pointing in the opposite direction.
final @NonNull ImmutableVec

Returns a newly allocated vector with the same magnitude as this one, but rotated by (positive) 90 degrees.
final @NonNull MutableVec

Modifies outVec, which may be this, into a vector with the same magnitude as this one, but rotated by (positive) 90 degrees.
final @NonNull ImmutableVec

Returns a newly allocated vector with the same direction as this one, but with a magnitude of 1.
final @NonNull MutableVec

Modifies outVec, which may be this, into a vector with the same direction as this one, but with a magnitude of 1.
final boolean
isAlmostEqual(@NonNull Vec other, @FloatRange(from = 0.0) float tolerance)

Compares this Vec with other, and returns true if the difference between x from this and x from other is less than tolerance, and likewise for y.
final boolean
isParallelTo(
    @NonNull Vec other,
    @AngleDegreesFloat @FloatRange(from = 0.0) float toleranceDegrees
)

Returns true if the angle formed by this and other is within toleranceDegrees of 0 degrees or 180 degrees.
final boolean
isPerpendicularTo(
    @NonNull Vec other,
    @AngleDegreesFloat @FloatRange(from = 0.0) float toleranceDegrees
)

Returns true if the angle formed by this and other is within toleranceDegrees of ±90 degrees.

Public constructors

ImmutableVec

Added in 1.0.0
public ImmutableVec(float x, float y)

Public methods

equals

public boolean equals(Object other)

fromDirectionInDegreesAndMagnitude

Added in 1.0.0
public static final @NonNull ImmutableVec fromDirectionInDegreesAndMagnitude(
    @AngleDegreesFloat float directionDegrees,
    float magnitude
)

Returns an ImmutableVec with the given magnitude and direction in degrees rotated from the positive x-axis in the direction of positive y-axis.

getX

public float getX()

The Vec's offset in the x-direction

getY

public float getY()

The Vec's offset in the y-direction

hashCode

public int hashCode()

toImmutable

public @NonNull ImmutableVec toImmutable()

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

toString

public @NonNull String toString()
Morty Proxy This is a proxified and sanitized view of the page, visit original site.