ProgressIndicatorObjectDisplay Class

  • Reference

Definition

Namespace:
Microsoft.MixedReality.Toolkit.UI
Assembly:
Microsoft.MixedReality.Toolkit.SDK.dll

This class manages how a GameObject rotates and/or scales when activated as part of a Progress Indicator effect.

public ref class ProgressIndicatorObjectDisplay : UnityEngine::MonoBehaviour, Microsoft::MixedReality::Toolkit::UI::IProgressIndicator
[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ProgressIndicatorObjectDisplay")]
public class ProgressIndicatorObjectDisplay : UnityEngine.MonoBehaviour, Microsoft.MixedReality.Toolkit.UI.IProgressIndicator
[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ProgressIndicatorObjectDisplay")>]
type ProgressIndicatorObjectDisplay = class
    inherit MonoBehaviour
    interface IProgressIndicator
Public Class ProgressIndicatorObjectDisplay
Inherits MonoBehaviour
Implements IProgressIndicator
Inheritance
UnityEngine.MonoBehaviour
ProgressIndicatorObjectDisplay
Attributes
UnityEngine.AddComponentMenuAttribute
Implements
IProgressIndicator

Constructors

ProgressIndicatorObjectDisplay()

Properties

MainTransform

The progress indicator's main transform. You can use this to attach follow scripts or solvers to the indicator.
Message

The message to display during loading.
Progress

Loading progress value from 0 (just started) to 1 (complete)
State

Used to determine whether it's appropriate to use this indicator.

Methods

AwaitTransitionAsync()

Returns after progress indicator completes its opening or closing transition.
CloseAsync()

Closes the progress indicator after loading is finished. Method is async to allow for animation to complete.
CloseImmediate()

Closes the progress indicator immediately. No fade out animation. All gameObjects for the progress indicator are reset to the correct values.
OpenAsync()

Opens the progress indicator before loading begins. Method is async to allow for animation to begin before loading.

Applies to