BNG.GrabbableHighlight Class Reference
Events that will highlight an object if it is a valid Grabbable More...
Inheritance diagram for BNG.GrabbableHighlight:
Public Member Functions | |
| override void | OnGrab (Grabber grabber) |
| Item has been grabbed by a Grabber More... | |
| override void | OnBecomesClosestGrabbable (ControllerHand touchingHand) |
| Called if this is the closest grabbable but wasn't in the previous frame More... | |
| override void | OnNoLongerClosestGrabbable (ControllerHand touchingHand) |
| No longer closest grabbable. More... | |
| override void | OnBecomesClosestRemoteGrabbable (ControllerHand touchingHand) |
| Fires if this is the closest remote grabbable but wasn't in the previous frame More... | |
| override void | OnNoLongerClosestRemoteGrabbable (ControllerHand touchingHand) |
| Fires if this was the closest remote grabbable last frame, but not this frame More... | |
| void | HighlightItem () |
| void | UnhighlightItem () |
 Public Member Functions inherited from BNG.GrabbableEvents | |
| virtual void | OnRelease () |
| Has been dropped from the Grabber More... | |
| virtual void | OnGrip (float gripValue) |
| Amount of Grip (0-1). More... | |
| virtual void | OnTrigger (float triggerValue) |
| Amount of Trigger being held down on the grabbed items controller. More... | |
| virtual void | OnTriggerDown () |
| Fires if trigger was pressed down on this controller this frame. More... | |
| virtual void | OnTriggerUp () |
| Fires if trigger was released on this controller this frame. More... | |
| virtual void | OnButton1 () |
| Button 1 is being held down this frame but not last Oculus : Button 1 = "A" if held in Right controller. More... | |
| virtual void | OnButton1Down () |
| Button 1 Pressed down this frame Oculus : Button 1 = "A" if held in Right controller. More... | |
| virtual void | OnButton1Up () |
| Button 1 Released this frame Oculus : Button 1 = "A" if held in Right controller. More... | |
| virtual void | OnButton2 () |
| Button 2 is being held down this frame but not last Oculus : Button 2 = "B" if held in Right controller. More... | |
| virtual void | OnButton2Down () |
| Button 2 Pressed down this frame Oculus : Button 2 = "B" if held in Right controller. More... | |
| virtual void | OnButton2Up () |
| Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller. More... | |
Public Attributes | |
| bool | HighlightOnGrabbable = true |
| bool | HighlightOnRemoteGrabbable = true |
Additional Inherited Members | |
| Protected Attributes inherited from BNG.GrabbableEvents | |
| Grabbable | grab |
| Grabber | thisGrabber |
| InputBridge | input |
Detailed Description
Events that will highlight an object if it is a valid Grabbable
Member Function Documentation
◆ HighlightItem()
| void BNG.GrabbableHighlight.HighlightItem | ( | ) |
◆ OnBecomesClosestGrabbable()
|
virtual |
Called if this is the closest grabbable but wasn't in the previous frame
- Parameters
-
touchingHand
Reimplemented from BNG.GrabbableEvents.
◆ OnBecomesClosestRemoteGrabbable()
|
virtual |
Fires if this is the closest remote grabbable but wasn't in the previous frame
- Parameters
-
touchingHand
Reimplemented from BNG.GrabbableEvents.
◆ OnGrab()
|
virtual |
◆ OnNoLongerClosestGrabbable()
|
virtual |
No longer closest grabbable.
May need to disable highlight, ring, etc.
- Parameters
-
touchingHand
Reimplemented from BNG.GrabbableEvents.
◆ OnNoLongerClosestRemoteGrabbable()
|
virtual |
Fires if this was the closest remote grabbable last frame, but not this frame
- Parameters
-
touchingHand
Reimplemented from BNG.GrabbableEvents.
◆ UnhighlightItem()
| void BNG.GrabbableHighlight.UnhighlightItem | ( | ) |
Member Data Documentation
◆ HighlightOnGrabbable
| bool BNG.GrabbableHighlight.HighlightOnGrabbable = true |
◆ HighlightOnRemoteGrabbable
| bool BNG.GrabbableHighlight.HighlightOnRemoteGrabbable = true |
The documentation for this class was generated from the following file:
- C:/Users/nuo/VR Interaction Framework/VR Interaction Framework/Assets/BNG Framework/Scripts/Components/GrabbableHighlight.cs
