HomeGuides
HomeGuidesLearn about the Immerse SDK installerLog In

Beacon Tool

📘

This feature requires the Immerse SDK Enterprise Edition

This is different to the free Immerse SDK. Contact [email protected] if you require access.

Understand the difference between the Free and Enterprise SDK

The Beacon tool is installed via the Package Manager. This tool allows non-XR based users to communicate a position to other users in a session. This can be very useful when trying to guide another user towards a specific location or control. Once set up, a non-XR user can click anywhere in the world to create a ping to highlight a location that will appear to all users.

Getting Started

The Beacon tool requires two components in order to work, a View and a Trigger.

Beacon View

This component is what will render the beacon. By editing this or creating your own, you can control alter the appearance and behavior of the beacon.

Included BeaconView prefab settingsIncluded BeaconView prefab settings

Included BeaconView prefab settings

Once configured, it should be linked in the Beacon settings found in Project Settings > Immerse SDK > Beacon. Here you can also configure permissions set set who can view and show can send beacons.

Beacon Settings ViewBeacon Settings View

Beacon Settings View

Trigger

Once you have your view, all your need now is a way to send a beacon. Included in the SDK is a component that will send a beacon on a mouse click. This should be added to your scene to allow it to listen for input.

Included Beacon Trigger ComponentIncluded Beacon Trigger Component

Included Beacon Trigger Component

Description

Color

Color of the beacon to be sent

Offset

Apply an offset based on the normal of the raycast

Camera

Camera to use for raycasting. (Will use MainCamera if null)

Mask

LayerMask to use when raycasting from the camera

Max Distance

Max raycast distance