Struct ThemeDefinition
Defines configuration properties and settings to use when initializing a class extending InteractableThemeBase
Implements
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.UI
Assembly: cs.temp.dll.dll
Syntax
[Serializable]
[Serializable]
public struct ThemeDefinition : ISerializationCallbackReceiver
Properties
CustomProperties
List of single-value properties defined for the entire Theme engine regardless of the current state
Declaration
public List<ThemeProperty> CustomProperties { get; set; }
Property Value
Type | Description |
---|---|
List<ThemeProperty> |
CustomProperties
List of single-value properties defined for the entire Theme engine regardless of the current state
Declaration
public List<ThemeProperty> CustomProperties { get; set; }
Property Value
Type | Description |
---|---|
List<ThemeProperty> |
Easing
Object to configure easing between values. Type of Theme Engine, as defined by the ThemeType property, must have IsEasingSupported set to true
Declaration
public Easing Easing { get; set; }
Property Value
Type | Description |
---|---|
Easing |
Easing
Object to configure easing between values. Type of Theme Engine, as defined by the ThemeType property, must have IsEasingSupported set to true
Declaration
public Easing Easing { get; set; }
Property Value
Type | Description |
---|---|
Easing |
StateProperties
List of properties with values defined per state index (Example list of colors for different states)
Declaration
public List<ThemeStateProperty> StateProperties { get; set; }
Property Value
Type | Description |
---|---|
List<ThemeStateProperty> |
StateProperties
List of properties with values defined per state index (Example list of colors for different states)
Declaration
public List<ThemeStateProperty> StateProperties { get; set; }
Property Value
Type | Description |
---|---|
List<ThemeStateProperty> |
ThemeType
Defines the type of Theme to associate with this definition. Type must be a class that extends InteractableThemeBase
Declaration
public Type ThemeType { get; set; }
Property Value
Type | Description |
---|---|
Type |
ThemeType
Defines the type of Theme to associate with this definition. Type must be a class that extends InteractableThemeBase
Declaration
public Type ThemeType { get; set; }
Property Value
Type | Description |
---|---|
Type |
Methods
GetDefaultThemeDefinition(Type)
Utility function to generate the default ThemeDefinition configuration for the provided type of Theme engine
Declaration
public static ThemeDefinition? GetDefaultThemeDefinition(Type themeType)
Parameters
Type | Name | Description |
---|---|---|
Type | themeType | type of Theme Engine to build default configuration for |
Returns
Type | Description |
---|---|
Nullable<ThemeDefinition> | Default ThemeDefinition configuration for the provided them type |
GetDefaultThemeDefinition(Type)
Utility function to generate the default ThemeDefinition configuration for the provided type of Theme engine
Declaration
public static ThemeDefinition? GetDefaultThemeDefinition(Type themeType)
Parameters
Type | Name | Description |
---|---|---|
Type | themeType | type of Theme Engine to build default configuration for |
Returns
Type | Description |
---|---|
Nullable<ThemeDefinition> | Default ThemeDefinition configuration for the provided them type |
GetDefaultThemeDefinition<T>()
Utility function to generate the default ThemeDefinition configuration for the provided type of Theme engine
Declaration
public static ThemeDefinition? GetDefaultThemeDefinition<T>()
where T : InteractableThemeBase
Returns
Type | Description |
---|---|
Nullable<ThemeDefinition> | Default ThemeDefinition configuration for the provided them type |
Type Parameters
Name | Description |
---|---|
T | type of Theme Engine to build default configuration for |
GetDefaultThemeDefinition<T>()
Utility function to generate the default ThemeDefinition configuration for the provided type of Theme engine
Declaration
public static ThemeDefinition? GetDefaultThemeDefinition<T>()
where T : InteractableThemeBase
Returns
Type | Description |
---|---|
Nullable<ThemeDefinition> | Default ThemeDefinition configuration for the provided them type |
Type Parameters
Name | Description |
---|---|
T | type of Theme Engine to build default configuration for |