mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Struct MixedRealityControllerVisualizationSetting

    Used to define a controller's visualization settings.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public struct MixedRealityControllerVisualizationSetting

    Constructors

    MixedRealityControllerVisualizationSetting(String, Type, Handedness, GameObject)

    Constructor.

    Declaration
    public MixedRealityControllerVisualizationSetting(string description, Type controllerType, Handedness handedness = null, GameObject overrideModel = null)
    Parameters
    Type Name Description
    String description

    Description of the Device.

    Type controllerType

    Controller Type to instantiate at runtime.

    Handedness handedness

    The designated hand that the device is managing.

    GameObject overrideModel

    The controller model prefab to be rendered.

    MixedRealityControllerVisualizationSetting(String, Type, Handedness, GameObject)

    Constructor.

    Declaration
    public MixedRealityControllerVisualizationSetting(string description, Type controllerType, Handedness handedness = null, GameObject overrideModel = null)
    Parameters
    Type Name Description
    String description

    Description of the Device.

    Type controllerType

    Controller Type to instantiate at runtime.

    Handedness handedness

    The designated hand that the device is managing.

    GameObject overrideModel

    The controller model prefab to be rendered.

    Properties

    ControllerType

    Controller Type to instantiate at runtime.

    Declaration
    public SystemType ControllerType { get; }
    Property Value
    Type Description
    SystemType

    ControllerType

    Controller Type to instantiate at runtime.

    Declaration
    public SystemType ControllerType { get; }
    Property Value
    Type Description
    SystemType

    ControllerVisualizationType

    The concrete Controller Visualizer component to use on the rendered controller model

    Declaration
    public SystemType ControllerVisualizationType { get; }
    Property Value
    Type Description
    SystemType

    ControllerVisualizationType

    The concrete Controller Visualizer component to use on the rendered controller model

    Declaration
    public SystemType ControllerVisualizationType { get; }
    Property Value
    Type Description
    SystemType

    DefaultModelMaterial

    The default controller model material when loading platform SDK controller models. This value is used as a fallback if no controller definition exists with a custom material type.

    Declaration
    public Material DefaultModelMaterial { get; }
    Property Value
    Type Description
    Material

    DefaultModelMaterial

    The default controller model material when loading platform SDK controller models. This value is used as a fallback if no controller definition exists with a custom material type.

    Declaration
    public Material DefaultModelMaterial { get; }
    Property Value
    Type Description
    Material

    Description

    Description of the Device.

    Declaration
    public string Description { get; }
    Property Value
    Type Description
    String

    Description

    Description of the Device.

    Declaration
    public string Description { get; }
    Property Value
    Type Description
    String

    Handedness

    The designated hand that the device is managing.

    Declaration
    public Handedness Handedness { get; }
    Property Value
    Type Description
    Handedness

    Handedness

    The designated hand that the device is managing.

    Declaration
    public Handedness Handedness { get; }
    Property Value
    Type Description
    Handedness

    OverrideControllerModel

    The controller model prefab to be rendered.

    Declaration
    public GameObject OverrideControllerModel { get; }
    Property Value
    Type Description
    GameObject

    OverrideControllerModel

    The controller model prefab to be rendered.

    Declaration
    public GameObject OverrideControllerModel { get; }
    Property Value
    Type Description
    GameObject

    UseDefaultModel

    Check to obtain controller models from the platform SDK. If left unchecked, the global models will be used.

    Declaration
    public bool UseDefaultModel { get; }
    Property Value
    Type Description
    Boolean

    UseDefaultModel

    Check to obtain controller models from the platform SDK. If left unchecked, the global models will be used.

    Declaration
    public bool UseDefaultModel { get; }
    Property Value
    Type Description
    Boolean
    In This Article
    • Constructors
      • MixedRealityControllerVisualizationSetting(String, Type, Handedness, GameObject)
      • MixedRealityControllerVisualizationSetting(String, Type, Handedness, GameObject)
    • Properties
      • ControllerType
      • ControllerType
      • ControllerVisualizationType
      • ControllerVisualizationType
      • DefaultModelMaterial
      • DefaultModelMaterial
      • Description
      • Description
      • Handedness
      • Handedness
      • OverrideControllerModel
      • OverrideControllerModel
      • UseDefaultModel
      • UseDefaultModel
    Back to top Generated by DocFX