Show / Hide Table of Contents

    Class ProgressIndicatorOrbsRotator

    This class manages the 'rotating circle of dots' effect that is used as a Progress Indicator effect.

    Inheritance
    Object
    ProgressIndicatorOrbsRotator
    Implements
    IProgressIndicator
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class ProgressIndicatorOrbsRotator : MonoBehaviour, IProgressIndicator

    Fields

    acceleration

    Declaration
    public float acceleration
    Field Value
    Type Description
    Single

    hasAnimationFinished

    Declaration
    public bool hasAnimationFinished
    Field Value
    Type Description
    Boolean

    revolutions

    Declaration
    public int revolutions
    Field Value
    Type Description
    Int32

    rotationSpeedRawDegrees

    Declaration
    public float rotationSpeedRawDegrees
    Field Value
    Type Description
    Single

    spacingDegrees

    Declaration
    public float spacingDegrees
    Field Value
    Type Description
    Single

    testStop

    Declaration
    public bool testStop
    Field Value
    Type Description
    Boolean

    Properties

    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

    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

    StopOrbs()

    Declaration
    public void StopOrbs()

    Implements

    IProgressIndicator
    Back to top Generated by DocFX