API reference
API reference
Select your platform
No SDKs available
No versions available

RigidbodyKinematicLockerExtension Class

Extension methods for Rigidbody to easily manage kinematic locking through the RigidbodyKinematicLocker component.

Static Methods

IsLocked ( rigidbody )
Check whether the kinematic state of the Rigidbody is locked by some other caller.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it returns false.
Signature
static bool Oculus.Interaction.RigidbodyKinematicLockerExtension.IsLocked(this Rigidbody rigidbody)
Parameters
rigidbody: this Rigidbody  The Rigidbody to check lock status on.
Returns
bool  Whether the rigidbody is currently locked
LockKinematic ( rigidbody )
Locks to true the kinematic state of the Rigidbody this method is called on.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it adds one.
Signature
static void Oculus.Interaction.RigidbodyKinematicLockerExtension.LockKinematic(this Rigidbody rigidbody)
Parameters
rigidbody: this Rigidbody  The Rigidbody to lock the kinematic state on.
Returns
void
UnlockKinematic ( rigidbody )
Unlocks the kinematic state of the Rigidbody this method is called on.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it logs an error.
Signature
static void Oculus.Interaction.RigidbodyKinematicLockerExtension.UnlockKinematic(this Rigidbody rigidbody)
Parameters
rigidbody: this Rigidbody  The Rigidbody to unlock the kinematic state on.
Returns
void