ToggleSwitch Class

A simple switch. Uses a HingeJoint to move

Inheritance Hierarchy

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

Syntax

public class ToggleSwitch : InteractableObject

The ToggleSwitch type exposes the following members.

Constructors

	Name	Description
	ToggleSwitch	Initializes a new instance of the ToggleSwitch class

Properties

	Name	Description
	IsOn	Indicates the current state of the switch

Methods

	Name	Description
	Awake	Unity component method (Overrides InteractableObjectAwake.)
	GetPayload	Gets the message payload for this component (Overrides NetworkedPointHandlingObjectGetPayload.)
	OnLocalEvent	Called when the object is "clicked" (only on local user) (Overrides NetworkedPointHandlingObjectOnLocalEvent(Avatar, Hands).)
	OnReceiveEvent	Called when the object is "clicked" (only on both local and remote users) (Overrides NetworkedPointHandlingObjectOnReceiveEvent(Avatar, Hands, UserID, Byte).)

Events

	Name	Description
	OnSwitch	Fired when the switch is triggered

Fields

	Name	Description
	_axis	Axis along which the switch moves
	_throw	Throw of the switch in degrees

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.)