InteractableThemeBase Class
Definition
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.
Base abstract class for all Theme Engines. Extend to create custom Theme logic
public ref class InteractableThemeBase abstract
public abstract class InteractableThemeBase
type InteractableThemeBase = class
Public MustInherit Class InteractableThemeBase
- Inheritance
-
InteractableThemeBase
- Derived
Constructors
InteractableThemeBase() |
Fields
originalStateValues |
Properties
AreShadersSupported |
Indicates whether the current Theme engine implementation supports shader targeting on state properties |
Ease |
Defines how to ease between values during state changes |
Host |
GameObject initialized with this ThemeEngine and being targeted based on state changes |
IsEasingSupported |
Indicates whether the current Theme engine implementation supports easing between state values |
Loaded |
True if Theme Engine has been initialized, false otherwise |
Name |
Name of Theme Engine |
Properties |
List of global Theme Engine properties |
StateProperties |
List of Properties with values per state |
Types |
Types of component this Theme Engine will target on the initialized GameObject or related GameObjects |
Methods
CreateAndInitTheme(ThemeDefinition, GameObject) |
Helper method to create and initialize a Theme Engine for given configuration and targeted GameObject |
CreateTheme(Type) |
Helper method to instantiate a Theme Engine of provided type. Type must extend InteractableThemeBase |
GetDefaultThemeDefinition() |
Generates the default theme definition configuration for the current theme implementation |
GetProperty(ThemeStateProperty) |
Get the current property value for the provided state property |
GetThemeProperty(Int32) | |
Init(GameObject, ThemeDefinition) |
Initialize current Theme Engine with given configuration and target the provided GameObject |
LerpFloat(Single, Single, Single) | |
LerpInt(Int32, Int32, Single) | |
OnUpdate(Int32, Boolean) |
Update ThemeEngine for given state based on Theme logic. Check, sets, and possibly eases values based on given state |
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. |
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 |