Hotspot

The Hotspot node attaches a clickable 2D overlay pointer to a 3D element.

• The hotspot is made up of an image and an optional text label.

• The image has three states: normal, over, and selected.

Platform support

This node is fully supported on XR-Windows platform.

It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.

The portable platforms do not support 3D mode.

Attachable entities

You can assign a hotspot to different alternative entity types:

• Mesh

• Object

• Collision Mesh (CMesh)

• An instantiated node that has a position SVEC3 field, such as item, a mesh, or an object.

Note: A hotspot can be attached to only one entity.

Highlight meshes

You can provide a hotspot with a list of meshesToHighlight.

When the highlightMeshes parameter is set to true, the attached entity and all other meshesToHighlight show a colored silhouette.

Hotspot sorting

Sorting of the hotspots has few differences depending on the mode type.

• mode2D hotspots: Sorting is based on order field value. Lower order hotspots are drawn over higher ones. When two or more hotspots share the same order they are sorted based on their distance from the camera. If all the hotspots have the same order the sorting is purely based on their distance from the camera.

• mode3D hotspots: They are sorted based on their distance from the camera. The order field is not supported for these type of hotspots.

Using internal textures

Internal textures can be used for any of the state images. Using internal textures enables you to create dynamic hotspot images based on Texture2D and RectBase2D nodes. You might use this, for example, to show the state of a dynamic parameter of the object to which the hotspot is attached.

RectBase2D node instances rendered into a Texture2D shown in a mode2D hotspot will receive mouse events in the same way as if they were a 2D interface, allowing more complex interaction setups for the hotspots.

Note: Support for internal textures behaves a bit differently between mode2D and mode3D. When mode2D is set, it is possible to show both the Internal Texture image and hotspot title. In mode3D, the hotspot title cannot be shown when the image is an internal texture.

The options dictionary

The options dictionary can contain different information, depending on the project scope. Use the options field to display information with the hotspot when the hotspot is selected. This information is used by the application.

Code example

This is a code example for the HotSpot node.

<Hotspot name="400HZ_SSFC_M-SSP54" position="-578.1995 0.731354 1246.958" range="0 200" attachedToMesh="Airport_Total|400HZ_SSFC_M-SSP54" group="1. 400Hz System,Solid State Frequency Converters (SSFC)" options="{camera=Cam_400HZ_SSFC_M-SSP54}{images=Data\Airport\Images\Solid State Frequency Converters (SSFC)}{url=Data\Airport\Datasheet\Datasheet - M-SSP54.htm}{detail3D=PL_400HZ_SSFC_M-SSP54}{url2=Data\Airport\Cars\CARS_Dubai_Airport_Pop_up_pits.htm}" title="M-SSP54" meshesToHighlight="Airport_Total|400HZ_SSFC_M-SSP54_01,Airport_Total|400HZ_SSFC_M-SSP54_02" silhouetteColor="0 1 1" textFont="Arial,Bold,22" textColor="0 1 1" textBackColor="0 0 0 0.7"/>

Hotspot fields

These are the fields for Hotspot node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > Hotspot