{"_id":"594949e82be16d0026ec052e","category":{"_id":"594949e62be16d0026ec04d7","version":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T16:55:17.729Z","from_sync":false,"order":9,"slug":"secondary-controller-grab-actions","title":"Secondary Controller Grab Actions"},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"_id":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":2,"createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["594949e62be16d0026ec04ce","594949e62be16d0026ec04cf","594949e62be16d0026ec04d0","594949e62be16d0026ec04d1","594949e62be16d0026ec04d2","594949e62be16d0026ec04d3","594949e62be16d0026ec04d4","594949e62be16d0026ec04d5","594949e62be16d0026ec04d6","594949e62be16d0026ec04d7","594949e62be16d0026ec04d8","594949e62be16d0026ec04d9","594949e62be16d0026ec04da","594949e62be16d0026ec04db","594949e62be16d0026ec04dc","594949e62be16d0026ec04dd","594949e62be16d0026ec04de","594949e62be16d0026ec04df","594949e62be16d0026ec04e0","594949e62be16d0026ec04e1","59497219f4a8980024dd0631"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Kunekune","version_clean":"3.2.0","version":"3.2.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T16:57:01.226Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"## Overview\n\nThe Base Grab Action is an abstract class that all other secondary controller actions inherit and are required to implement the public abstract methods.\n\nAs this is an abstract class, it cannot be applied directly to a game object and performs no logic.\n\n## Class Methods\n\n### Initialise/5\n\n  > `public virtual void Initialise(VRTK_InteractableObject currentGrabbdObject, VRTK_InteractGrab currentPrimaryGrabbingObject, VRTK_InteractGrab currentSecondaryGrabbingObject, Transform primaryGrabPoint, Transform secondaryGrabPoint)`\n\n  * Parameters\n   * `VRTK_InteractableObject currentGrabbdObject` - The Interactable Object script for the object currently being grabbed by the primary controller.\n   * `VRTK_InteractGrab currentPrimaryGrabbingObject` - The Interact Grab script for the object that is associated with the primary controller.\n   * `VRTK_InteractGrab currentSecondaryGrabbingObject` - The Interact Grab script for the object that is associated with the secondary controller.\n   * `Transform primaryGrabPoint` - The point on the object where the primary controller initially grabbed the object.\n   * `Transform secondaryGrabPoint` - The point on the object where the secondary controller initially grabbed the object.\n  * Returns\n   * _none_\n\nThe Initalise method is used to set up the state of the secondary action when the object is initially grabbed by a secondary controller.\n\n### ResetAction/0\n\n  > `public virtual void ResetAction()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe ResetAction method is used to reset the secondary action when the object is no longer grabbed by a secondary controller.\n\n### IsActionable/0\n\n  > `public virtual bool IsActionable()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * `bool` - Is true if the secondary grab action does perform an action on secondary grab.\n\nThe IsActionable method is used to determine if the secondary grab action performs an action on grab.\n\n### IsSwappable/0\n\n  > `public virtual bool IsSwappable()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * `bool` - Is true if the grab action allows swapping to another grabbing object.\n\nThe IsSwappable method is used to determine if the secondary grab action allows to swab the grab state to another grabbing object.\n\n### ProcessUpdate/0\n\n  > `public virtual void ProcessUpdate()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe ProcessUpdate method runs in every Update on the Interactable Object whilst it is being grabbed by a secondary controller.\n\n### ProcessFixedUpdate/0\n\n  > `public virtual void ProcessFixedUpdate()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe ProcessFixedUpdate method runs in every FixedUpdate on the Interactable Object whilst it is being grabbed by a secondary controller.\n\n### OnDropAction/0\n\n  > `public virtual void OnDropAction()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe OnDropAction method is executed when the current grabbed object is dropped and can be used up to clean up any secondary grab actions.","excerpt":"","slug":"vrtk_basegrabaction","type":"basic","title":"VRTK_BaseGrabAction"}

VRTK_BaseGrabAction


## Overview The Base Grab Action is an abstract class that all other secondary controller actions inherit and are required to implement the public abstract methods. As this is an abstract class, it cannot be applied directly to a game object and performs no logic. ## Class Methods ### Initialise/5 > `public virtual void Initialise(VRTK_InteractableObject currentGrabbdObject, VRTK_InteractGrab currentPrimaryGrabbingObject, VRTK_InteractGrab currentSecondaryGrabbingObject, Transform primaryGrabPoint, Transform secondaryGrabPoint)` * Parameters * `VRTK_InteractableObject currentGrabbdObject` - The Interactable Object script for the object currently being grabbed by the primary controller. * `VRTK_InteractGrab currentPrimaryGrabbingObject` - The Interact Grab script for the object that is associated with the primary controller. * `VRTK_InteractGrab currentSecondaryGrabbingObject` - The Interact Grab script for the object that is associated with the secondary controller. * `Transform primaryGrabPoint` - The point on the object where the primary controller initially grabbed the object. * `Transform secondaryGrabPoint` - The point on the object where the secondary controller initially grabbed the object. * Returns * _none_ The Initalise method is used to set up the state of the secondary action when the object is initially grabbed by a secondary controller. ### ResetAction/0 > `public virtual void ResetAction()` * Parameters * _none_ * Returns * _none_ The ResetAction method is used to reset the secondary action when the object is no longer grabbed by a secondary controller. ### IsActionable/0 > `public virtual bool IsActionable()` * Parameters * _none_ * Returns * `bool` - Is true if the secondary grab action does perform an action on secondary grab. The IsActionable method is used to determine if the secondary grab action performs an action on grab. ### IsSwappable/0 > `public virtual bool IsSwappable()` * Parameters * _none_ * Returns * `bool` - Is true if the grab action allows swapping to another grabbing object. The IsSwappable method is used to determine if the secondary grab action allows to swab the grab state to another grabbing object. ### ProcessUpdate/0 > `public virtual void ProcessUpdate()` * Parameters * _none_ * Returns * _none_ The ProcessUpdate method runs in every Update on the Interactable Object whilst it is being grabbed by a secondary controller. ### ProcessFixedUpdate/0 > `public virtual void ProcessFixedUpdate()` * Parameters * _none_ * Returns * _none_ The ProcessFixedUpdate method runs in every FixedUpdate on the Interactable Object whilst it is being grabbed by a secondary controller. ### OnDropAction/0 > `public virtual void OnDropAction()` * Parameters * _none_ * Returns * _none_ The OnDropAction method is executed when the current grabbed object is dropped and can be used up to clean up any secondary grab actions.