DampingNode

Artifact: androidx.ink:ink-brush

View Source

Added in 1.1.0-alpha08

---

Kotlin |Java

Common/All

• Cmn

  class DampingNode : ValueNode

kotlin.Any
↳	androidx.ink.brush.behavior.Node
	↳	androidx.ink.brush.behavior.ValueNode
		↳	androidx.ink.brush.behavior.DampingNode

---

A ValueNode that damps changes in an input value, causing the output value to slowly follow changes in the input value over a specified time or distance.

Summary

Public constructors
DampingNode(dampOver: ProgressDomain, strength: Float, input: ValueNode) Creates a DampingNode that damps changes in an input value, causing the output value to slowly follow changes in the input value over a specified time or distance.	Cmn

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

Public properties
ProgressDomain	dampOver The domain units over which damping is applied.	Cmn
ValueNode	input The input node that produces the value to be modified by the damping.	Cmn
Float	strength The amount of damping to apply.	Cmn

Inherited functions
From androidx.ink.brush.behavior.Node Version calculateMinimumRequiredVersion() Returns the minimum required Version for this Node. Cmn

Inherited properties
From androidx.ink.brush.behavior.Node List<ValueNode> inputs The ordered list of inputs that this node directly depends on. Cmn

Public constructors

DampingNode

Cmn

Added in 1.1.0-alpha08

DampingNode(dampOver: ProgressDomain, strength: Float, input: ValueNode)

Creates a DampingNode that damps changes in an input value, causing the output value to slowly follow changes in the input value over a specified time or distance.

If dampOver is ProgressDomain.DISTANCE_IN_CENTIMETERS and 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 the output value will be null regardless of the input.

Parameters
dampOver: ProgressDomain	The domain units over which damping is applied.
strength: Float	A scaling factor, in dampOver units, for the damping. A smaller strength value results in less damping, so the output follows the input more closely.
input: ValueNode	input node that produces the value to be modified by the damping

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

dampOver

Cmn

Added in 1.1.0-alpha08

val dampOver: ProgressDomain

The domain units over which damping is applied.

input

Cmn

Added in 1.1.0-alpha08

val input: ValueNode

The input node that produces the value to be modified by the damping.

strength

Cmn

Added in 1.1.0-alpha08

val strength: Float

The amount of damping to apply.