mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InteractableGrabScaleTheme

    ThemeEngine to control initialized GameObject's scale based on associated Interactable grab state and related state changes

    Inheritance
    Object
    InteractableThemeBase
    InteractableGrabScaleTheme
    Inherited Members
    InteractableThemeBase.Types
    InteractableThemeBase.Name
    InteractableThemeBase.StateProperties
    InteractableThemeBase.Properties
    InteractableThemeBase.Host
    InteractableThemeBase.Ease
    InteractableThemeBase.Loaded
    InteractableThemeBase.IsEasingSupported
    InteractableThemeBase.AreShadersSupported
    InteractableThemeBase.CreateTheme(Type)
    InteractableThemeBase.CreateAndInitTheme(ThemeDefinition, GameObject)
    InteractableThemeBase.LerpFloat(Single, Single, Single)
    InteractableThemeBase.LerpInt(Int32, Int32, Single)
    InteractableThemeBase.originalStateValues
    InteractableThemeBase.Reset()
    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 InteractableGrabScaleTheme : InteractableThemeBase

    Constructors

    InteractableGrabScaleTheme()

    Declaration
    public InteractableGrabScaleTheme()

    InteractableGrabScaleTheme()

    Declaration
    public InteractableGrabScaleTheme()

    Fields

    grabPercentage

    Declaration
    protected float grabPercentage
    Field Value
    Type Description
    Single

    grabPercentage

    Declaration
    protected float grabPercentage
    Field Value
    Type Description
    Single

    grabTransition

    Declaration
    protected bool grabTransition
    Field Value
    Type Description
    Boolean

    grabTransition

    Declaration
    protected bool grabTransition
    Field Value
    Type Description
    Boolean

    hasGrab

    Declaration
    protected bool hasGrab
    Field Value
    Type Description
    Boolean

    hasGrab

    Declaration
    protected bool hasGrab
    Field Value
    Type Description
    Boolean

    originalLocalScale

    Declaration
    protected Vector3 originalLocalScale
    Field Value
    Type Description
    Vector3

    startScaleValue

    Declaration
    [Obsolete("startScaleValue is no longer supported. Use originalLocalScale instead.")]
    protected ThemePropertyValue startScaleValue
    Field Value
    Type Description
    ThemePropertyValue

    startScaleValue

    Declaration
    [Obsolete("startScaleValue is no longer supported. Use originalLocalScale instead.")]
    protected ThemePropertyValue startScaleValue
    Field Value
    Type Description
    ThemePropertyValue

    targetInteractable

    Declaration
    protected Interactable targetInteractable
    Field Value
    Type Description
    Interactable

    targetInteractable

    Declaration
    protected Interactable targetInteractable
    Field Value
    Type Description
    Interactable

    timer

    Declaration
    protected float timer
    Field Value
    Type Description
    Single

    timer

    Declaration
    protected float timer
    Field Value
    Type Description
    Single

    Methods

    GetDefaultThemeDefinition()

    Declaration
    public override ThemeDefinition GetDefaultThemeDefinition()
    Returns
    Type Description
    ThemeDefinition
    Overrides
    InteractableThemeBase.GetDefaultThemeDefinition()

    GetDefaultThemeDefinition()

    Declaration
    public override ThemeDefinition GetDefaultThemeDefinition()
    Returns
    Type Description
    ThemeDefinition
    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)

    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)

    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)

    OnUpdate(Int32, Boolean)

    Declaration
    public override void OnUpdate(int state, bool force = false)
    Parameters
    Type Name Description
    Int32 state
    Boolean force
    Overrides
    InteractableThemeBase.OnUpdate(Int32, Boolean)

    OnUpdate(Int32, Boolean)

    Declaration
    public override void OnUpdate(int state, bool force = false)
    Parameters
    Type Name Description
    Int32 state
    Boolean force
    Overrides
    InteractableThemeBase.OnUpdate(Int32, Boolean)

    SetValue(ThemeStateProperty, ThemePropertyValue)

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

    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)

    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)
    In This Article
    • Constructors
      • InteractableGrabScaleTheme()
      • InteractableGrabScaleTheme()
    • Fields
      • grabPercentage
      • grabPercentage
      • grabTransition
      • grabTransition
      • hasGrab
      • hasGrab
      • originalLocalScale
      • startScaleValue
      • startScaleValue
      • targetInteractable
      • targetInteractable
      • timer
      • timer
    • Methods
      • GetDefaultThemeDefinition()
      • GetDefaultThemeDefinition()
      • GetProperty(ThemeStateProperty)
      • GetProperty(ThemeStateProperty)
      • Init(GameObject, ThemeDefinition)
      • Init(GameObject, ThemeDefinition)
      • OnUpdate(Int32, Boolean)
      • OnUpdate(Int32, Boolean)
      • SetValue(ThemeStateProperty, ThemePropertyValue)
      • SetValue(ThemeStateProperty, Int32, Single)
      • SetValue(ThemeStateProperty, Int32, Single)
    Back to top Generated by DocFX