LabelViewer

The LabelViewer node enables you to manage Item labels display.

• The simulation module provides a default instance of this node called labelViewer.

• Generally, you do not need to create a new LabelViewer. Just modify the existing default LabelViewer to customize look and feel for labels.

• LabelViewer displays labels in both 2D and 3D modes, but only for those items that have a 3D label in the model.

• A label mesh must be created even though the labels appear in 2D mode.

Platform support

This node is supported on XR-Windows platform only.

Auto-generated labels

Label3D dynamically creates billboard meshes for all items for which a label texture is available and the labelVisible parameter is set to true.

Activate auto generation

• On the label3D mode, set the autoGenerate parameter to true.

Notes

• When autoGenerate is set to false, this is restricted to all items that have a modeled label in the geometry contents.

• When autoGenerate is set to true, label textures are automatically generated for all items that have no geometry label and labelVisible set to true.

Label positioning

• Automatically generated labels are placed above the item center at item bounding sphere radius distance.

• You can override label position using labelPositionOverride and labelPosition.

For more information, see Item.

LabelViewer fields

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

Field inheritance: NodeBase > LabelViewer