Icon module

The Icon module is a specialized module that exposes all glyphs in an icon font and makes them available through defines or static APIs.

To use the Icon module, as for every module, include it in the module.xml file. If you include the Icon module in your project, modules such as the ColorSelector, the ModularToolbar, the Compass module, and the Measure module will automatically use it.

Access the Icon module

To access the module there are two methods: defines or static API.

Access through defines

• @def:icon_module.fontName — For the icon font name.

• @def:icon_module.icons.<friendlyName> — For glyphs.

Example for defines

<Text2D name="icon" font=”[@def:icon_module.fontName],antialias,18” text="[@def:icon_module.icons. 3d--3d-y-axis]" visible="true" />

Access through static API

• IconModule::Utils::GetFontName()— Returns the icon font name.

• IconModule::Utils::GetCharForIcon("string friendlyName") — Returns the glyph for the given friendly name.

Example for static API

// Use glyph and font to set a UI control or text

• string glyph = IconModule::Utils::GetCharForIcon("3d--3d-y-axis");

• string font = IconModule::Utils::GetFontName();

Glyphs

This table contains all the glyphs names inside the icon font.