The class that provides motion settings for three pane scaffolds like ListDetailPaneScaffold and SupportingPaneScaffold.

Summary

Public companion properties
ThreePaneMotion

A default ThreePaneMotion instance that specifies no motions.
Cmn

Public constructors
ThreePaneMotion(
    primaryPaneMotion: PaneMotion,
    secondaryPaneMotion: PaneMotion,
    tertiaryPaneMotion: PaneMotion,
    sizeAnimationSpec: FiniteAnimationSpec<IntSize>,
    positionAnimationSpec: FiniteAnimationSpec<IntOffset>,
    delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset>
)
Cmn

Public functions
ThreePaneMotion
copy(
    primaryPaneMotion: PaneMotion,
    secondaryPaneMotion: PaneMotion,
    tertiaryPaneMotion: PaneMotion,
    sizeAnimationSpec: FiniteAnimationSpec<IntSize>,
    positionAnimationSpec: FiniteAnimationSpec<IntOffset>,
    delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset>
)

Makes a copy of ThreePaneMotion with override values.
Cmn
open operator Boolean
equals(other: Any?)
Cmn
operator PaneMotion

Gets the specified PaneMotion of a given pane role.
Cmn
open Int
Cmn
open String
Cmn

Public properties
FiniteAnimationSpec<IntOffset>

the specified FiniteAnimationSpec when animating pane position changes with a delay to emphasize entering panes.
Cmn
FiniteAnimationSpec<IntOffset>

the specified FiniteAnimationSpec when animating pane position changes.
Cmn
FiniteAnimationSpec<IntSize>

the specified FiniteAnimationSpec when animating pane size changes.
Cmn

Public companion properties

NoMotion

Cmn
Added in 1.1.0-alpha02
val NoMotion: ThreePaneMotion

A default ThreePaneMotion instance that specifies no motions.

Public constructors

ThreePaneMotion

Cmn
Added in 1.1.0-alpha02
ThreePaneMotion(
    primaryPaneMotion: PaneMotion,
    secondaryPaneMotion: PaneMotion,
    tertiaryPaneMotion: PaneMotion,
    sizeAnimationSpec: FiniteAnimationSpec<IntSize> = ThreePaneMotionDefaults.PaneSizeAnimationSpec,
    positionAnimationSpec: FiniteAnimationSpec<IntOffset> = ThreePaneMotionDefaults.PanePositionAnimationSpec,
    delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset> = ThreePaneMotionDefaults.PanePositionAnimationSpecDelayed
)
Parameters
primaryPaneMotion: PaneMotion

the specified PaneMotion of the primary pane, i.e., ListDetailPaneScaffoldRole.Detail or SupportingPaneScaffoldRole.Main.
secondaryPaneMotion: PaneMotion

the specified PaneMotion of the secondary pane, i.e., ListDetailPaneScaffoldRole.List or SupportingPaneScaffoldRole.Supporting.
tertiaryPaneMotion: PaneMotion

the specified PaneMotion of the tertiary pane, i.e., ListDetailPaneScaffoldRole.Extra or SupportingPaneScaffoldRole.Extra.
sizeAnimationSpec: FiniteAnimationSpec<IntSize> = ThreePaneMotionDefaults.PaneSizeAnimationSpec

the specified FiniteAnimationSpec when animating pane size changes.
positionAnimationSpec: FiniteAnimationSpec<IntOffset> = ThreePaneMotionDefaults.PanePositionAnimationSpec

the specified FiniteAnimationSpec when animating pane position changes.
delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset> = ThreePaneMotionDefaults.PanePositionAnimationSpecDelayed

the specified FiniteAnimationSpec when animating pane position changes with a delay to emphasize entering panes.

Public functions

copy

Cmn
Added in 1.1.0-alpha02
fun copy(
    primaryPaneMotion: PaneMotion = this.primaryPaneMotion,
    secondaryPaneMotion: PaneMotion = this.secondaryPaneMotion,
    tertiaryPaneMotion: PaneMotion = this.tertiaryPaneMotion,
    sizeAnimationSpec: FiniteAnimationSpec<IntSize> = this.sizeAnimationSpec,
    positionAnimationSpec: FiniteAnimationSpec<IntOffset> = this.positionAnimationSpec,
    delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset> = this.delayedPositionAnimationSpec
): ThreePaneMotion

Makes a copy of ThreePaneMotion with override values.

Parameters
primaryPaneMotion: PaneMotion = this.primaryPaneMotion

the specified PaneMotion of the primary pane, i.e., ListDetailPaneScaffoldRole.Detail or SupportingPaneScaffoldRole.Main.
secondaryPaneMotion: PaneMotion = this.secondaryPaneMotion

the specified PaneMotion of the secondary pane, i.e., ListDetailPaneScaffoldRole.List or SupportingPaneScaffoldRole.Supporting.
tertiaryPaneMotion: PaneMotion = this.tertiaryPaneMotion

the specified PaneMotion of the tertiary pane, i.e., ListDetailPaneScaffoldRole.Extra or SupportingPaneScaffoldRole.Extra.
sizeAnimationSpec: FiniteAnimationSpec<IntSize> = this.sizeAnimationSpec

the specified FiniteAnimationSpec when animating pane size changes.
positionAnimationSpec: FiniteAnimationSpec<IntOffset> = this.positionAnimationSpec

the specified FiniteAnimationSpec when animating pane position changes.
delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset> = this.delayedPositionAnimationSpec

the specified FiniteAnimationSpec when animating pane position changes with a delay to emphasize entering panes.

equals

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

get

Cmn
Added in 1.1.0-alpha02
operator fun get(role: ThreePaneScaffoldRole): PaneMotion

Gets the specified PaneMotion of a given pane role.

Parameters
role: ThreePaneScaffoldRole

the specified role of the pane, see ListDetailPaneScaffoldRole and SupportingPaneScaffoldRole.

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

delayedPositionAnimationSpec

Cmn
Added in 1.1.0-alpha02
val delayedPositionAnimationSpec: FiniteAnimationSpec<IntOffset>

the specified FiniteAnimationSpec when animating pane position changes with a delay to emphasize entering panes.

positionAnimationSpec

Cmn
Added in 1.1.0-alpha02
val positionAnimationSpec: FiniteAnimationSpec<IntOffset>

the specified FiniteAnimationSpec when animating pane position changes.

sizeAnimationSpec

Cmn
Added in 1.1.0-alpha02
val sizeAnimationSpec: FiniteAnimationSpec<IntSize>

the specified FiniteAnimationSpec when animating pane size changes.