HandPhysicsService Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Extensions.HandPhysics

Assembly:

Microsoft.MixedReality.Toolkit.Extensions.HandPhysics.dll

A simple service that creates KinematicRigidbodies on fingertips for physics interactions.

public ref class HandPhysicsService : Microsoft::MixedReality::Toolkit::BaseExtensionService, IDisposable, Microsoft::MixedReality::Toolkit::Extensions::HandPhysics::IHandPhysicsService

[Microsoft.MixedReality.Toolkit.MixedRealityExtensionService(Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Hand Physics Service", "HandPhysicsService/Profiles/DefaultHandPhysicsServiceProfile.asset", "MixedRealityToolkit.Extensions", true)]
public class HandPhysicsService : Microsoft.MixedReality.Toolkit.BaseExtensionService, IDisposable, Microsoft.MixedReality.Toolkit.Extensions.HandPhysics.IHandPhysicsService

[<Microsoft.MixedReality.Toolkit.MixedRealityExtensionService(Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Hand Physics Service", "HandPhysicsService/Profiles/DefaultHandPhysicsServiceProfile.asset", "MixedRealityToolkit.Extensions", true)>]
type HandPhysicsService = class
    inherit BaseExtensionService
    interface IHandPhysicsService
    interface IMixedRealityExtensionService
    interface IMixedRealityService
    interface IDisposable

Public Class HandPhysicsService
Inherits BaseExtensionService
Implements IDisposable, IHandPhysicsService

Inheritance

Object

BaseService

BaseExtensionService

HandPhysicsService

Attributes

MixedRealityExtensionServiceAttribute

Implements

IHandPhysicsService IMixedRealityExtensionService IMixedRealityService IDisposable

Constructors

HandPhysicsService(String, UInt32, BaseMixedRealityProfile)

Constructor.

Fields

DefaultPriority	(Inherited from BaseService)
disposed	Value indicating if the object has completed disposal. (Inherited from BaseService)

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from BaseService)
FingerTipKinematicBodyPrefab	The prefab to represent each physics joints
HandPhysicsLayer	The LayerMask the physics joints will be on
HandPhysicsServiceRoot	The parent GameObject that contains all the physics joints
IsEnabled	Indicates whether or not the service is currently enabled. (Inherited from BaseService)
IsInitialized	Indicates whether or not the service has been initialized. (Inherited from BaseService)
IsMarkedDestroyed	Indicates whether or not the Destroy method been called on this service. (Inherited from BaseService)
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from BaseService)
PalmKinematicBodyPrefab	The prefab to represent the Palm physics joints
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from BaseService)
Registrar	Obsolete. The service registrar instance that registered this service. (Inherited from BaseExtensionService)
UsePalmKinematicBody	Whether to make the palm a physics joint

Methods

Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from BaseService)
Disable()	Optional Disable function to pause the service.
Dispose()	Cleanup resources used by this object. (Inherited from BaseService)
Dispose(Boolean)	Cleanup resources used by the object (Inherited from BaseService)
Enable()	Optional Enable function to enable / re-enable the service.
Initialize()	The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit.
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from BaseService)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from BaseService)
Update()	Optional Update function to perform per-frame updates of the service.