VRTK_ChildOfControllerGrabAttach

extends VRTK_BaseGrabAttach

Overview

Sets the grabbed Interactable Object to be a child of the grabbing object.

The Interactable Object will have 1:1 tracking of the grabbing object, however it will also have reduced collision detection and will be able to pass through other colliders.

Script Usage:

• Place the VRTK_ChildOfControllerGrabAttach script on either:
  • The GameObject of the Interactable Object to detect interactions on.
  • Any other scene GameObject and then link that GameObject to the Interactable Objects Grab Attach Mechanic Script parameter to denote use of the grab mechanic.

Class Methods

StartGrab/3

public override bool StartGrab(GameObject grabbingObject, GameObject givenGrabbedObject, Rigidbody givenControllerAttachPoint)

• Parameters
  • GameObject grabbingObject - The GameObject that is doing the grabbing.
  • GameObject givenGrabbedObject - The GameObject that is being grabbed.
  • Rigidbody givenControllerAttachPoint - The point on the grabbing object that the grabbed object should be attached to after grab occurs.
• Returns
  • bool - Returns true if the grab is successful, false if the grab is unsuccessful.

The StartGrab method sets up the grab attach mechanic as soon as an Interactable Object is grabbed. It is also responsible for creating the joint on the grabbed object.

StopGrab/1

public override void StopGrab(bool applyGrabbingObjectVelocity)

• Parameters
  • bool applyGrabbingObjectVelocity - If true will apply the current velocity of the grabbing object to the grabbed object on release.
• Returns
  • none

The StopGrab method ends the grab of the current Interactable Object and cleans up the state.

Example

VRTK/Examples/023_Controller_ChildOfControllerOnGrab uses this grab attach mechanic for the bow and the arrow.