ProgressDomain
-
Cmn
class ProgressDomain
Dimensions and units for measuring distance/time along the length/duration of a stroke.
This is used for DampingNodes, IntegralNodes, and NoiseNodes to specify the domain over which they operate.
Summary
Public companion properties |
||
|---|---|---|
ProgressDomain |
Progress in input distance traveled since the start of the stroke, measured in centimeters. |
Cmn
|
ProgressDomain |
Progress in input distance traveled since the start of the stroke, measured in multiples of the brush size. |
Cmn
|
ProgressDomain |
Progress in input time since the start of the stroke, measured in seconds. |
Cmn
|
Public functions |
||
|---|---|---|
Version |
Returns the minimum required |
Cmn
|
open String |
toString() |
Cmn
|
Public companion properties
DISTANCE_IN_CENTIMETERS
val DISTANCE_IN_CENTIMETERS: ProgressDomain
Progress in input distance traveled since the start of the stroke, measured in centimeters. If the stroke input data does not indicate the relationship between stroke units and physical units (e.g. as may be the case for programmatically-generated inputs), then any node relying on this domain will emit null.
DISTANCE_IN_MULTIPLES_OF_BRUSH_SIZE
val DISTANCE_IN_MULTIPLES_OF_BRUSH_SIZE: ProgressDomain
Progress in input distance traveled since the start of the stroke, measured in multiples of the brush size.
TIME_IN_SECONDS
val TIME_IN_SECONDS: ProgressDomain
Progress in input time since the start of the stroke, measured in seconds.
Public functions
calculateMinimumRequiredVersion
fun calculateMinimumRequiredVersion(): Version
Returns the minimum required Version for this ProgressDomain.
By default, decoding a androidx.ink.brush.BrushFamily containing a ProgressDomain with a minimum required version higher than Version.MAX_SUPPORTED will fail.