AnnotationText

The AnnotationText node allows you to place a rect and add the text in it. It inherits from AnnotationBase and can be moved and stretched.

Platform support

This element is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.

Handles position and behavior

The AnnotationText has one handle at the right bottom, which can be used to resize the node.

Differently from all other annotation nodes, it's not only the size that changes, the font changes too. This is achieved by driving the fontScale value.

The same result can be achieved in three different ways:

• Moving the handle.

• Directly setting the fontScale.

• Using setFontScaleFromWidth. The sfunction calculates the proper fontScale value to meet the requested width.

The minimumFontScale field is used to define the lower limit for scaling and can be adjusted to prevent the fontScale from producing content that is too small and unreadable. The limit is applied consistently to all the three font scaling methods.

Customization

Additionally to all the customization fields derived from AnnotationBase, the AnnotationText has a few more fields:

• font—Manages the desired font family, dimension, and effect (such as bold or italic).

• backColor and editBackColor—AnnotationText has a background and these fields set the color when editing and when not.

• fontColor and editFontColor—Defines the text color when editing and when not.

• caretThickness—Customizes caret aspect.

• margin and interlineOffset—Adds additional space between the text and the borders or between text lines.

Selection and editing

By default, node selection and editing state are coupled. However, the node offers a few specific fields to decouple standard behavior:

• editOnSelection—Automatically couples edit state with selection state.

• editEnabled—Enables editing when needed without setting the select state.

Caret management

AnnotationText supports caret visualization and movements. Supported CARET actions are:

• Arrows movements

• Home and End

• PageUp and PageDown

In addition to this, click in any text point to directly position the caret where you like.

AnnotationText fields

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

Field inheritance: NodeBase > RectBase2D > AnnotationBase > AnnotationText