MixedRealityControllerVisualizer Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.SDK.dll

The Mixed Reality Visualization component is primarily responsible for synchronizing the user's current input with controller models.

public ref class MixedRealityControllerVisualizer : Microsoft::MixedReality::Toolkit::Input::ControllerPoseSynchronizer, Microsoft::MixedReality::Toolkit::Input::IMixedRealityControllerVisualizer

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/MixedRealityControllerVisualizer")]
public class MixedRealityControllerVisualizer : Microsoft.MixedReality.Toolkit.Input.ControllerPoseSynchronizer, Microsoft.MixedReality.Toolkit.Input.IMixedRealityControllerVisualizer

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/MixedRealityControllerVisualizer")>]
type MixedRealityControllerVisualizer = class
    inherit ControllerPoseSynchronizer
    interface IMixedRealityControllerVisualizer

Public Class MixedRealityControllerVisualizer
Inherits ControllerPoseSynchronizer
Implements IMixedRealityControllerVisualizer

Inheritance

UnityEngine.MonoBehaviour

InputSystemGlobalHandlerListener

ControllerPoseSynchronizer

MixedRealityControllerVisualizer

Derived

Microsoft.MixedReality.Toolkit.Input.WindowsMixedRealityControllerVisualizer

Attributes

UnityEngine.AddComponentMenuAttribute

Implements

IMixedRealityControllerVisualizer

Constructors

MixedRealityControllerVisualizer()

Fields

rotationOffset	The amount to offset this controller visualizer's rotation from the input pose
TrackingState	The current tracking state of the assigned IMixedRealityController (Inherited from ControllerPoseSynchronizer)

Properties

Controller	The current controller reference. (Inherited from ControllerPoseSynchronizer)
DestroyOnSourceLost	Should this GameObject clean itself up when its controller is lost? (Inherited from ControllerPoseSynchronizer)
GameObjectProxy	The GameObject reference for this controller.
Handedness	The controller handedness this component is synchronized with. (Inherited from ControllerPoseSynchronizer)
IsTracked	Is the controller this Synchronizer is registered to currently tracked? (Inherited from ControllerPoseSynchronizer)
PoseAction	The input action that will drive the Transform's pose, position, or rotation. (Inherited from ControllerPoseSynchronizer)
RotationOffset
UseSourcePoseAsFallback	Should the Transform's position use the source pose by default until the input handler events are received? (Inherited from ControllerPoseSynchronizer)
UseSourcePoseData	Should the Transform's position be driven from the source pose or from input handler? (Inherited from ControllerPoseSynchronizer)

Methods

EnsureInputSystemValid()	A task that will only complete when the input system has in a valid state. (Inherited from InputSystemGlobalHandlerListener)
InputEventDataUsable<T>(InputEventData<T>)	Helper function used to determine whether or not the controller pose synchronizer is configured to make use of the InputEventData (Inherited from ControllerPoseSynchronizer)
OnDisable()	(Inherited from InputSystemGlobalHandlerListener)
OnEnable()	(Inherited from InputSystemGlobalHandlerListener)
OnInputChanged(InputEventData<MixedRealityPose>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Quaternion>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Single>)	Visualize single axis controls on the controller model, if supported
OnInputChanged(InputEventData<Vector2>)	Visualize the movement of a dual axis input on the controller model, if supported
OnInputChanged(InputEventData<Vector3>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputDown(InputEventData)	Visualize digital and single axis controls down state on the controller model, if supported
OnInputUp(InputEventData)	Visualize digital and single axis controls up state on the controller model, if supported
OnSourceDetected(SourceStateEventData)	Raised when a source is detected. (Inherited from ControllerPoseSynchronizer)
OnSourceLost(SourceStateEventData)	Raised when a source is lost. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<MixedRealityPose>)	Raised when the source pose is changed.
OnSourcePoseChanged(SourcePoseEventData<Quaternion>)	Raised when the source rotation is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<TrackingState>)	Raised when the source pose tracking state is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<Vector2>)	Raised when the source position is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<Vector3>)	Raised when the source position is changed. (Inherited from ControllerPoseSynchronizer)
RegisterHandlers()	Overload this method to specify, which global events component wants to listen to. Use RegisterHandler API of InputSystem (Inherited from ControllerPoseSynchronizer)
SourcePoseDataUsable<T>(SourcePoseEventData<T>)	Helper function used to determine whether or not the controller pose synchronizer is configured to make use of the SourcePoseEventData (Inherited from ControllerPoseSynchronizer)
Start()	(Inherited from InputSystemGlobalHandlerListener)
UnregisterHandlers()	Overload this method to specify, which global events component should stop listening to. Use UnregisterHandler API of InputSystem (Inherited from ControllerPoseSynchronizer)

See also

• MixedRealityControllerMappingProfile