Interface IProvidesSetHighlight
Provide control of scene object highlighting
Inherited Members
Namespace: Unity.Labs.EditorXR.Interfaces
Syntax
public interface IProvidesSetHighlight : IFunctionalityProviderMethods
SetBlinkingHighlight(GameObject, Boolean, Transform, Material, Boolean, Single, Single)
Method for highlighting objects
Declaration
IEnumerator SetBlinkingHighlight(GameObject go, bool active, Transform rayOrigin = null, Material material = null, bool force = false, float dutyPercent = 0.75F, float cycleDuration = 0.8F)Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | go | The object to highlight |
| Boolean | active | Whether to add or remove the highlight |
| Transform | rayOrigin | RayOrigin that hovered over the object (optional) |
| Material | material | Custom material to use for this object |
| Boolean | force | Force the setting or unsetting of the highlight |
| Single | dutyPercent | The percentage of time when the highlight is active |
| Single | cycleDuration | The duration for which to show this highlight. Keep default value of 0 to show until explicitly hidden |
Returns
| Type | Description |
|---|---|
| IEnumerator |
SetHighlight(GameObject, Boolean, Transform, Material, Boolean, Single)
Method for highlighting objects
Declaration
void SetHighlight(GameObject go, bool active, Transform rayOrigin = null, Material material = null, bool force = false, float duration = 0F)Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | go | The object to highlight |
| Boolean | active | Whether to add or remove the highlight |
| Transform | rayOrigin | RayOrigin that hovered over the object (optional) |
| Material | material | Custom material to use for this object |
| Boolean | force | Force the setting or unsetting of the highlight |
| Single | duration | The duration for which to show this highlight. Keep default value of 0 to show until explicitly hidden |