Type Alias: Get3dInformationTemplate()

Get3dInformationTemplate = (meshId) => Promise<Nullable<TemplateData>>

Function

Retrieves template data for a 3D hotspot information display.

This method fetches the content associated with a specific mesh element's hotspot. Hotspots are interactive points on 3D models that display additional information when clicked or hovered over, such as feature explanations, specifications, or component details.

Hotspot templates can include rich text content, image galleries, and document links, providing detailed information about specific parts of the product without cluttering the main interface.

Parameters

meshId

string

ID of the mesh element associated with the hotspot

Returns

Promise<Nullable<TemplateData>>

A promise resolving to the template data if found, or null if no template exists

Example

// Display hotspot information when a mesh part is clicked
canvas.addEventListener('mesh-click', async (e) => {
  const meshId = e.detail.meshId;

  // Fetch the hotspot template data
  const templateData = await window.mimeeqApp.actions.get3dInformationTemplate(meshId);

  if (templateData) {
    // Display the hotspot information in a popup or panel
    showHotspotPopup(templateData);
  }
});