titles
The titles module provides a means to place text in the non-transformable 2D overlay of the viewer. The text is not transformed by viewer transformations and is positioned using sliders in the titles user interface.
The title text supports an expression editor with variables that can be connected via ports. Text formatting can be performed with a limited subset of Markdown and HTML syntax, including bold, italic, headings, lists, monospaced text, horizontal rules, colored text, font size, and font changes.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input String | String | Text containing the string used to create the title. |
| Input | Number 1 | Number | A value to use as a variable. |
| Input | Number 2 | Number | A value to use as a variable. |
| Input | String 1 | String | A string to use as a variable. |
| Output | Output Object | Renderable | A renderable object displaying the title. |
Properties
| Property | Type | Description |
|---|---|---|
| Title | Expression | The Title is the text to use for the Title. Supports variables {N1}, {N2}, and {S1}. |
Text Settings
| Property | Type | Description |
|---|---|---|
| Title Size | Double | The Title Size determines how large the title text will be. |
| Title Color | Color | The Title Color is the color to use for the Title. |
| Title Font | Font | Title Font allows the user to alter the basic look of the font. |
| Title Alignment | Horizontal Alignment | The horizontal alignment for the title text. |
Positioning
| Property | Type | Description |
|---|---|---|
| Anchor Side | Choice: Top, Bottom | The Anchor Side determines whether the title text is positioned off the top or bottom edge of the viewer. |
| Anchor Margin | Double | The Anchor Margin determines how far from the anchor side the near edge of the text will be. |
| Left Margin | Double | The Left Margin determines how close to the left edge of the viewer the text is allowed to be. |
| Right Margin | Double | The Right Margin determines how close to the right edge of the viewer the text is allowed to be. |
| Rotation | Double | The Rotation allows you to spin the title text around the center point. |
| Overlay | Choice: Behind Scene, In front of scene | The Overlay control allows the user to put the title behind the model or in front of it. |
Variables
| Property | Type | Description |
|---|---|---|
| N1 | Double | The N1 field is a double value that can be used as the variable {N1} in the expression. |
| N2 | Double | The N2 field is a double value that can be used as the variable {N2} in the expression. |
| S1 | String | The S1 field is a string value that can be used as the variable {S1} in the expression. |