IntegralNode



A ValueNode that integrates an input value over time or distance.

Summary

Public constructors

IntegralNode(
    integrateOver: ProgressDomain,
    integralValueRangeStart: Float,
    integralValueRangeEnd: Float,
    integralOutOfRangeBehavior: OutOfRange,
    input: ValueNode
)

Creates an IntegralNode that integrates over an input value.

Cmn

Public functions

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

Public properties

ValueNode

The input node that produces the value to be integrated.

Cmn
OutOfRange

The behavior to use if the integral produces a value outside the specified range.

Cmn
Float

The end of the range of values that the integral can produce.

Cmn
Float

The start of the range of values that the integral can produce.

Cmn
ProgressDomain

The metric to integrate the input over.

Cmn

Inherited properties

From androidx.ink.brush.behavior.Node
List<ValueNode>

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

Cmn

Public constructors

IntegralNode

IntegralNode(
    integrateOver: ProgressDomain,
    integralValueRangeStart: Float,
    integralValueRangeEnd: Float,
    integralOutOfRangeBehavior: OutOfRange,
    input: ValueNode
)

Creates an IntegralNode that integrates over an input value.

If integrateOver 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
integrateOver: ProgressDomain

the metric to integrate the input over

integralValueRangeStart: Float

the start of the range of values that the integral can produce

integralValueRangeEnd: Float

the end of the range of values that the integral can produce

integralOutOfRangeBehavior: OutOfRange

the behavior to use if the integral produces a value outside the specified range

input: ValueNode

input node that produces the value to be integrated

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

input

val inputValueNode

The input node that produces the value to be integrated.

integralOutOfRangeBehavior

val integralOutOfRangeBehaviorOutOfRange

The behavior to use if the integral produces a value outside the specified range.

integralValueRangeEnd

val integralValueRangeEndFloat

The end of the range of values that the integral can produce.

integralValueRangeStart

val integralValueRangeStartFloat

The start of the range of values that the integral can produce.

integrateOver

val integrateOverProgressDomain

The metric to integrate the input over.