DistanceAttenuation.Linear


@RequiresSpatialApi(value = 4)
class DistanceAttenuation.Linear : DistanceAttenuation


Configures linear rolloff between minDistance and maxDistance.

Throws
IllegalArgumentException

if minDistance is less than 0.1, maxDistance is less than minDistance or gainAtMaxDistance is not between 0.0 and 1.0

Summary

Public constructors

Linear(minDistance: Float, maxDistance: Float, gainAtMaxDistance: Float)

Public functions

open operator Boolean
equals(other: Any?)
open Int
open String

Public properties

Float

Gain at maxDistance.

Float

Distance where attenuation reaches its maximum.

Float

Distance where attenuation begins (gain is 1.0).

Public constructors

Linear

Added in 1.1.0-alpha02
Linear(minDistance: Float, maxDistance: Float, gainAtMaxDistance: Float)
Parameters
minDistance: Float

Distance where attenuation begins (gain is 1.0). Must be >= 0.1.

maxDistance: Float

Distance where attenuation reaches its maximum.

gainAtMaxDistance: Float

Gain at maxDistance. Must be in range 0.0, 1.0.

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

gainAtMaxDistance

Added in 1.1.0-alpha02
val gainAtMaxDistance: Float

Gain at maxDistance. Must be in range 0.0, 1.0.

maxDistance

Added in 1.1.0-alpha02
val maxDistance: Float

Distance where attenuation reaches its maximum.

minDistance

Added in 1.1.0-alpha02
val minDistance: Float

Distance where attenuation begins (gain is 1.0). Must be >= 0.1.