interactors - eisclimber/ExPresS-XR GitHub Wiki

ExPresSXR.Interaction.Interactors Namespace

Summary

Classes for interactors.

Classes

Name Description
HighlightableSocketInteractor 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.| |ObjectCheckSocketInteractor|An Expansion of the HighlightableSocketInteractor to restrict access to a single GameObject specified by targetObject. This allows to check if a special Object was placed in the socket using the OnSelectEntered-Event.| |ObjectSubmitSocketInteractor|An Expansion of the ObjectCheckSocketInteractor allowing submission of a single object, optionally disabling both the socket and submitted interactable.

The submission can be tested using "DEBUG Emit Submit Event" in the context menu for the component.| |PutBackSocketInteractor|An Expansion of the HighlightableSocketInteractor to restrict access to a single GameObject an instance of the putBackPrefab. After a certain amount of time outside the interactor and not being held or selected elsewhere, the object will be snap back to this socket.

The putBackPrefab will be automatically be instanced. If it does not have a XRGrabInteractable-Component and allowNonInteractables is true it will be instanced at the attach point of the socket but won't be able to be interacted with. If the component is missing and the non-interactables are disallowed the putBackPrefab will be set to null.

If the socket does not hold an object, it will be disabled.

The socket and putBackPrefab can be controlled by an Exhibition Display or any other component by setting externallyControlled to true. This will lock "PutBack" section of the sockets editor, as it is controlled elsewhere.| |TagCheckSocketInteractor|An Expansion of the HighlightableSocketInteractor to restrict access to GameObjects with the tags specified in _targetTags. This allows a set of multiple Object to be a valid target.

An empty string as targetTag will match the "Untagged"-tag.| |TagCheckSubmitSocketInteractor|An Expansion of the TagCheckSocketInteractor allowing submission of a objects by tag, optionally disabling both the socket and submitted interactable.

The submission can be tested using "DEBUG Emit Submit Event" in the context menu for the component.|

⚠️ **GitHub.com Fallback** ⚠️