IntegralNode
public final class IntegralNode extends ValueNode
| java.lang.Object | |||
| ↳ | androidx.ink.brush.behavior.Node | ||
| ↳ | androidx.ink.brush.behavior.ValueNode | ||
| ↳ | androidx.ink.brush.behavior.IntegralNode | ||
A ValueNode that integrates an input value over time or distance.
Summary
Public constructors |
|---|
IntegralNode(Creates an |
Public methods |
|
|---|---|
boolean |
|
final @NonNull ValueNode |
getInput()The input node that produces the value to be integrated. |
final @NonNull OutOfRange |
The behavior to use if the integral produces a value outside the specified range. |
final float |
The end of the range of values that the integral can produce. |
final float |
The start of the range of values that the integral can produce. |
final @NonNull ProgressDomain |
The metric to integrate the input over. |
int |
hashCode() |
@NonNull String |
toString() |
Inherited methods |
|---|
Public constructors
IntegralNode
public IntegralNode(
@NonNull ProgressDomain integrateOver,
float integralValueRangeStart,
float integralValueRangeEnd,
@NonNull OutOfRange integralOutOfRangeBehavior,
@NonNull ValueNode input
)
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 | |
|---|---|
@NonNull ProgressDomain integrateOver |
the metric to integrate the input over |
float integralValueRangeStart |
the start of the range of values that the integral can produce |
float integralValueRangeEnd |
the end of the range of values that the integral can produce |
@NonNull OutOfRange integralOutOfRangeBehavior |
the behavior to use if the integral produces a value outside the specified range |
@NonNull ValueNode input |
input node that produces the value to be integrated |
Public methods
getInput
public final @NonNull ValueNode getInput()
The input node that produces the value to be integrated.
getIntegralOutOfRangeBehavior
public final @NonNull OutOfRange getIntegralOutOfRangeBehavior()
The behavior to use if the integral produces a value outside the specified range.
getIntegralValueRangeEnd
public final float getIntegralValueRangeEnd()
The end of the range of values that the integral can produce.
getIntegralValueRangeStart
public final float getIntegralValueRangeStart()
The start of the range of values that the integral can produce.
getIntegrateOver
public final @NonNull ProgressDomain getIntegrateOver()
The metric to integrate the input over.