UxrCompassTargetHint Class
When attached to a GameObject, it will tell the UxrCompass where to point to. Otherwise the compass will always point to the GameObject’s transform. It can be used to highlight different spots depending on the UxrCompassDisplayMode.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
UltimateXR.Core.Components.UxrComponent
UltimateXR.Guides.UxrCompassTargetHint
Namespace: UltimateXR.Guides
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public class UxrCompassTargetHint : UxrComponent
The UxrCompassTargetHint type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UxrCompassTargetHint |
Properties
| Name | Description | |
|---|---|---|
 | DefaultTarget | Gets or sets the target where the UxrCompass should point to by default, if the other transforms are null or not applicable. |
| GrabTarget | Gets or sets the target where the UxrCompass should point to when DisplayMode is Grab. |
| LocationTarget | Gets or sets the target where the UxrCompass should point to when DisplayMode is Location. |
| LookTarget | Gets or sets the target where the UxrCompass should point to when DisplayMode is Look. |
| UseTarget | Gets or sets the target where the UxrCompass should point to when DisplayMode is Use. |
Methods
| Name | Description | |
|---|---|---|
| GetTransform | Gets the appropriate transform where the compass should point to. |
Extension Methods
| Name | Description | |
|---|---|---|
 | CheckSetEnabled | Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.) |
| GetOrAddComponent<T> | Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.) |
| GetPathUnderScene | Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.) |
| GetSceneUid | Gets an unique identifier string for the given component. (Defined by ComponentExt.) |
| GetUniqueScenePath | Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.) |
| LoopCoroutine | Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.) |
| SafeGetComponentInParent<T> | Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.) |
| ShowInInspector(Boolean) | Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.) |
| ShowInInspector(Boolean, Boolean) | Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.) |
| ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |