Dial Class

Enables this object to be engaged with as a dial. Watch our training videos covering Dial objects here

Inheritance Hierarchy

Namespace: ImmerseSDK.Interaction
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public class Dial : HingeEngageableObject

The Dial type exposes the following members.

Constructors

	Name	Description
	Dial	Initializes a new instance of the Dial class

Properties

	Name	Description
	AmountRotated	Amount of rotation in the range [0..1] Use Limits on the HingeJoint to limit movement if so required. This class will use those limits to calculate [0..1] range. If no limits, then it will use full rotation.

Methods

	Name	Description
	AngleBetween	Get the angle between a and b in degrees https://github.com/lordofduct/spacepuppy-unity-framework/blob/master/SpacepuppyBase/Utils/VectorUtil.cs
	AngleOffAroundAxis	Find some projected angle measure off some forward around some axis.
	Awake	Unity component method (Overrides HingeEngageableObjectAwake.)
	FixedUpdate	Unity Component Method (Overrides EngageableObjectFixedUpdate.)
	Start	Unity component method (Overrides IndexedMonoBehaviourStart.)
	Update	Unity Component Method (Overrides EngageableObjectUpdate.)

Events

	Name	Description
	OnValueChanged	Fired when this Dial's value changes. Value is (0..1)

Fields

	Name	Description
	_invertValue	Invert the value (becomes 1- value)
	_isLargeDial	This affects how the dial is interacted with. Smaller dials use only wrist action, whereas larger dials uses "dragging" of the controller like a wheel

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	GetObjectIndex	Gets the index from the IndexedMonoBehaviour (Defined by GUID.)
	GetOwner	Gets the owner id from the IndexedMonoBehaviour (Defined by GUID.)
	GetOwnerType	Gets the owner type from the IndexedMonoBehaviour (Defined by GUID.)
	GetScene	Gets the scene id from the IndexedMonoBehaviour (Defined by GUID.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)

Remarks

Watch our training videos covering Dial objects here