highlightablesocketinteractor - eisclimber/ExPresS-XR GitHub Wiki

HighlightableSocketInteractor

Class in ExPresSXR.Interaction.Interactors

Inherits from UnityEngine.XR.Interaction.Toolkit.Interactors.XRSocketInteractor

Summary

A SocketInteractor can shows a visual queue (highlighterObject) where the interactable area is of nothing is in the socket.

The visual queue can be scaled automatically if useColliderSizeAsScale is set to true and it this SocketInteractor has a SphereCollider- or BoxCollider-Component. If not the size can be set by modifying highlighterScale.

Make sure the highlighterObject does not have a Collider, only a Mesh and MeshRenderer.

public class HighlightableSocketInteractor : XRSocketInteractor

Methods

Name Description
CanSetHighlighterScaleWithCollider() If this component has either a Sphere-, Box- or CapsuleCollider and this HighlighterScale can be set automatically.
SetHighlighterVisible(bool) Sets the visibility of the highlighter.

Properties

Name Description
HighlighterObject The highlighter shown when no object is in the socket.
HighlighterScale The scale of the highlighterObject.
ShowHighlighter If the highlighter object should be shown when no object is in the socket.
UseColliderSizeAsScale Controls the scale of the provided highlighter by the scale of the sockets collider.
⚠️ **GitHub.com Fallback** ⚠️