We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class InteractableAudioTheme

    Theme Engine to play particular audio files based on state changes. Add AudioSource component if none is found on initialized GameObject or in children

    Inheritance
    Object
    InteractableThemeBase
    InteractableAudioTheme
    Inherited Members
    InteractableThemeBase.Types
    InteractableThemeBase.Name
    InteractableThemeBase.StateProperties
    InteractableThemeBase.Properties
    InteractableThemeBase.Host
    InteractableThemeBase.Ease
    InteractableThemeBase.Loaded
    InteractableThemeBase.AreShadersSupported
    InteractableThemeBase.CreateTheme(Type)
    InteractableThemeBase.CreateAndInitTheme(ThemeDefinition, GameObject)
    InteractableThemeBase.OnUpdate(Int32, Boolean)
    InteractableThemeBase.LerpFloat(Single, Single, Single)
    InteractableThemeBase.LerpInt(Int32, Int32, Single)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class InteractableAudioTheme : InteractableThemeBase

    Constructors

    InteractableAudioTheme()

    Declaration
    public InteractableAudioTheme()

    Properties

    IsEasingSupported

    Indicates whether the current Theme engine implementation supports easing between state values

    Declaration
    public override bool IsEasingSupported { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    InteractableThemeBase.IsEasingSupported

    Methods

    GetDefaultThemeDefinition()

    Generates the default theme definition configuration for the current theme implementation

    Declaration
    public override ThemeDefinition GetDefaultThemeDefinition()
    Returns
    Type Description
    ThemeDefinition

    Default ThemeDefinition to initialize with the current theme engine implementation

    Overrides
    InteractableThemeBase.GetDefaultThemeDefinition()

    GetProperty(ThemeStateProperty)

    Declaration
    public override ThemePropertyValue GetProperty(ThemeStateProperty property)
    Parameters
    Type Name Description
    ThemeStateProperty property
    Returns
    Type Description
    ThemePropertyValue
    Overrides
    InteractableThemeBase.GetProperty(ThemeStateProperty)

    Init(GameObject, ThemeDefinition)

    Declaration
    public override void Init(GameObject host, ThemeDefinition settings)
    Parameters
    Type Name Description
    GameObject host
    ThemeDefinition settings
    Overrides
    InteractableThemeBase.Init(GameObject, ThemeDefinition)

    SetValue(ThemeStateProperty, Int32, Single)

    Declaration
    public override void SetValue(ThemeStateProperty property, int index, float percentage)
    Parameters
    Type Name Description
    ThemeStateProperty property
    Int32 index
    Single percentage
    Overrides
    InteractableThemeBase.SetValue(ThemeStateProperty, Int32, Single)
    Back to top Generated by DocFX