VR Interaction Framework v2.0
Loading...
Searching...
No Matches
BNG.GrabbableUnityEvents Class Reference
Inheritance diagram for BNG.GrabbableUnityEvents:
BNG.GrabbableEvents

Public Member Functions

override void OnGrab (Grabber grabber)
 Item has been grabbed by a Grabber.
 
override void OnRelease ()
 Has been dropped from the Grabber.
 
override void OnBecomesClosestGrabbable (ControllerHand touchingHand)
 Called if this is the closest grabbable but wasn't in the previous frame.
 
override void OnNoLongerClosestGrabbable (ControllerHand touchingHand)
 No longer closest grabbable. May need to disable highlight, ring, etc.
 
override void OnBecomesClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this is the closest remote grabbable but wasn't in the previous frame.
 
override void OnNoLongerClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this was the closest remote grabbable last frame, but not this frame.
 
override void OnGrip (float gripValue)
 Amount of Grip (0-1). Only fired if object is being held.
 
override void OnTrigger (float triggerValue)
 Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.
 
override void OnTriggerDown ()
 Fires if trigger was pressed down on this controller this frame. Only fired if object is being held.
 
override void OnTriggerUp ()
 Fires if trigger was released on this controller this frame. Only fired if object is being held.
 
override void OnButton1 ()
 Button 1 is being held down this frame but not last Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
override void OnButton1Down ()
 Button 1 Pressed down this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
override void OnButton1Up ()
 Button 1 Released this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
override void OnButton2 ()
 Button 2 is being held down this frame but not last Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
override void OnButton2Down ()
 Button 2 Pressed down this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
override void OnButton2Up ()
 Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
override void OnSnapZoneEnter ()
 Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
override void OnSnapZoneExit ()
 Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
- Public Member Functions inherited from BNG.GrabbableEvents
virtual void OnGrab (Grabber grabber)
 Item has been grabbed by a Grabber.
 
virtual void OnRelease ()
 Has been dropped from the Grabber.
 
virtual void OnBecomesClosestGrabbable (ControllerHand touchingHand)
 Called if this is the closest grabbable but wasn't in the previous frame.
 
virtual void OnBecomesClosestGrabbable (Grabber touchingGrabber)
 Called if this is the closest grabbable but wasn't in the previous frame.
 
virtual void OnNoLongerClosestGrabbable (ControllerHand touchingHand)
 No longer closest grabbable. May need to disable highlight, ring, etc.
 
virtual void OnNoLongerClosestGrabbable (Grabber touchingGrabber)
 No longer closest grabbable. May need to disable highlight, ring, etc.
 
virtual void OnBecomesClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this is the closest remote grabbable but wasn't in the previous frame.
 
virtual void OnBecomesClosestRemoteGrabbable (Grabber theGrabber)
 Fires if this is the closest remote grabbable but wasn't in the previous frame.
 
virtual void OnNoLongerClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this was the closest remote grabbable last frame, but not this frame.
 
virtual void OnNoLongerClosestRemoteGrabbable (Grabber theGrabber)
 Fires if this was the closest remote grabbable last frame, but not this frame.
 
virtual void OnGrip (float gripValue)
 Amount of Grip (0-1). Only fired if object is being held.
 
virtual void OnTrigger (float triggerValue)
 Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.
 
virtual void OnTriggerDown ()
 Fires if trigger was pressed down on this controller this frame, but was not pressed last frame. Only fired if object is being held.
 
virtual void OnTriggerUp ()
 Fires if Trigger is not held down this frame.
 
virtual void OnButton1 ()
 Button 1 is being held down this frame but not last Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton1Down ()
 Button 1 Pressed down this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton1Up ()
 Button 1 Released this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton2 ()
 Button 2 is being held down this frame but not last Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnButton2Down ()
 Button 2 Pressed down this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnButton2Up ()
 Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnSnapZoneEnter ()
 Grabbable has been successfully inserted into a SnapZone.
 
virtual void OnSnapZoneExit ()
 Grabbable has been removed from a SnapZone.
 

Public Attributes

GrabberEvent onGrab
 
UnityEvent onRelease
 
UnityEvent onBecomesClosestGrabbable
 
UnityEvent onNoLongerClosestGrabbable
 
UnityEvent onBecomesClosestRemoteGrabbable
 
UnityEvent onNoLongerClosestRemoteGrabbable
 
FloatEvent onGrip
 
FloatEvent onTrigger
 
UnityEvent onTriggerDown
 
UnityEvent onTriggerUp
 
UnityEvent onButton1
 
UnityEvent onButton1Down
 
UnityEvent onButton1Up
 
UnityEvent onButton2
 
UnityEvent onButton2Down
 
UnityEvent onButton2Up
 
UnityEvent onSnapZoneEnter
 
UnityEvent onSnapZoneExit
 

Additional Inherited Members

- Protected Member Functions inherited from BNG.GrabbableEvents
virtual void Awake ()
 
- Protected Attributes inherited from BNG.GrabbableEvents
Grabbable grab
 
Grabber thisGrabber
 
InputBridge input
 

Member Function Documentation

◆ OnBecomesClosestGrabbable()

override void BNG.GrabbableUnityEvents.OnBecomesClosestGrabbable ( ControllerHand  touchingHand)
virtual

Called if this is the closest grabbable but wasn't in the previous frame.

Parameters
touchingHand

Reimplemented from BNG.GrabbableEvents.

◆ OnBecomesClosestRemoteGrabbable()

override void BNG.GrabbableUnityEvents.OnBecomesClosestRemoteGrabbable ( ControllerHand  touchingHand)
virtual

Fires if this is the closest remote grabbable but wasn't in the previous frame.

Parameters
touchingHand

Reimplemented from BNG.GrabbableEvents.

◆ OnButton1()

override void BNG.GrabbableUnityEvents.OnButton1 ( )
virtual

Button 1 is being held down this frame but not last Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnButton1Down()

override void BNG.GrabbableUnityEvents.OnButton1Down ( )
virtual

Button 1 Pressed down this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnButton1Up()

override void BNG.GrabbableUnityEvents.OnButton1Up ( )
virtual

Button 1 Released this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnButton2()

override void BNG.GrabbableUnityEvents.OnButton2 ( )
virtual

Button 2 is being held down this frame but not last Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnButton2Down()

override void BNG.GrabbableUnityEvents.OnButton2Down ( )
virtual

Button 2 Pressed down this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnButton2Up()

override void BNG.GrabbableUnityEvents.OnButton2Up ( )
virtual

Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnGrab()

override void BNG.GrabbableUnityEvents.OnGrab ( Grabber  grabber)
virtual

Item has been grabbed by a Grabber.

Parameters
grabber

Reimplemented from BNG.GrabbableEvents.

◆ OnGrip()

override void BNG.GrabbableUnityEvents.OnGrip ( float  gripValue)
virtual

Amount of Grip (0-1). Only fired if object is being held.

Parameters
gripValue0 - 1 Open / Closed

Reimplemented from BNG.GrabbableEvents.

◆ OnNoLongerClosestGrabbable()

override void BNG.GrabbableUnityEvents.OnNoLongerClosestGrabbable ( ControllerHand  touchingHand)
virtual

No longer closest grabbable. May need to disable highlight, ring, etc.

Parameters
touchingHand

Reimplemented from BNG.GrabbableEvents.

◆ OnNoLongerClosestRemoteGrabbable()

override void BNG.GrabbableUnityEvents.OnNoLongerClosestRemoteGrabbable ( ControllerHand  touchingHand)
virtual

Fires if this was the closest remote grabbable last frame, but not this frame.

Parameters
touchingHand

Reimplemented from BNG.GrabbableEvents.

◆ OnRelease()

override void BNG.GrabbableUnityEvents.OnRelease ( )
virtual

Has been dropped from the Grabber.

Reimplemented from BNG.GrabbableEvents.

◆ OnSnapZoneEnter()

override void BNG.GrabbableUnityEvents.OnSnapZoneEnter ( )
virtual

Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnSnapZoneExit()

override void BNG.GrabbableUnityEvents.OnSnapZoneExit ( )
virtual

Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.

Reimplemented from BNG.GrabbableEvents.

◆ OnTrigger()

override void BNG.GrabbableUnityEvents.OnTrigger ( float  triggerValue)
virtual

Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.

Parameters
triggerValue0 - 1 Open / Closed

Reimplemented from BNG.GrabbableEvents.

◆ OnTriggerDown()

override void BNG.GrabbableUnityEvents.OnTriggerDown ( )
virtual

Fires if trigger was pressed down on this controller this frame. Only fired if object is being held.

Reimplemented from BNG.GrabbableEvents.

◆ OnTriggerUp()

override void BNG.GrabbableUnityEvents.OnTriggerUp ( )
virtual

Fires if trigger was released on this controller this frame. Only fired if object is being held.

Reimplemented from BNG.GrabbableEvents.

Member Data Documentation

◆ onBecomesClosestGrabbable

UnityEvent BNG.GrabbableUnityEvents.onBecomesClosestGrabbable

◆ onBecomesClosestRemoteGrabbable

UnityEvent BNG.GrabbableUnityEvents.onBecomesClosestRemoteGrabbable

◆ onButton1

UnityEvent BNG.GrabbableUnityEvents.onButton1

◆ onButton1Down

UnityEvent BNG.GrabbableUnityEvents.onButton1Down

◆ onButton1Up

UnityEvent BNG.GrabbableUnityEvents.onButton1Up

◆ onButton2

UnityEvent BNG.GrabbableUnityEvents.onButton2

◆ onButton2Down

UnityEvent BNG.GrabbableUnityEvents.onButton2Down

◆ onButton2Up

UnityEvent BNG.GrabbableUnityEvents.onButton2Up

◆ onGrab

GrabberEvent BNG.GrabbableUnityEvents.onGrab

◆ onGrip

FloatEvent BNG.GrabbableUnityEvents.onGrip

◆ onNoLongerClosestGrabbable

UnityEvent BNG.GrabbableUnityEvents.onNoLongerClosestGrabbable

◆ onNoLongerClosestRemoteGrabbable

UnityEvent BNG.GrabbableUnityEvents.onNoLongerClosestRemoteGrabbable

◆ onRelease

UnityEvent BNG.GrabbableUnityEvents.onRelease

◆ onSnapZoneEnter

UnityEvent BNG.GrabbableUnityEvents.onSnapZoneEnter

◆ onSnapZoneExit

UnityEvent BNG.GrabbableUnityEvents.onSnapZoneExit

◆ onTrigger

FloatEvent BNG.GrabbableUnityEvents.onTrigger

◆ onTriggerDown

UnityEvent BNG.GrabbableUnityEvents.onTriggerDown

◆ onTriggerUp

UnityEvent BNG.GrabbableUnityEvents.onTriggerUp

The documentation for this class was generated from the following file: