# NoiseNode

Artifact: [androidx.ink:ink-brush](https://developer.android.com/jetpack/androidx/releases/ink) [View Source](https://cs.android.com/search?q=file:androidx/ink/brush/behavior/NoiseNode.kt+class:androidx.ink.brush.behavior.NoiseNode) Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

*** ** * ** ***


```
public final class NoiseNode extends ValueNode
```

<br />

|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||||
| ↳ | [androidx.ink.brush.behavior.Node](https://developer.android.com/reference/androidx/ink/brush/behavior/Node) |||
|   | ↳ | [androidx.ink.brush.behavior.ValueNode](https://developer.android.com/reference/androidx/ink/brush/behavior/ValueNode) ||
|   |   | ↳ | [androidx.ink.brush.behavior.NoiseNode](https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode) |

*** ** * ** ***

A `https://developer.android.com/reference/androidx/ink/brush/behavior/ValueNode` that produces a smooth random function.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#NoiseNode(kotlin.Int,androidx.ink.brush.behavior.ProgressDomain,kotlin.Float)(int seed, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/behavior/ProgressDomain varyOver, float basePeriod)` Creates a `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode` that produces a random variation. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final float` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#getBasePeriod()()` The base period of the random function. |
| `final int` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#getSeed()()` The seed for the random number generator. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/behavior/ProgressDomain` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#getVaryOver()()` The source of the varying over which the random function is evaluated. |
| `int` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#toString()()` |

### Inherited methods

From [androidx.ink.brush.behavior.Node](https://developer.android.com/reference/androidx/ink/brush/behavior/Node) `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/Version` `https://developer.android.com/reference/androidx/ink/brush/behavior/Node#calculateMinimumRequiredVersion()()`

Returns the minimum required `https://developer.android.com/reference/androidx/ink/brush/Version` for this `https://developer.android.com/reference/androidx/ink/brush/behavior/Node`.
`final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/behavior/ValueNode>` `https://developer.android.com/reference/androidx/ink/brush/behavior/Node#getInputs()()`

The ordered list of inputs that this node directly depends on.

## Public constructors

### NoiseNode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
public NoiseNode(int seed, @NonNull ProgressDomain varyOver, float basePeriod)
```

Creates a `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode` that produces a random variation.

A new random value between 0 and 1 will be generated every `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#(kotlin.Int,androidx.ink.brush.behavior.ProgressDomain,kotlin.Float)` units along the `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#(kotlin.Int,androidx.ink.brush.behavior.ProgressDomain,kotlin.Float)` domain, with the output of this node shifting smoothly between successive random values.

If `https://developer.android.com/reference/androidx/ink/brush/behavior/NoiseNode#(kotlin.Int,androidx.ink.brush.behavior.ProgressDomain,kotlin.Float)` is `https://developer.android.com/reference/androidx/ink/brush/behavior/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.

| Parameters |
|---|---|
| `int seed` | the seed for the random number generator |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/behavior/ProgressDomain varyOver` | the source of the varying over which the random function is evaluated |
| `float basePeriod` | the base period of the random function |

## Public methods

### equals

```
public boolean equals(Object other)
```

### getBasePeriod

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
public final float getBasePeriod()
```

The base period of the random function.

### getSeed

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
public final int getSeed()
```

The seed for the random number generator.

### getVaryOver

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
public final @NonNull ProgressDomain getVaryOver()
```

The source of the varying over which the random function is evaluated.

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```