mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InteractableStates

    list of Interactable states and basic comparison

    Inheritance
    Object
    BaseStateModel
    InteractableStates
    Inherited Members
    BaseStateModel.currentState
    BaseStateModel.stateList
    BaseStateModel.ImportStates(List<State>)
    BaseStateModel.SetStateOn(Int32)
    BaseStateModel.SetStateOff(Int32)
    BaseStateModel.SetStateValue(Int32, Int32)
    BaseStateModel.SetStateListValue(Int32, Int32)
    BaseStateModel.GetStateValue(Int32)
    BaseStateModel.GetState(Int32)
    BaseStateModel.SetCurrentState(State)
    BaseStateModel.CurrentState()
    BaseStateModel.GetBit()
    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 InteractableStates : BaseStateModel

    Constructors

    InteractableStates()

    Declaration
    public InteractableStates()

    InteractableStates()

    Declaration
    public InteractableStates()

    InteractableStates(State)

    Declaration
    public InteractableStates(State defaultState)
    Parameters
    Type Name Description
    State defaultState

    InteractableStates(State)

    Declaration
    public InteractableStates(State defaultState)
    Parameters
    Type Name Description
    State defaultState

    Fields

    allStates

    Declaration
    protected State[] allStates
    Field Value
    Type Description
    State[]

    allStates

    Declaration
    protected State[] allStates
    Field Value
    Type Description
    State[]

    Methods

    CompareStates()

    Declaration
    public override State CompareStates()
    Returns
    Type Description
    State
    Overrides
    BaseStateModel.CompareStates()

    CompareStates()

    Declaration
    public override State CompareStates()
    Returns
    Type Description
    State
    Overrides
    BaseStateModel.CompareStates()

    GetDefaultStates()

    Returns the default states for InteractableStates. Default states are set on an interactable when it is created and no other list of states is specified. Default States should match "DefaultStates" scriptable object in Interactable

    Declaration
    public virtual List<State> GetDefaultStates()
    Returns
    Type Description
    List<State>

    GetDefaultStates()

    Returns the default states for InteractableStates. Default states are set on an interactable when it is created and no other list of states is specified. Default States should match "DefaultStates" scriptable object in Interactable

    Declaration
    public virtual List<State> GetDefaultStates()
    Returns
    Type Description
    List<State>

    GetState(InteractableStates.InteractableStateEnum)

    Declaration
    public State GetState(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state
    Returns
    Type Description
    State

    GetState(InteractableStates.InteractableStateEnum)

    Declaration
    public State GetState(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state
    Returns
    Type Description
    State

    GetStates()

    Declaration
    public override State[] GetStates()
    Returns
    Type Description
    State[]
    Overrides
    BaseStateModel.GetStates()

    GetStates()

    Declaration
    public override State[] GetStates()
    Returns
    Type Description
    State[]
    Overrides
    BaseStateModel.GetStates()

    SetStateOff(InteractableStates.InteractableStateEnum)

    Declaration
    public virtual void SetStateOff(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state

    SetStateOff(InteractableStates.InteractableStateEnum)

    Declaration
    public virtual void SetStateOff(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state

    SetStateOn(InteractableStates.InteractableStateEnum)

    Declaration
    public virtual void SetStateOn(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state

    SetStateOn(InteractableStates.InteractableStateEnum)

    Declaration
    public virtual void SetStateOn(InteractableStates.InteractableStateEnum state)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state

    SetStateValue(InteractableStates.InteractableStateEnum, Int32)

    Declaration
    public virtual void SetStateValue(InteractableStates.InteractableStateEnum state, int value)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state
    Int32 value

    SetStateValue(InteractableStates.InteractableStateEnum, Int32)

    Declaration
    public virtual void SetStateValue(InteractableStates.InteractableStateEnum state, int value)
    Parameters
    Type Name Description
    InteractableStates.InteractableStateEnum state
    Int32 value
    In This Article
    • Constructors
      • InteractableStates()
      • InteractableStates()
      • InteractableStates(State)
      • InteractableStates(State)
    • Fields
      • allStates
      • allStates
    • Methods
      • CompareStates()
      • CompareStates()
      • GetDefaultStates()
      • GetDefaultStates()
      • GetState(InteractableStates.InteractableStateEnum)
      • GetState(InteractableStates.InteractableStateEnum)
      • GetStates()
      • GetStates()
      • SetStateOff(InteractableStates.InteractableStateEnum)
      • SetStateOff(InteractableStates.InteractableStateEnum)
      • SetStateOn(InteractableStates.InteractableStateEnum)
      • SetStateOn(InteractableStates.InteractableStateEnum)
      • SetStateValue(InteractableStates.InteractableStateEnum, Int32)
      • SetStateValue(InteractableStates.InteractableStateEnum, Int32)
    Back to top Generated by DocFX