InteractableStates Class

Definition

list of Interactable states and basic comparison

C++
public ref class InteractableStates : Microsoft::MixedReality::Toolkit::UI::BaseStateModel
Inheritance
InteractableStates

Constructors

Fields

allStates
currentState (Inherited from BaseStateModel)
stateList (Inherited from BaseStateModel)

Methods

CompareStates()

Compare all state values, set appropriate current State and return that current State

CurrentState()

Return the current State object

(Inherited from BaseStateModel)
GetBit() (Inherited from BaseStateModel)
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

GetState(Int32)

Get the State object with the given index

(Inherited from BaseStateModel)
GetState(InteractableStates+InteractableStateEnum) System.Object.GetState(System.Object.InteractableStateEnum)
GetStates()

Get list of available States for this State Model

GetStateValue(Int32)

Get the value of the state with the given index

(Inherited from BaseStateModel)
ImportStates(List<State>)

Import the list of states into this state model

(Inherited from BaseStateModel)
SetCurrentState(State)

Set the current state to the provided State object

(Inherited from BaseStateModel)
SetStateListValue(Int32, Int32) (Inherited from BaseStateModel)
SetStateOff(Int32)

Set the value of the state with given index to off (0)

(Inherited from BaseStateModel)
SetStateOff(InteractableStates+InteractableStateEnum) System.Object.SetStateOff(System.Object.InteractableStateEnum)
SetStateOn(Int32)

Set the value of the state with given index to on (1)

(Inherited from BaseStateModel)
SetStateOn(InteractableStates+InteractableStateEnum) System.Object.SetStateOn(System.Object.InteractableStateEnum)
SetStateValue(Int32, Int32)

Set value of state with given index to the provided value

(Inherited from BaseStateModel)
SetStateValue(InteractableStates+InteractableStateEnum, Int32) System.Object.SetStateValue(System.Object.InteractableStateEnum,System.Int32)

Applies to

Produit Versions
MRTK2 Unity 2018 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0