Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 6f896de9f93fe82ff1c7f1a7d1ff5c994d9503b9 / . / testData / compose / docs / reference / kotlin / androidx / compose / animation / core / FloatTweenSpec.html
blob: 6351c477e6e485c6318c87397ff11e99facaab64 [file] [log] [blame]
<html devsite="true">
<head>
<title>FloatTweenSpec</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>FloatTweenSpec</h1>
<p>
<pre>class <a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html">FloatTweenSpec</a> : <a href="/reference/kotlin/androidx/compose/animation/core/FloatAnimationSpec.html">FloatAnimationSpec</a></pre>
</p>
<hr>
<p><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html">FloatTweenSpec</a></code> animates a Float value from any start value to any end value using a provided <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#easing()">easing</a></code> function. The animation will finish within the <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#duration()">duration</a></code> time. Unless a <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#delay()">delay</a></code> is specified, the animation will start right away.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#FloatTweenSpec(kotlin.Int,kotlin.Int,androidx.compose.animation.core.Easing)">FloatTweenSpec</a>(duration:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,&nbsp;delay:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,&nbsp;easing:&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/Easing.html">Easing</a>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">getDurationNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>)</code></div>
<p>Calculates the duration of an animation.</p>
</td>
</tr>
<tr>
<td width="40%"><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getValueFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getValueFromNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>)</code></div>
<p>Calculates the value of the animation at given the playtime, with the provided start/end values, and start velocity.</p>
</td>
</tr>
<tr>
<td width="40%"><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getVelocityFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getVelocityFromNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>)</code></div>
<p>Calculates the velocity of the animation at given the playtime, with the provided start/end values, and start velocity.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#delay()">delay</a></code></div>
<p>the amount of time the animation will wait before it starts running.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#duration()">duration</a></code></div>
<p>the amount of time (in milliseconds) the animation will take to finish.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive" id="inhmethods">
<thead>
<tr>
<th colspan="100%"><h3>Inherited functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><devsite-expandable><span class="expand-control">From <a href="/reference/kotlin/androidx/compose/animation/core/FloatAnimationSpec.html">androidx.compose.animation.core.FloatAnimationSpec</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody class="list">
<tr>
<td width="40%"><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/animation/core/FloatAnimationSpec.html#getEndVelocity(kotlin.Float,kotlin.Float,kotlin.Float)">getEndVelocity</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>)</code></div>
<p>Calculates the end velocity of the animation with the provided start/end values, and start velocity.</p>
</td>
</tr>
<tr>
<td width="40%"><code>open <a href="/reference/kotlin/androidx/compose/animation/core/VectorizedFloatAnimationSpec.html">VectorizedFloatAnimationSpec</a>&lt;V&gt;</code></td>
<td>
<div><code>&lt;V&nbsp;:&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/AnimationVector.html">AnimationVector</a>&gt; <a href="/reference/kotlin/androidx/compose/animation/core/FloatAnimationSpec.html#vectorize(androidx.compose.animation.core.TwoWayConverter)">vectorize</a>(converter:&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/TwoWayConverter.html">TwoWayConverter</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,&nbsp;V&gt;)</code></div>
<p>Create an <code><a href="/reference/kotlin/androidx/compose/animation/core/VectorizedAnimationSpec.html">VectorizedAnimationSpec</a></code> that animates <code><a href="/reference/kotlin/androidx/compose/animation/core/AnimationVector.html">AnimationVector</a></code> from a <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatAnimationSpec.html">FloatAnimationSpec</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
</tbody>
</table>
</div>
<h2>Public constructors</h2>
<div><a name="FloatTweenSpec(kotlin.Int, kotlin.Int, androidx.compose.animation.core.Easing)"></a><a name="FloatTweenSpec-kotlin.Int-kotlin.Int-androidx.compose.animation.core.Easing-"></a><a name="floattweenspec"></a>
<h3 class="api-name" id="FloatTweenSpec(kotlin.Int,kotlin.Int,androidx.compose.animation.core.Easing)">FloatTweenSpec</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#FloatTweenSpec(kotlin.Int,kotlin.Int,androidx.compose.animation.core.Easing)">FloatTweenSpec</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;duration:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = DefaultDurationMillis,<br>&nbsp;&nbsp;&nbsp;&nbsp;delay:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 0,<br>&nbsp;&nbsp;&nbsp;&nbsp;easing:&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/Easing.html">Easing</a> = FastOutSlowInEasing<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>duration:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = DefaultDurationMillis</code></td>
<td>
<p>the amount of time (in milliseconds) the animation will take to finish. Defaults to DefaultDuration</p>
</td>
</tr>
<tr>
<td width="40%"><code>delay:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 0</code></td>
<td>
<p>the amount of time the animation will wait before it starts running. Defaults to 0.</p>
</td>
</tr>
<tr>
<td width="40%"><code>easing:&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/Easing.html">Easing</a> = FastOutSlowInEasing</code></td>
<td>
<p>the easing function that will be used to interoplate between the start and end value of the animation. Defaults to <code><a href="/reference/kotlin/androidx/compose/animation/core/package-summary.html#FastOutSlowInEasing()">FastOutSlowInEasing</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2>Public functions</h2>
<div><a name="getDurationNanos(kotlin.Float, kotlin.Float, kotlin.Float)"></a><a name="getDurationNanos-kotlin.Float-kotlin.Float-kotlin.Float-"></a><a name="getdurationnanos"></a>
<h3 class="api-name" id="getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">getDurationNanos</h3>
<pre class="api-signature no-pretty-print">open&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">getDurationNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>
<p>Calculates the duration of an animation. For duration-based animations, this will return the pre-defined duration. For physics-based animations, the duration will be estimated based on the physics configuration (such as spring stiffness, damping ratio, visibility threshold) as well as the <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">initialValue</a></code>, <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">targetValue</a></code> values, and <code><a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getDurationNanos(kotlin.Float,kotlin.Float,kotlin.Float)">initialVelocity</a></code>.</p>
<p><b>Note</b>: this may be a computation that is expensive - especially with spring based animations</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>end value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start velocity of the animation</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="getValueFromNanos(kotlin.Long, kotlin.Float, kotlin.Float, kotlin.Float)"></a><a name="getValueFromNanos-kotlin.Long-kotlin.Float-kotlin.Float-kotlin.Float-"></a><a name="getvaluefromnanos"></a>
<h3 class="api-name" id="getValueFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getValueFromNanos</h3>
<pre class="api-signature no-pretty-print">open&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getValueFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getValueFromNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></pre>
<p>Calculates the value of the animation at given the playtime, with the provided start/end values, and start velocity.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
<td>
<p>time since the start of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>end value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start velocity of the animation</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="getVelocityFromNanos(kotlin.Long, kotlin.Float, kotlin.Float, kotlin.Float)"></a><a name="getVelocityFromNanos-kotlin.Long-kotlin.Float-kotlin.Float-kotlin.Float-"></a><a name="getvelocityfromnanos"></a>
<h3 class="api-name" id="getVelocityFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getVelocityFromNanos</h3>
<pre class="api-signature no-pretty-print">open&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#getVelocityFromNanos(kotlin.Long,kotlin.Float,kotlin.Float,kotlin.Float)">getVelocityFromNanos</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></pre>
<p>Calculates the velocity of the animation at given the playtime, with the provided start/end values, and start velocity.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>playTimeNanos:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
<td>
<p>time since the start of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>initialValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>targetValue:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>end value of the animation</p>
</td>
</tr>
<tr>
<td width="40%"><code>initialVelocity:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
<td>
<p>start velocity of the animation</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2>Public properties</h2>
<div><a name="getDelay()"></a><a name="setDelay()"></a><a name="getDelay--"></a><a name="setDelay--"></a>
<h3 class="api-name" id="delay()">delay</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#delay()">delay</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
<p>the amount of time the animation will wait before it starts running. Defaults to 0.</p>
</div>
<div><a name="getDuration()"></a><a name="setDuration()"></a><a name="getDuration--"></a><a name="setDuration--"></a>
<h3 class="api-name" id="duration()">duration</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html#duration()">duration</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
<p>the amount of time (in milliseconds) the animation will take to finish. Defaults to DefaultDuration</p>
</div>
</body>
</html>