Smart UI Progress Bar Behavior
Progress Bar
Smart UI Progress Bar behavior handles progress bar UI components. It provides built-in animations and triggers to handle value changes. The component relies on its width. If you use it as part of a hierarcy, you must add it to an object using a Smart UI Container behavior to be rendered correctly, since it will use its parent width as the base for rendering.
Properties
| Property | Description |
|---|---|
| Enabled | Enables or Disables the Progress Bar. Value can still be set and it will change the progress bar, but animations won't be triggered. You can use the IsEnabled condition to affect the look and feel when needed. |
| Automatic-Color | Enables the component to darken a bit when its state is Disabled or when it's focused. Auto-Color is meant to provide a quick identification of the component state. For more specialized customizations, use the component events and disable this check. |
| Name | Unique name string for identifying the progress bar |
| Value | Numeric value representing the current progress. |
| Max.Value | Maximum value representing the 100%. |
| Animation time | Time in seconds to complete the animation when changing the value of the progress bar. |
| Animation Easing | Easing function to animate the value change. |
Actions
Set Enabled
Disable/Enable the Button
| Parameter | Description |
|---|---|
| Enabled | Enabled/Disabled |
Set Name
Sets the name of the component.
| Parameter | Description |
|---|---|
| Name | Name of the component |
Set Value
Sets the current value of the progress bar. If the value is below 0 or above the maximum, it will be clamped.
| Parameter | Description |
|---|---|
| Value | Numeric value representing the current progress |
| Mode | Indicate whether or not bypass the animation |
Set Max
Sets the maximum value of the progress bar.
| Parameter | Description |
|---|---|
| Value | Maximum value representing the 100%. |
Set Animation
Sets the animation function of the progress bar.
| Parameter | Description |
|---|---|
| Animation | Animation easing to be applied every time the value of the progress bar changes. |
Set Animation Time
Sets the time period in seconds to complete the animation of progress bar.
| Parameter | Description |
|---|---|
| Time | Period in seconds to complete the animation. |
Conditions
Is Enabled
Returns true if the Progress Bar is enabled
Compare Value
Compares the value of the progress bar.
| Parameter | Description |
|---|---|
| Comparison | How to compare the variable |
| Value | Value to compare the variable |
Compare Name
Returns true if the progress bar components name equals the parameter
| Parameter | Description |
|---|---|
| Name | Name to compare with the component picked. |
On Animated Value
Triggered when the progress bar animation is running. Use it to in combination of expressions AnimatedValue and AnimatedProgress to retrieve the animation data.
On Animation Finished
Triggered when the progress bar animation completes.
Expressions
Value
Progress Bar current value.
Progress
Progress Bar progress value in percentage.
Max
Progress Bar Maximum value.
AnimatedValue
Current animated value. This value is set only when the animation is running. E.G. If you are changing the value from 0 to 10, it will contain all the step values to reach the 10, as if it was counting.
AnimatedProgress
Percentage representing the AnimatedValue from the Max value allowed to be set for the progress bar. This value is set only when the animation is running
Name
Component name
(c) Pixel Perfect Studio 2024
