VR Interaction Framework  1.0
A vr framework for the Oculus Quest
BNG Namespace Reference

Classes

class  Arrow
 A Grabbable object that can stick to objects and deal damage More...
 
class  ArrowGrabArea
 Spawn an arrow if Trigger is grabbed More...
 
class  BNGPlayerController
 The BNGPlayerController handles basic player movement and climbing. More...
 
class  Bow
 An example bow item. More...
 
class  BowArm
 Set the Rotation of a Transform based on a Bow's draw percentage More...
 
class  BulletHole
 A simple decal with random scale and rotation More...
 
class  Button
 Physical button helper with More...
 
class  CharacterIK
 This Component allows a generic humanoid rig to follow the Player's controller's and HMD using Unity's IK system More...
 
class  Climbable
 Allows the Player to climb objects by Grabbing them More...
 
class  CollisionSound
 Plays a Sound Clip OnCollisionEnter More...
 
class  ConstrainLocalPosition
 Constrain a Transform's LocalPosition to a given value. More...
 
class  Damageable
 A basic damage implementation. More...
 
class  DamageCollider
 This collider will Damage a Damageable object on impact More...
 
class  DemoScript
 Contains various functionality used in the Demo Scene such as Switching Hands and Locomotion More...
 
class  DrawDefinition
 A list of how and when to play a haptic according to DrawPercentage More...
 
class  Flashlight
 A simple Grabbable example that toggles a light source on and off More...
 
class  FloatEvent
 A UnityEvent with a float as a parameter More...
 
class  FloatFloatEvent
 A UnityEvent with a 2 floats as parameters More...
 
class  FPSText
 A simple script to display FPS onto a Text label More...
 
class  Grabbable
 An object that can be picked up by a Grabber More...
 
class  GrabbableEvents
 Override this class to respond to various events that happen to this Grabbable More...
 
class  GrabbableHaptics
 A set of events that allow you to apply haptics to a controller More...
 
class  GrabbableHighlight
 Events that will highlight an object if it is a valid Grabbable More...
 
class  GrabbableRingHelper
 Show a ring helper on an object. More...
 
class  Grabber
 A trigger collider that handles grabbing grabbables. More...
 
class  GrabberArea
 Keeps a List of all Grabbers within this Trigger More...
 
class  GrabberEvent
 A UnityEvent with a Grabber as the parameter More...
 
class  HandController
 An example hand controller that sets animation values depending on Grabber state More...
 
class  HandJet
 Like a jetpack, but for your hands. More...
 
class  InputBridge
 A proxy for handling input from Oculus. More...
 
class  InvalidTeleportArea
 Designates a collider as invalid for teleportation More...
 
class  JointHelper
 Lock joints in place to help with physics handling and parent scaling More...
 
class  JoystickControl
 Helper for joystick type physical inputs More...
 
class  LaserPointer
 A simple laser pointer that draws a line with a dot at the end More...
 
class  LaserSword
 An example Grabbable that adds lots of particles and changes audio pitch on collision. More...
 
class  Lever
 Helper class to interact with physical levers More...
 
class  LineToTransform
 Draw a LineRenderer from the Transform to another. More...
 
class  LookAtTransform
 Rotate this object to point it's transform.forward at an object More...
 
class  MagazineSlide
 Constrain a magazine when it enters this area. More...
 
class  Pistol
 An example weapon script. More...
 
class  PlayerScaler
 An example script for how to scale a player in VR More...
 
class  PlayerTeleport
 A basic Teleport script that uses a parabolic arc to determine teleport location More...
 
class  Projectile
 An object than do damage and play hit FX More...
 
class  RemoteGrabber
 Keeps track of Grabbables that are within it's Trigger More...
 
class  RingHelper
 Shows a ring at the grab point of a grabbable if within a certain distance More...
 
class  ScaleBetweenPoints
 Scales an object's local Z scale to match a Begin / End point More...
 
class  Slider
 Helper class to interact with physical sliders More...
 
class  TeleportDestination
 A marker for valid teleport destinations More...
 
class  TimeController
 Press Y to slow time by modifying Time.timeScale and Time.fixedDeltaTime More...
 
class  VRUtils
 Static Utilities to help with development, such as logging to World Space More...
 
class  WeaponSlide
 Weapon slide on a pistol. More...
 
class  Zipline
 An example Grabbable that lets you move along a designated path More...
 

Enumerations

enum  LocomotionType { LocomotionType.Teleport, LocomotionType.SmoothLocomotion }
 
enum  GrabType { GrabType.Snap, GrabType.Precise }
 
enum  HoldType { HoldType.HoldDown, HoldType.Toggle }
 
enum  GrabPhysics { GrabPhysics.PhysicsJoint, GrabPhysics.Kinematic, GrabPhysics.None }
 
enum  ControllerHand { ControllerHand.Left, ControllerHand.Right, ControllerHand.None }
 
enum  HandControl {
  HandControl.LeftGrip, HandControl.RightGrip, HandControl.LeftTrigger, HandControl.RightTrigger,
  HandControl.None
}
 
enum  GrabButton { GrabButton.Grip, GrabButton.Trigger }
 
enum  TeleportControls { TeleportControls.Thumbstick, TeleportControls.BButton }
 
enum  FiringType { FiringType.Semi, FiringType.Automatic }
 

Enumeration Type Documentation

◆ ControllerHand

enum BNG.ControllerHand
strong
Enumerator
Left 
Right 
None 

◆ FiringType

enum BNG.FiringType
strong
Enumerator
Semi 
Automatic 

◆ GrabButton

enum BNG.GrabButton
strong
Enumerator
Grip 
Trigger 

◆ GrabPhysics

enum BNG.GrabPhysics
strong
Enumerator
PhysicsJoint 
Kinematic 
None 

◆ GrabType

enum BNG.GrabType
strong
Enumerator
Snap 
Precise 

◆ HandControl

enum BNG.HandControl
strong
Enumerator
LeftGrip 
RightGrip 
LeftTrigger 
RightTrigger 
None 

◆ HoldType

enum BNG.HoldType
strong
Enumerator
HoldDown 
Toggle 

◆ LocomotionType

enum BNG.LocomotionType
strong
Enumerator
Teleport 
SmoothLocomotion 

◆ TeleportControls

enum BNG.TeleportControls
strong
Enumerator
Thumbstick 
BButton