mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0releases/2.3.0releases/2.4.0releases/2.5.0releases/2.5.1releases/2.5.2releases/2.5.3

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.

Search Results for

    Show / Hide Table of Contents

    Class InteractableColorChildrenTheme

    Theme engine to control the color for all Renderer children under the initialized GameObject based on state changes

    Inheritance
    Object
    InteractableThemeBase
    InteractableShaderTheme
    InteractableColorChildrenTheme
    Inherited Members
    InteractableShaderTheme.AreShadersSupported
    InteractableShaderTheme.propertyBlock
    InteractableShaderTheme.shaderProperties
    InteractableShaderTheme.renderer
    InteractableShaderTheme.GetFloat(GameObject, Int32)
    InteractableShaderTheme.GetColor(GameObject, Int32)
    InteractableThemeBase.Types
    InteractableThemeBase.Name
    InteractableThemeBase.StateProperties
    InteractableThemeBase.Properties
    InteractableThemeBase.Host
    InteractableThemeBase.Ease
    InteractableThemeBase.Loaded
    InteractableThemeBase.IsEasingSupported
    InteractableThemeBase.originalStateValues
    InteractableThemeBase.CreateTheme(Type)
    InteractableThemeBase.CreateAndInitTheme(ThemeDefinition, GameObject)
    InteractableThemeBase.OnUpdate(Int32, Boolean)
    InteractableThemeBase.LerpFloat(Single, Single, Single)
    InteractableThemeBase.LerpInt(Int32, Int32, Single)
    InteractableThemeBase.GetThemeProperty(Int32)
    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 InteractableColorChildrenTheme : InteractableShaderTheme

    Constructors

    InteractableColorChildrenTheme()

    Declaration
    public InteractableColorChildrenTheme()

    Fields

    DefaultShaderProperty

    Declaration
    protected const string DefaultShaderProperty = "_Color"
    Field Value
    Type Description
    String

    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
    InteractableShaderTheme.GetDefaultThemeDefinition()

    GetProperty(ThemeStateProperty)

    Get the current property value for the provided state property

    Declaration
    public override ThemePropertyValue GetProperty(ThemeStateProperty property)
    Parameters
    Type Name Description
    ThemeStateProperty property

    state property to access

    Returns
    Type Description
    ThemePropertyValue

    Value currently for given state property

    Overrides
    InteractableShaderTheme.GetProperty(ThemeStateProperty)

    Init(GameObject, ThemeDefinition)

    Initialize current Theme Engine with given configuration and target the provided GameObject

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

    GameObject to target changes against

    ThemeDefinition settings
    Overrides
    InteractableShaderTheme.Init(GameObject, ThemeDefinition)

    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.

    Declaration
    public override void Reset()
    Overrides
    InteractableThemeBase.Reset()

    SetValue(ThemeStateProperty, ThemePropertyValue)

    Instruct theme to set value for current property with ThemePropertyValue value provided

    Declaration
    protected override void SetValue(ThemeStateProperty property, ThemePropertyValue value)
    Parameters
    Type Name Description
    ThemeStateProperty property

    property to update value

    ThemePropertyValue value

    Value for theme to set

    Overrides
    InteractableShaderTheme.SetValue(ThemeStateProperty, ThemePropertyValue)

    SetValue(ThemeStateProperty, Int32, Single)

    Instruct theme to set value for current property with given index state and at given lerp percentage

    Declaration
    public override void SetValue(ThemeStateProperty property, int index, float percentage)
    Parameters
    Type Name Description
    ThemeStateProperty property

    property to update value

    Int32 index

    index of state to access array of values

    Single percentage

    percentage transition between values

    Overrides
    InteractableShaderTheme.SetValue(ThemeStateProperty, Int32, Single)
    In This Article
    • Constructors
      • InteractableColorChildrenTheme()
    • Fields
      • DefaultShaderProperty
    • Methods
      • GetDefaultThemeDefinition()
      • GetProperty(ThemeStateProperty)
      • Init(GameObject, ThemeDefinition)
      • Reset()
      • SetValue(ThemeStateProperty, ThemePropertyValue)
      • SetValue(ThemeStateProperty, Int32, Single)
    Back to top Generated by DocFX