Velocity

A two dimensional velocity in pixels per second.

Summary

Public companion properties
Velocity

An offset with zero magnitude.
Cmn

Public functions
inline operator Float

The horizontal component of the velocity in pixels per second.
Cmn
inline operator Float

The vertical component of the velocity in pixels per second.
Cmn
Velocity
copy(x: Float, y: Float)

Returns a copy of this Velocity instance optionally overriding the x or y parameter
Cmn
operator Velocity
div(operand: Float)

Division operator.
Cmn
operator Velocity
minus(other: Velocity)

Binary subtraction operator.
Cmn
operator Velocity
plus(other: Velocity)

Binary addition operator.
Cmn
operator Velocity
rem(operand: Float)

Modulo (remainder) operator.
Cmn
operator Velocity
times(operand: Float)

Multiplication operator.
Cmn
open String
Cmn
operator Velocity

Unary negation operator.
Cmn

Public properties
Float

The horizontal component of the velocity in pixels per second.
Cmn
Float

The vertical component of the velocity in pixels per second.
Cmn

Public companion properties

Zero

Cmn
Added in 1.0.0
val Zero: Velocity

An offset with zero magnitude.

This can be used to represent the origin of a coordinate space.

Public functions

component1

Cmn
Added in 1.1.0
inline operator fun component1(): Float

The horizontal component of the velocity in pixels per second.

component2

Cmn
Added in 1.1.0
inline operator fun component2(): Float

The vertical component of the velocity in pixels per second.

copy

Cmn
Added in 1.2.0
fun copy(
    x: Float = unpackFloat1(packedValue),
    y: Float = unpackFloat2(packedValue)
): Velocity

Returns a copy of this Velocity instance optionally overriding the x or y parameter

div

Cmn
Added in 1.1.0
operator fun div(operand: Float): Velocity

Division operator.

Returns a Velocity whose coordinates are those of the left-hand-side operand (an Velocity) divided by the scalar right-hand-side operand (a Float).

minus

Cmn 
operator fun minus(other: Velocity): Velocity

Binary subtraction operator.

Returns a Velocity whose x value is the left-hand-side operand's x minus the right-hand-side operand's x and whose y value is the left-hand-side operand's y minus the right-hand-side operand's y.

plus

Cmn 
operator fun plus(other: Velocity): Velocity

Binary addition operator.

Returns a Velocity whose x value is the sum of the x values of the two operands, and whose y value is the sum of the y values of the two operands.

rem

Cmn
Added in 1.1.0
operator fun rem(operand: Float): Velocity

Modulo (remainder) operator.

Returns a Velocity whose coordinates are the remainder of dividing the coordinates of the left-hand-side operand (a Velocity) by the scalar right-hand-side operand (a Float).

times

Cmn
Added in 1.1.0
operator fun times(operand: Float): Velocity

Multiplication operator.

Returns a Velocity whose coordinates are those of the left-hand-side operand (a Velocity) multiplied by the scalar right-hand-side operand (a Float).

toString

Cmn 
open fun toString(): String

unaryMinus

Cmn
Added in 1.1.0
operator fun unaryMinus(): Velocity

Unary negation operator.

Returns a Velocity with the coordinates negated.

If the Velocity represents an arrow on a plane, this operator returns the same arrow but pointing in the reverse direction.

Public properties

x

Cmn
Added in 1.2.0
val x: Float

The horizontal component of the velocity in pixels per second.

y

Cmn
Added in 1.2.0
val y: Float

The vertical component of the velocity in pixels per second.