Class ProgressIndicatorObjectDisplay
This class manages how a GameObject rotates and/or scales when activated as part of a Progress Indicator effect.
Implements
Namespace: Microsoft.MixedReality.Toolkit.UI
Assembly: cs.temp.dll.dll
Syntax
public class ProgressIndicatorObjectDisplay : MonoBehaviour, IProgressIndicatorProperties
MainTransform
The progress indicator's main transform. You can use this to attach follow scripts or solvers to the indicator.
Declaration
public Transform MainTransform { get; }Property Value
| Type | Description |
|---|---|
| Transform |
Message
The message to display during loading.
Declaration
public string Message { set; }Property Value
| Type | Description |
|---|---|
| String |
Progress
Loading progress value from 0 (just started) to 1 (complete)
Declaration
public float Progress { set; }Property Value
| Type | Description |
|---|---|
| Single |
State
Used to determine whether it's appropriate to use this indicator.
Declaration
public ProgressIndicatorState State { get; }Property Value
| Type | Description |
|---|---|
| ProgressIndicatorState |
Methods
AwaitTransitionAsync()
Returns after progress indicator completes its opening or closing transition.
Declaration
public Task AwaitTransitionAsync()Returns
| Type | Description |
|---|---|
| Task |
CloseAsync()
Closes the progress indicator after loading is finished. Method is async to allow for animation to complete.
Declaration
public Task CloseAsync()Returns
| Type | Description |
|---|---|
| Task |
OpenAsync()
Opens the progress indicator before loading begins. Method is async to allow for animation to begin before loading.
Declaration
public Task OpenAsync()Returns
| Type | Description |
|---|---|
| Task |