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.
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.
void	HighlightItem ()
void	UnhighlightItem ()
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
bool	HighlightOnGrabbable = true
bool	HighlightOnRemoteGrabbable = true

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

Detailed Description

Events that will highlight an object if it is a valid Grabbable.

Member Function Documentation

HighlightItem()

void BNG.GrabbableHighlight.HighlightItem

(

)

OnBecomesClosestGrabbable()

override void BNG.GrabbableHighlight.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.GrabbableHighlight.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.

OnGrab()

override void BNG.GrabbableHighlight.OnGrab ( Grabber  grabber )

virtual

Item has been grabbed by a Grabber.

Parameters

grabber

Reimplemented from BNG.GrabbableEvents.

OnNoLongerClosestGrabbable()

override void BNG.GrabbableHighlight.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.GrabbableHighlight.OnNoLongerClosestRemoteGrabbable ( ControllerHand  touchingHand )

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:

• Components/GrabbableHighlight.cs