mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class States

    States scriptableObject for storing available states and related state model

    Inheritance
    Object
    States
    Implements
    ScriptableObject
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class States : ScriptableObject, ScriptableObject

    Constructors

    States()

    Declaration
    public States()

    States()

    Declaration
    public States()

    Properties

    DefaultIndex

    Default index into state list

    Declaration
    public int DefaultIndex { get; set; }
    Property Value
    Type Description
    Int32

    DefaultIndex

    Default index into state list

    Declaration
    public int DefaultIndex { get; set; }
    Property Value
    Type Description
    Int32

    StateList

    List of available states defined by asset

    Declaration
    public List<State> StateList { get; set; }
    Property Value
    Type Description
    List<State>

    StateList

    List of available states defined by asset

    Declaration
    public List<State> StateList { get; set; }
    Property Value
    Type Description
    List<State>

    StateModelType

    Defines the type of State Model to associate with this States asset. Type must be a class that extends InteractableStateModel

    Declaration
    public Type StateModelType { get; set; }
    Property Value
    Type Description
    Type

    StateModelType

    Defines the type of State Model to associate with this States asset. Type must be a class that extends InteractableStateModel

    Declaration
    public Type StateModelType { get; set; }
    Property Value
    Type Description
    Type

    Methods

    CreateStateModel()

    Create a State Model class and initialize it with the configuration data from this States ScriptableObject

    Declaration
    public BaseStateModel CreateStateModel()
    Returns
    Type Description
    BaseStateModel

    BaseStateModel or inherited class implementation object initialized with the StateList in this ScriptableObject

    CreateStateModel()

    Create a State Model class and initialize it with the configuration data from this States ScriptableObject

    Declaration
    public BaseStateModel CreateStateModel()
    Returns
    Type Description
    BaseStateModel

    BaseStateModel or inherited class implementation object initialized with the StateList in this ScriptableObject

    Equals(States)

    Test whether the current States object and the argument States object have the same internal values and configurations

    Declaration
    public bool Equals(States other)
    Parameters
    Type Name Description
    States other

    other States object to compare against self

    Returns
    Type Description
    Boolean

    true if internal list of state values and class configuration matches other, false otherwise

    Equals(States)

    Test whether the current States object and the argument States object have the same internal values and configurations

    Declaration
    public bool Equals(States other)
    Parameters
    Type Name Description
    States other

    other States object to compare against self

    Returns
    Type Description
    Boolean

    true if internal list of state values and class configuration matches other, false otherwise

    GetStates()

    Declaration
    [Obsolete("Use the StateList property instead")]
    public State[] GetStates()
    Returns
    Type Description
    State[]

    GetStates()

    Declaration
    [Obsolete("Use the StateList property instead")]
    public State[] GetStates()
    Returns
    Type Description
    State[]

    Implements

    ScriptableObject
    In This Article
    • Constructors
      • States()
      • States()
    • Properties
      • DefaultIndex
      • DefaultIndex
      • StateList
      • StateList
      • StateModelType
      • StateModelType
    • Methods
      • CreateStateModel()
      • CreateStateModel()
      • Equals(States)
      • Equals(States)
      • GetStates()
      • GetStates()
    • Implements
    Back to top Generated by DocFX