![]() |
VR Interaction Framework v2.0
|
A trigger collider that handles grabbing grabbables. More...
Public Member Functions | |
virtual bool | InputCheckGrab () |
virtual bool | GetInputDownForGrabbable (Grabbable grabObject) |
virtual GrabButton | GetGrabButton (Grabbable grab) |
virtual bool | TryGrab () |
virtual void | GrabGrabbable (Grabbable item) |
virtual void | DidDrop () |
virtual void | HideHandGraphics () |
virtual void | ResetHandGraphics () |
virtual void | TryRelease () |
virtual Vector3 | GetGrabberAveragedVelocity () |
virtual Vector3 | GetGrabberAveragedAngularVelocity () |
Public Attributes | |
ControllerHand | HandSide = ControllerHand.Left |
Which controller side. None if not attached to a controller. | |
HoldType | DefaultHoldType = HoldType.HoldDown |
Which controller side. None if not attached to a controller. | |
GrabButton | DefaultGrabButton = GrabButton.Grip |
The default grab button for all Grabbables. A Grabbable can manually override this default. | |
InputActionReference | GrabAction |
float | GripAmount = 0.9f |
0-1 determine how much to consider a grip. Example : 0.75 is holding the grip down 3/4 of the way | |
float | ReleaseGripAmount = 0.5f |
How much grip considered to release an ob ect (0-1) | |
float | GrabCheckSeconds = 0.5f |
How many seconds to check for grab input while Grip is held down. After grip is held down for this long, grip will need to be repressed in order to pick up an object. | |
Grabbable | EquipGrabbableOnStart |
Assign a Grabbable here if you want to auto equip it on Start. | |
Transform | HandsGraphics |
Root transform that holds hands models. We may want to hide these while holding certain objects. | |
Grabbable | HeldGrabbable |
The Grabbable we are currently holding. Null if not holding anything. | |
bool | ForceGrab = false |
Same as holding down grip if set to true. Should not have same value as ForceRelease. | |
bool | ForceRelease = false |
Force the release of grip. | |
float | LastDropTime |
Vector3 | PreviousPosition |
Transform | DummyTransform |
Can be used to position hands independently from model. | |
bool | FreshGrip = true |
GrabbableEvent | onGrabEvent |
GrabbableEvent | onAfterGrabEvent |
GrabbableEvent | onReleaseEvent |
VelocityTracker | velocityTracker |
Protected Member Functions | |
virtual void | updateFreshGrabStatus () |
virtual bool | inputCheckRelease () |
virtual float | getGrabInput (GrabButton btn) |
virtual bool | getToggleInput (GrabButton btn) |
Properties | |
bool | HoldingItem [get] |
Are we currently holding any valid items? | |
bool | RemoteGrabbingItem [get] |
Are we currently pulling a remote grabbable towards us? | |
GrabbablesInTrigger | GrabsInTrigger [get] |
Grabbable | RemoteGrabbingGrabbable [get] |
Returns the Grabbable object if we are currenly remote grabbing an object. | |
Vector3 | handsGraphicsGrabberOffset [get] |
Vector3 | handsGraphicsGrabberOffsetRotation [get] |
A trigger collider that handles grabbing grabbables.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
protectedvirtual |
|
virtual |
|
protectedvirtual |
|
virtual |
|
virtual |
|
virtual |
|
protectedvirtual |
|
virtual |
|
virtual |
|
virtual |
|
protectedvirtual |
GrabButton BNG.Grabber.DefaultGrabButton = GrabButton.Grip |
The default grab button for all Grabbables. A Grabbable can manually override this default.
HoldType BNG.Grabber.DefaultHoldType = HoldType.HoldDown |
Which controller side. None if not attached to a controller.
Transform BNG.Grabber.DummyTransform |
Can be used to position hands independently from model.
Grabbable BNG.Grabber.EquipGrabbableOnStart |
Assign a Grabbable here if you want to auto equip it on Start.
bool BNG.Grabber.ForceGrab = false |
Same as holding down grip if set to true. Should not have same value as ForceRelease.
bool BNG.Grabber.ForceRelease = false |
Force the release of grip.
bool BNG.Grabber.FreshGrip = true |
InputActionReference BNG.Grabber.GrabAction |
float BNG.Grabber.GrabCheckSeconds = 0.5f |
How many seconds to check for grab input while Grip is held down. After grip is held down for this long, grip will need to be repressed in order to pick up an object.
float BNG.Grabber.GripAmount = 0.9f |
0-1 determine how much to consider a grip. Example : 0.75 is holding the grip down 3/4 of the way
Transform BNG.Grabber.HandsGraphics |
Root transform that holds hands models. We may want to hide these while holding certain objects.
ControllerHand BNG.Grabber.HandSide = ControllerHand.Left |
Which controller side. None if not attached to a controller.
Grabbable BNG.Grabber.HeldGrabbable |
The Grabbable we are currently holding. Null if not holding anything.
float BNG.Grabber.LastDropTime |
GrabbableEvent BNG.Grabber.onAfterGrabEvent |
GrabbableEvent BNG.Grabber.onGrabEvent |
GrabbableEvent BNG.Grabber.onReleaseEvent |
Vector3 BNG.Grabber.PreviousPosition |
float BNG.Grabber.ReleaseGripAmount = 0.5f |
How much grip considered to release an ob ect (0-1)
VelocityTracker BNG.Grabber.velocityTracker |
|
get |
|
get |
|
get |
|
get |
Are we currently holding any valid items?
|
get |
Returns the Grabbable object if we are currenly remote grabbing an object.
|
get |
Are we currently pulling a remote grabbable towards us?