InteractableObject Class

Basic intractability

Inheritance Hierarchy

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

Syntax

[UnityEngine.DisallowMultipleComponent]
public abstract class InteractableObject : NetworkedPointHandlingObject, 
	IInteractableObject

The InteractableObject type exposes the following members.

Constructors

	Name	Description
	InteractableObject	Initializes a new instance of the InteractableObject class

Properties

	Name	Description
	AllowInteractionOnlyByLocalAvatar	By default, only colliders belonging to the Local Avatar's hand are allowed to press buttons. If this property is set to false, any collision detected will cause the button to be pressed.
	Collider	The collider belonging to this object that is used to detect interaction

Methods

	Name	Description
	AllowInteraction	Returns True if the button is allowed to be pressed
	Awake	Unity component method (Overrides IndexedMonoBehaviourAwake.)
	FixedUpdate	Unity Component Method
	RequirementsMet	Returns true if interaction is allowed, and interaction requirements are met.
	ShowHighlight	Shows/Hides a highlight around the object
	Vibrate	Make the controller belonging to the specified hand vibrate

Fields

	Name	Description
	_allowInteractionOnlyByLocalAvatar	By default, only colliders belonging to the Local Avatar's hand are allowed to press buttons. If this property is set to false, any collision detected will cause the button to be pressed.
	_interactionRequirements	Requirements that has to be satisfied to allow interaction
	_isInteractableOnlyWhenParentEngaged	Note: If this object does not have an engageable object as a parent, this setting has no effect. If it does have an engageable object as a parent, this setting will control whether the parent needs to be engaged to allow this object to be interactable.

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