API reference
API reference
Select your platform
No SDKs available
No versions available

PanelScaleOutLocalState Class

Modifiers: final
Holds the per-entity state for a panel scale-out animation. Created when a PanelScaleOutAnimation component is attached to an entity. The animation interpolates the panel's scale from its initial value down to zero over the specified duration, creating a shrink-out visual effect for UI panel dismissal.

Signature

data class PanelScaleOutLocalState(val startTimeInMs: Long, val durationInMs: Long, val initialScale: Vector3, var isComplete: Boolean = false)

Constructors

PanelScaleOutLocalState ( startTimeInMs , durationInMs , initialScale , isComplete )
Signature
constructor(startTimeInMs: Long, durationInMs: Long, initialScale: Vector3, isComplete: Boolean = false)
Parameters
startTimeInMs: Long  Timestamp in milliseconds when the scale-out animation began. Used with DataModel.getLocalDataModelTime() to calculate elapsed progress each frame.
durationInMs: Long  Total duration of the scale-out animation in milliseconds. The panel's scale is interpolated linearly from initialScale toward zero over this period.
initialScale: Vector3  The starting scale of the panel as a Vector3, captured when the animation begins. The panel shrinks linearly from this value toward Vector3(0,0,0).
isComplete: Boolean  Whether the animation has finished. Set to true when elapsed time exceeds durationInMs, at which point the panel's scale reaches zero and the entity may be removed or hidden.

Properties

durationInMs : Long
[Get]
Total duration of the scale-out animation in milliseconds. The panel's scale is interpolated linearly from initialScale toward zero over this period.
Signature
val durationInMs: Long
initialScale : Vector3
[Get]
The starting scale of the panel as a Vector3, captured when the animation begins. The panel shrinks linearly from this value toward Vector3(0,0,0).
Signature
val initialScale: Vector3
isComplete : Boolean
[Get][Set]
Whether the animation has finished. Set to true when elapsed time exceeds durationInMs, at which point the panel's scale reaches zero and the entity may be removed or hidden.
Signature
var isComplete: Boolean
startTimeInMs : Long
[Get]
Timestamp in milliseconds when the scale-out animation began. Used with DataModel.getLocalDataModelTime() to calculate elapsed progress each frame.
Signature
val startTimeInMs: Long