BNG.SteeringWheel Class Reference

Inheritance diagram for BNG.SteeringWheel:

Public Member Functions
virtual void	UpdateAngleCalculations ()
float	GetRelativeAngle (Vector3 position1, Vector3 position2)
virtual void	ApplyAngleToSteeringWheel (float angle)
virtual void	UpdatePreviewText ()
virtual void	CallEvents ()
override void	OnGrab (Grabber grabber)
	Item has been grabbed by a Grabber.
virtual void	ReturnToCenterAngle ()
Grabber	GetPrimaryGrabber ()
Grabber	GetSecondaryGrabber ()
virtual void	UpdatePreviousAngle (float angle)
virtual float	GetScaledValue (float value, float min, float max)
	Returns a value between -1 and 1.
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
float	MinAngle = -360f
float	MaxAngle = 360f
Transform	RotatorObject
float	RotationSpeed = 0f
bool	AllowTwoHanded = true
bool	ReturnToCenter = false
float	ReturnToCenterSpeed = 45
Text	DebugText
FloatEvent	onAngleChange
FloatEvent	onValueChange
bool	ShowEditorGizmos = true

Protected Attributes
Vector3	rotatePosition
Vector3	previousPrimaryPosition
Vector3	previousSecondaryPosition
float	targetAngle
float	previousTargetAngle
float	smoothedAngle
	This angle is smoothed towards target angle in Update using RotationSpeed.
Protected Attributes inherited from BNG.GrabbableEvents
Grabbable	grab
Grabber	thisGrabber
InputBridge	input

Properties
float	Angle [get]
	Returns the angle of the rotation, taking RotationSpeed into account.
float	RawAngle [get]
	Always returns the target angle, not taking RotationSpeed into account.
float	ScaleValue [get]
float	ScaleValueInverted [get]
float	AngleInverted [get]
Grabber	PrimaryGrabber [get]
Grabber	SecondaryGrabber [get]

Additional Inherited Members
Protected Member Functions inherited from BNG.GrabbableEvents
virtual void	Awake ()

Member Function Documentation

ApplyAngleToSteeringWheel()

virtual void BNG.SteeringWheel.ApplyAngleToSteeringWheel ( float  angle )

virtual

CallEvents()

virtual void BNG.SteeringWheel.CallEvents ( )

virtual

GetPrimaryGrabber()

Grabber BNG.SteeringWheel.GetPrimaryGrabber

(

)

GetRelativeAngle()

float BNG.SteeringWheel.GetRelativeAngle	(	Vector3	position1,
		Vector3	position2
	)

GetScaledValue()

virtual float BNG.SteeringWheel.GetScaledValue ( float  value, float  min, float  max  )

virtual

Returns a value between -1 and 1.

Parameters

value	Current value to compute against
min	Minimum value of range used for conversion.
max	Maximum value of range used for conversion. Must be greater then min

Returns

Value between -1 and 1

GetSecondaryGrabber()

Grabber BNG.SteeringWheel.GetSecondaryGrabber

(

)

OnGrab()

override void BNG.SteeringWheel.OnGrab ( Grabber  grabber )

virtual

Item has been grabbed by a Grabber.

Parameters

grabber

Reimplemented from BNG.GrabbableEvents.

ReturnToCenterAngle()

virtual void BNG.SteeringWheel.ReturnToCenterAngle ( )

virtual

UpdateAngleCalculations()

virtual void BNG.SteeringWheel.UpdateAngleCalculations ( )

virtual

UpdatePreviewText()

virtual void BNG.SteeringWheel.UpdatePreviewText ( )

virtual

UpdatePreviousAngle()

virtual void BNG.SteeringWheel.UpdatePreviousAngle ( float  angle )

virtual

Member Data Documentation

AllowTwoHanded

bool BNG.SteeringWheel.AllowTwoHanded = true

DebugText

Text BNG.SteeringWheel.DebugText

MaxAngle

float BNG.SteeringWheel.MaxAngle = 360f

MinAngle

float BNG.SteeringWheel.MinAngle = -360f

onAngleChange

FloatEvent BNG.SteeringWheel.onAngleChange

onValueChange

FloatEvent BNG.SteeringWheel.onValueChange

previousPrimaryPosition

Vector3 BNG.SteeringWheel.previousPrimaryPosition

protected

previousSecondaryPosition

Vector3 BNG.SteeringWheel.previousSecondaryPosition

protected

previousTargetAngle

float BNG.SteeringWheel.previousTargetAngle

protected

ReturnToCenter

bool BNG.SteeringWheel.ReturnToCenter = false

ReturnToCenterSpeed

float BNG.SteeringWheel.ReturnToCenterSpeed = 45

rotatePosition

Vector3 BNG.SteeringWheel.rotatePosition

protected

RotationSpeed

float BNG.SteeringWheel.RotationSpeed = 0f

RotatorObject

Transform BNG.SteeringWheel.RotatorObject

ShowEditorGizmos

bool BNG.SteeringWheel.ShowEditorGizmos = true

smoothedAngle

float BNG.SteeringWheel.smoothedAngle

protected

This angle is smoothed towards target angle in Update using RotationSpeed.

targetAngle

float BNG.SteeringWheel.targetAngle

protected

Property Documentation

Angle

float BNG.SteeringWheel.Angle

get

Returns the angle of the rotation, taking RotationSpeed into account.

AngleInverted

float BNG.SteeringWheel.AngleInverted

get

PrimaryGrabber

Grabber BNG.SteeringWheel.PrimaryGrabber

get

RawAngle

float BNG.SteeringWheel.RawAngle

get

Always returns the target angle, not taking RotationSpeed into account.

ScaleValue

float BNG.SteeringWheel.ScaleValue

get

ScaleValueInverted

float BNG.SteeringWheel.ScaleValueInverted

get

SecondaryGrabber

Grabber BNG.SteeringWheel.SecondaryGrabber

get

---

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

• Core/SteeringWheel.cs