InteractableAudioTheme Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.UI

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class InteractableAudioTheme : Microsoft::MixedReality::Toolkit::UI::InteractableThemeBase

public class InteractableAudioTheme : Microsoft.MixedReality.Toolkit.UI.InteractableThemeBase

type InteractableAudioTheme = class
    inherit InteractableThemeBase

Public Class InteractableAudioTheme
Inherits InteractableThemeBase

Inheritance: Object

InteractableThemeBase
InteractableAudioTheme

Constructors

InteractableAudioTheme()

Fields

originalStateValues

(Inherited from InteractableThemeBase)

Properties

AreShadersSupported	Indicates whether the current Theme engine implementation supports shader targeting on state properties (Inherited from InteractableThemeBase)
Ease	Defines how to ease between values during state changes (Inherited from InteractableThemeBase)
Host	GameObject initialized with this ThemeEngine and being targeted based on state changes (Inherited from InteractableThemeBase)
IsEasingSupported	Indicates whether the current Theme engine implementation supports easing between state values
Loaded	True if Theme Engine has been initialized, false otherwise (Inherited from InteractableThemeBase)
Name	Name of Theme Engine (Inherited from InteractableThemeBase)
Properties	List of global Theme Engine properties (Inherited from InteractableThemeBase)
StateProperties	List of Properties with values per state (Inherited from InteractableThemeBase)
Types	Types of component this Theme Engine will target on the initialized GameObject or related GameObjects (Inherited from InteractableThemeBase)

Methods

GetDefaultThemeDefinition()	Generates the default theme definition configuration for the current theme implementation
GetProperty(ThemeStateProperty)
GetThemeProperty(Int32)	(Inherited from InteractableThemeBase)
Init(GameObject, ThemeDefinition)
LerpFloat(Single, Single, Single)	(Inherited from InteractableThemeBase)
LerpInt(Int32, Int32, Single)	(Inherited from InteractableThemeBase)
OnUpdate(Int32, Boolean)	Update ThemeEngine for given state based on Theme logic. Check, sets, and possibly eases values based on given state (Inherited from InteractableThemeBase)
Reset()	Resets properties on Host GameObject to their original values when Init() was called for this theme engine. Useful for reverting changes done by this theme engine. (Inherited from InteractableThemeBase)
SetValue(ThemeStateProperty, Int32, Single)	Instruct theme to set value for current property with given index state and at given lerp percentage
SetValue(ThemeStateProperty, ThemePropertyValue)	Instruct theme to set value for current property with ThemePropertyValue value provided

Applies to