PushButton Class

Enables this object to be used like a button

Inheritance Hierarchy

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

Syntax

[UnityEngine.RequireComponent(typeof(UnityEngine.Rigidbody))]
public class PushButton : InteractableObject

The PushButton type exposes the following members.

Constructors

	Name	Description
	PushButton	Initializes a new instance of the PushButton class

Properties

	Name	Description
	IsPressed	Is this button currently pushed down?
	Rigidbody	RigidBody associated with this button

Methods

	Name	Description
	Awake	Unity component method (Overrides InteractableObjectAwake.)
	FixedUpdate	Unity Component Method (Overrides InteractableObjectFixedUpdate.)
	GetPayload	Returns the payload (byte array). Can be empty array or null. (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
	OnPressed	Button has been pressed
	OnPressLocal	Button has been pressed (but only sent to the local listeners)
	OnReleased	Button has been released
	OnReleaseLocal	Button has been released (but only sent to the local listeners)

Fields

	Name	Description
	_axis	The axis along which the button moves
	_sensitivity	Indicated the maximum movement allowed in the movement axis, in either positive or negative direction

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