Click or drag to resize

InteractableObject Class

Basic intractability
Inheritance Hierarchy

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

The InteractableObject type exposes the following members.

Constructors
  NameDescription
Protected methodInteractableObject
Initializes a new instance of the InteractableObject class
Top
Properties
  NameDescription
Public propertyAllowInteractionOnlyByLocalAvatar
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.
Protected propertyCollider
The collider belonging to this object that is used to detect interaction
Public propertyShouldAutoPoint
True if this object requires automatic controller pointing.
Top
Methods
  NameDescription
Protected methodAllowInteraction
Returns True if the button is allowed to be pressed
Protected methodAwake
Protected methodFixedUpdate
Unity Component Method
Public methodRequirementsMet
Returns true if interaction is allowed, and interaction requirements are met.
Protected methodSetUpOutline
Public methodShowHighlight
Shows/Hides a highlight around the object
Public methodTriggerScreenControlInteract
Protected methodStatic memberVibrate
Make the controller belonging to the specified hand vibrate
Top
Fields
  NameDescription
Private field_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.
Private field_interactionRequirements
Requirements that has to be satisfied to allow interaction
Private field_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.
Private field_shouldAutoPoint
If the hand should automatically point when the user is near
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also