Class MixedRealityControllerVisualizationProfile
Profile that determines relevant overrides and properties for controller visualization
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
[MixedRealityServiceProfile(typeof(IMixedRealityControllerVisualizer), null)]
public class MixedRealityControllerVisualizationProfile : BaseMixedRealityProfileProperties
ControllerVisualizationSettings
The current list of controller visualization settings.
Declaration
public MixedRealityControllerVisualizationSetting[] ControllerVisualizationSettings { get; }Property Value
| Type | Description |
|---|---|
| MixedRealityControllerVisualizationSetting[] |
DefaultControllerModelMaterial
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 DefaultControllerModelMaterial { get; }Property Value
| Type | Description |
|---|---|
| Material |
DefaultControllerVisualizationType
The default controller visualization type. This value is used as a fallback if no controller definition exists with a custom visualization type.
Declaration
public SystemType DefaultControllerVisualizationType { get; }Property Value
| Type | Description |
|---|---|
| SystemType |
GlobalLeftHandModel
The Default controller model when there is no specific controller model for the Left hand or when no hand is specified (Handedness = none)
Declaration
public GameObject GlobalLeftHandModel { get; }Property Value
| Type | Description |
|---|---|
| GameObject |
Remarks
If the default model for the left hand controller can not be found, the controller will fall back and use this for visualization.
GlobalLeftHandVisualizer
The Default controller model when there is no specific controller model for the Left hand or when no hand is specified (Handedness = none)
Declaration
public GameObject GlobalLeftHandVisualizer { get; }Property Value
| Type | Description |
|---|---|
| GameObject |
Remarks
If the default model for the left hand controller can not be found, the controller will fall back and use this for visualization.
GlobalRightHandModel
The Default controller model when there is no specific controller model for the Right hand.
Declaration
public GameObject GlobalRightHandModel { get; }Property Value
| Type | Description |
|---|---|
| GameObject |
Remarks
If the default model for the right hand controller can not be found, the controller will fall back and use this for visualization.
GlobalRightHandVisualizer
The Default hand model when there is no specific hand model for the Right hand.
Declaration
public GameObject GlobalRightHandVisualizer { get; }Property Value
| Type | Description |
|---|---|
| GameObject |
Remarks
If the default model for the right hand can not be found, the hand will fall back and use this for visualization.
RenderMotionControllers
Enable and configure the controller rendering of the Motion Controllers on Startup.
Declaration
public bool RenderMotionControllers { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
UseDefaultModels
Check to obtain controller models from the platform SDK. If left unchecked, the global models will be used. Note: this value is overridden by controller definitions.
Declaration
public bool UseDefaultModels { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
GetControllerModelOverride(Type, Handedness)
Gets the override model for a specific controller type and hand
Declaration
public GameObject GetControllerModelOverride(Type controllerType, Handedness hand)Parameters
| Type | Name | Description |
|---|---|---|
| Type | controllerType | The type of controller to query for |
| Handedness | hand | The specific hand assigned to the controller |
Returns
| Type | Description |
|---|---|
| GameObject |
GetControllerVisualizationTypeOverride(Type, Handedness)
Gets the override IMixedRealityControllerVisualizer type for a specific controller type and hand. If the requested controller type is not defined, DefaultControllerVisualizationType is returned.
Declaration
public SystemType GetControllerVisualizationTypeOverride(Type controllerType, Handedness hand)Parameters
| Type | Name | Description |
|---|---|---|
| Type | controllerType | The type of controller to query for |
| Handedness | hand | The specific hand assigned to the controller |
Returns
| Type | Description |
|---|---|
| SystemType |
GetDefaultControllerModelMaterialOverride(Type, Handedness)
Gets the DefaultModelMaterial value defined for the specified controller definition. If the requested controller type is not defined, the global DefaultControllerModelMaterial is returned.
Declaration
public Material GetDefaultControllerModelMaterialOverride(Type controllerType, Handedness hand)Parameters
| Type | Name | Description |
|---|---|---|
| Type | controllerType | The type of controller to query for |
| Handedness | hand | The specific hand assigned to the controller |
Returns
| Type | Description |
|---|---|
| Material |
GetUseDefaultModelsOverride(Type, Handedness)
Gets the UseDefaultModels value defined for the specified controller definition. If the requested controller type is not defined, the default UseDefaultModels is returned.
Declaration
public bool GetUseDefaultModelsOverride(Type controllerType, Handedness hand)Parameters
| Type | Name | Description |
|---|---|---|
| Type | controllerType | The type of controller to query for |
| Handedness | hand | The specific hand assigned to the controller |
Returns
| Type | Description |
|---|---|
| Boolean |