 | Controller Class |
Encapsulates controller functionality. This is an abstract class with two concrete implementations: Local and Remote.
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDK.ControllersController
ImmerseSDK.ControllersControllerLocal
ImmerseSDK.ControllersControllerRemote
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDK.ControllersController
ImmerseSDK.ControllersControllerLocal
ImmerseSDK.ControllersControllerRemote
Namespace: ImmerseSDK.Controllers
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
SyntaxC#
[UnityEngine.RequireComponent(typeof(UnityEngine.Rigidbody))] public abstract class Controller : LoggingBehaviour
The Controller type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Controller | Initializes a new instance of the Controller class |
Properties| Name | Description | |
|---|---|---|
 | AttachPoint |
This controller's attach point
|
| CanEngage |
Indicates if this controller can engage an object
|
| EngagingObject |
Get's the current engagable object this controller is engaged with (can be null if not engaged)
|
| ID |
Identifies the hand that this controller belongs to
|
| IsEngaged |
Indicates whether this controller is currently engaging an object
|
| IsInDialogMode |
Indicates whether this controller is currently handling dialog input
|
 | IsInitialised |
True if initialisation has been done
|
| Owner |
User that owns this controller
|
| RealControllerModels |
Controls the real controller models
|
| State |
Gets his controller's current state
|
Methods| Name | Description | |
|---|---|---|
| Awake |
Unity component method
|
| ConvertToRightHand |
Converts the model from left to right hand
|
 | ForceShowHands |
Provides the same functionality as Controller.ShowHands, but allows the isVisible parameter
to determine the hand's visibility if the hand is engaged at the time when the method is called.
|
| GetAvatar |
Returns the Avatar of this controller
|
| GetOrientation |
Get the target orientation of the controller
|
| GetOtherHand |
Gets the other hand
|
| IsLocal |
Returns true if this is a local controller
|
| IsOtherHandIsPointing |
Returns true if the other controller is in the pointing state, otherwise false
|
| IsPointing |
Returns true if the controller is in the pointing state, otherwise false
|
| OnDestroy |
Unity component method
|
| OnDisable |
Unity component method
|
| OnDrawGizmos |
Unity Editor-only method
|
| OnEnable |
Unity component method
|
| SetEngagingObject |
Sets the engaging object for this controller
|
| ShowHandGeometry |
Shows or hides hand geometry only. Note that this does not update the internal visibility state,
so if anything happens that will cause an update, then that will determine the visibility.
|
| ShowHands |
Changes the visibility of the avatar hand model associated with this controller.
Note that when calling this method, the isVisible parameter will be stored locally
and is only used to determine the hand's visibility whenever it is not engaged with an object.
When the hand is engaged, it will always be hidden regardless of the value passed in.
|
| ShowRealControllerGeometry |
Shows or hides hand geometry only. Note that this does not update the internal visibility state,
so if anything happens that will cause an update, then that will determine the visibility.
|
| ShowRealControllers |
Changes the visibility of the real controller models.
|
| Start |
Unity component method
|
| Update |
Unity component method
|
| UpdateHandVisibility |
Updates visibility of the hand geometry
|
Fields| Name | Description | |
|---|---|---|
  | EngageDistance |
Default distance to look for engagable objects
|
| InteractionSource |
Gets the interaction source of this controller
|
| InteractionTarget |
Gets the interaction target of this controller
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also