The Legend module is used to place a color scale bar in the viewer window.
The Legend module is used to place a color scale bar in the viewer window.
Place 3D axes in the viewer scaled by the model data and/or user defined limits.
Place a 3D North Arrow or Compass Rose in the Viewer.
Overlay the content from a second viewer in the viewer's non-transformable overlay.
Place a logo or other graphic object in the Viewer's non-transformable overlay.
Provides a straightforward means to place text in the Viewer.
Provides a straightforward means to place text in the Viewer.
Provides a means to interactively place 2D and 3D renderable text strings or to read an EMT file to place the text.
Place formatted labels at probed locations within the Viewer.
Convert values coming from various numeric and string input ports into a resultant string.
Subsections of Annotation
legend
The legend module is used to place a 2D legend which helps correlate colors to analytical values or materials. The legend shows the relationship between the selected data component for a particular module and the colors shown in the viewer. For this reason, the legend’s Input Object port must be connected to the output of a module which is connected to the viewer and is generally the dominant colored object in view.
Many modules with renderable output ports have a selector to choose which data component is used for coloring. The name of the selected data component will be displayed as the title of the legend if the label options are set to automatic (the default).
If the data component to be viewed is either Geo_Layer or Material_ID (for models where the grid is based upon geology), the Geology Legend port from gridding and horizons (or lithologic modeling) must also be connected to provide the geologic layer or material names for automatic labeling. When this port is connected it will have no effect if any other data component is selected.
The minimum and maximum values are taken from the data input as defined in the datamap. Labels can be placed at user defined intervals along the color scale bar. Labels can consist of user input alphanumerical values or automatically determined numerical values.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Object | Renderable | A renderable object for creating the Legend color scale. |
| Input | Geology Legend | Geology Legend | Geology legend information. |
| Input | Contour levels | Contours | Information required to properly set contour levels within Legend. |
| Output | Output Object | Renderable | A renderable object displaying the legend. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle, when deselected, will prevent the module from running. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Orientation | Choice: Horizontal, Vertical | Orientation allows the user to determine which orientation is used when creating a 2D Legend. |
| Anchor Point | Placement | The Anchor Point determines where to place the legend, and which point on the legend to base placement on. |
| Position Offset | 2D Percentage | The position offset for the legend placement. |
| Overlay | Choice: Behind Scene, In front of scene | The Overlay control allows the user to put the legend behind the model or in front of it. |
| Flip Legend | Boolean | The Flip Legend toggle inverts the legend putting high values at the bottom. |
| Units | String | The Units to add to the end of each label. |
| Texture X Scale | Double | The size of the scale in screen space (X direction). |
| Texture Y Scale | Double | The size of the scale in screen space (Y direction). |
Scale Properties
| Property | Type | Description |
|---|---|---|
| Scale Size | Double | The size of the scale in screen space. |
| Display Scale In Output | Boolean | The Display Scale in Output toggle specifies whether or not to output the colored portion of the legend in the Legend’s Output Object port. |
| Force Gradiated Colors | Boolean | The Force Gradiated Colors toggle will cause the Legend to display gradiated colors instead of solid color breaks when contour data is passed in. |
| Equally Size Contours | Boolean | The Equally Size Contours toggle will cause the Legend to display each contour as equal in size, rather than relative to the portion of the data range represented. |
| Use Integers As Contours | Boolean | The Use Integers As Contours toggle will cause the legend to treat the input data as contoured, with each integer being the label of each contour. |
| Aspect Ratio | Double | The Aspect Ratio restricts the size of the scale to a percentage of the Scale Size. |
| Boundary Lines | Boolean | The Boundary Lines toggle specifies whether or not a boundary box is to be drawn around the Legend scale bar. |
| Value Markers | Boolean | The Value Markers toggle specifies whether or not a tick mark is to be drawn at each label location. |
| Boundary Thickness | Double | The Boundary Thickness value determines how thick to draw the boundary lines, as a percentage of the scale size. |
| Boundary Color | Color | The Boundary Color sets the color of the lines that surround the Legend. |
| Value Marker Thickness | Double | The Value Marker Thickness value determines how thick to draw the ticks, as a percentage of the scale size. |
| Gap Size | Double | The Gap Size determines how large a gap to leave between solid blocks, as a percentage of the scale size. The labels must be centered, and the legend in solid or textured blocks for gaps to be allowed. |
Text Properties
| Property | Type | Description |
|---|---|---|
| Labels On | Boolean | The Labels On toggle is used to specify whether or not the data labels are to be displayed with the Legend. |
| Font | Font | The Title Font allows the user to alter the basic look of the font. |
| Title | Expression | Title sets the template the title is generated with. |
| Labels | Expression | Labels sets the template the labels are generated with. |
| Title Offset | 2D Percentage | The offset for the title position. |
| Label Offset | 2D Percentage | The offset for the label position. |
| Title Side | Choice: Left, Right, Top, Bottom | The Title Side determines where the title for the Legend will display. |
| Label Side | Choice: Left, Right, Top, Bottom | The Label Side determines which side of the scale to place the labels on. |
| Title Size | Double | The Title Size determines how large to make the title text. It scales with the Scale Size. |
| Label Size | Double | The Label Size determines how large to make the labels’ text. It scales with the Scale Size. |
| Title Alignment | Alignment | Title Alignment allows the user to align the title appropriately. |
| Label Alignment | Alignment | Label Alignment allows the user to align the labels appropriately. |
| Title Color | Color | The Title Color sets the color of the title that labels the Legend. |
| Label Color | Color | The Label Color sets the color of the labels on the Legend. |
| Label Min | Boolean | The Label Min toggle places a label at the bottom (min) of the data. This only applies to linear or log unformatted. |
| Label Max | Boolean | The Label Max toggle places a label at the top (max) of the data. This only applies to linear or log unformatted. |
| Label Bold | Boolean | The Label Bold toggle determines whether to bold the font used in labels. |
| Label Italic | Boolean | The Label Italic toggle determines whether to italicize the font used in labels. |
| Centered Analytic Labels | Boolean | Whether or not to use centered labels when working with contoured analytes. |
| Centered Analytic Label | Expression | Labels sets the template the labels are generated with when working with contoured analytes. |
| Label Angle | Double | The Label Angle specifies how to rotate the labels. |
| Label Type | Choice: Set By Data, Set By User | The Label Type allows the user to choose between data generated labels or user specified labels. |
| Logarithmic Decades | Choice: Log, Unformatted | When the data has been log processed, the Logarithmic Decades determines the number of label increments in the color scale bar. If the Log option is selected the Labels Per Log Decade value is used. If Unformatted is selected the Number Of Intervals is used. |
| Labels Per Log Decade | Integer | If the Log Option is selected for Logarithmic Decades, the increments per decade can be set with this value. |
| Number Of Intervals | Integer | If the data has been processed in linear space or the Unformatted option is selected for Logarithmic Decades, the total increments for the color scale bar can be set with this value. |
| Format Label Numbers | Number Formatting | The Format Label Numbers control allows the user to set how numbers that are turned into labels will be formatted. |
| Type In Labels | Editable Strings | If the Type-In Labels option is selected for Label Processing, the labels may be set using this control. |
| Prepend Min | String | The Prepend Min string is placed before the label for the minimum value in the Legend. |
| Prepend Max | String | The Prepend Max string is placed before the label for the maximum value in the Legend. |
3d legend
The 3d legend module is used to place a 3D legend in coordinate space which helps correlate colors to analytical values or materials. The legend shows the relationship between the selected data component for a particular module and the colors shown in the viewer. For this reason, the legend’s Input Object port must be connected to the output of a module which is connected to the viewer and is generally the dominant colored object in view.
Many modules with renderable output ports have a selector to choose which data component is used for coloring. The name of the selected data component will be displayed as the title of the legend if the label options are set to automatic (the default).
If the data component to be viewed is either Geo_Layer or Material_ID (for models where the grid is based upon geology), the Geology Legend port from gridding and horizons (or lithologic modeling) must also be connected to provide the geologic layer or material names for automatic labeling. When this port is connected it will have no effect if any other data component is selected.
The minimum and maximum values are taken from the data input as defined in the datamap. Labels can be placed at user defined intervals along the color scale bar. Labels can consist of user input alphanumerical values or automatically determined numerical values.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Object | Renderable | A renderable object for creating the Legend color scale. |
| Input | Input Z Scale | Number | The factor for vertical scaling. |
| Input | Geology Legend | Geology Legend | Geology legend information. |
| Input | Contour levels | Contours | Information required to properly set contour levels within Legend. |
| Output | Output Z Scale | Number | The factor for vertical scaling. |
| Output | Title Output | String | Text containing the Title. |
| Output | Output Legend | Field | This field allows the colored legend portion to be texture mapped with modules such as contour texture. |
| Output | Output Object | Renderable | A renderable object displaying the Legend. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle, when deselected, will prevent the module from running. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Z Scale | Double | The Z Scale is the vertical exaggeration to be applied to the output object. |
Legend 3D Options
| Property | Type | Description |
|---|---|---|
| Legend Direction 3D | Choice: +X, +Y, +Z | The Legend Direction 3D allows the user to set the orientation of the Legend when creating a 3D Legend. |
| X Origin | Double | The starting X coordinate to draw the Legend from. |
| Y Origin | Double | The starting Y coordinate to draw the Legend from. |
| Z Origin | Double | The starting Z coordinate to draw the Legend from. |
| Legend Size | Double | The length of the Legend in coordinate space in the direction indicated by Orientation. |
| Legend Width | Double | The width of the legend as a percentage of the model size. |
| Legend Depth | Double | The depth of the legend as a percentage of the model size. |
Label Options
| Property | Type | Description |
|---|---|---|
| Labels On | Boolean | The Labels On toggle is used to specify whether or not the data labels are to be displayed with the Legend. |
| Label Min | Boolean | The Label Min toggle places a label at the bottom (min) of the data. This only applies to linear or log unformatted. |
| Label Max | Boolean | The Label Max toggle places a label at the top (max) of the data. This only applies to linear or log unformatted. |
| Label Color | Color | The color to set each label. |
| Label Type | Choice: Set By Data, Set By User | The Label Type allows the user to choose between data generated labels or user specified labels. |
| Logarithmic Decades | Choice: Log, Unformatted | When the data has been log processed, the Logarithmic Decades determines the number of label increments in the color scale bar. If the Log option is selected the Labels Per Log Decade value is used. If Unformatted is selected the Number Of Intervals is used. |
| Labels Per Log Decade | Integer | If the Log Option is selected for Logarithmic Decades, the increments per decade can be set with this value. |
| Number Of Intervals | Integer | If the data has been processed in linear space or the Unformatted option is selected for Logarithmic Decades, the total increments for the color scale bar can be set with this value. |
| Type In Labels | Editable Strings | If the Type-In Labels option is selected for Label Processing, the labels may be set using this control. |
| Centered Type In Labels | Boolean | Whether to center the type-in labels. |
| Title | String | The specified title to set for the Legend. |
| Units | String | The Units to add to the end of each label. |
| Units Display | Choice: End of value, End of Title, Below Title | The Units Display will affect where the units for the Legend will display, either after each value or appended to the title. |
| Format Label Numbers | Number Formatting | The Format Label Numbers control allows the user to set how numbers that are turned into labels will be formatted. |
| Label Offset | Double | The Label Offset is the distance from the Legend the labels are created. |
| Title Offset | Double | The Title Offset is the distance from the Legend the title is created. |
| Font Type | Choice: Forward Facing Fonts, TrueType Fonts, Line Fonts | The Font Type allows the user to select between three font types. Forward Facing Fonts will always be aligned to the View. TrueType fonts are standard fonts. Line fonts are low impact fonts which perform better when large numbers of labels are generated. |
| TrueType Font Style | Font | The TrueType Font Style allows the user to alter the basic look of the font. |
| 3D Label Settings | Label Settings | 3D Label Settings allow the user to align the labels to an appropriate view. |
| Forward Facing Style | Forward Facing | Forward Facing Style allows the user to align the labels to an appropriate view and to alter the basic layout of the font. |
| Width Height Aspect | Double | The Width Height Aspect determines the aspect ratio of the label text. A small width to height ratio creates narrow text and a large ratio creates wide text. This is not enabled when using a Forward Facing Font. |
| Position Around Scale | Choice: Left Back, Right Back, Right Front, Left Front, Middle Back, Right Middle, Middle Front, Left Middle | The Position Around Scale lets the user choose which corner of the break on the color scale to start writing the label at. |
| Prepend Min | String | The Prepend Min string is placed before the label for the minimum value in the Legend. |
| Prepend Max | String | The Prepend Max string is placed before the label for the maximum value in the Legend. |
Display Settings
| Property | Type | Description |
|---|---|---|
| Datamap Min | Double | The Datamap Min value is used to override the default minimum range from the input when setting the color scale. |
| Datamap Max | Double | The Datamap Max value is used to override the default maximum range from the input when setting the color scale. |
| Flip Legend | Boolean | The Flip Legend toggle inverts the legend putting high values at the bottom. |
| Boundary Lines | Boolean | The Boundary Lines toggle specifies whether or not a boundary box is to be drawn around the Legend scale bar. |
| Value Markers | Boolean | The Value Markers toggle specifies whether or not a tick mark is to be drawn at each label location. |
| Boundary | Double | The Boundary value offsets the boundary lines from the Legend. The lines are offset in the directions perpendicular to the orientation. |
| Boundary Color | Color | The Boundary Color sets the color of the lines that surround and divide the Legend. |
| Display Scale In Output | Boolean | The Display Scale in Output toggle specifies whether or not to output the colored portion of the legend in the Legend’s Output Object port. |
| Force Gradiated Colors | Boolean | The Force Gradiated Colors toggle will cause the Legend to display gradiated colors instead of solid color breaks when contour data is passed in. |
axes
The axes module is used to place 3D axes in the viewer scaled by the model data and/or user defined limits. Axes accepts data from many of the Subsetting and Processing modules and outputs directly to the viewer. Data passed to axes should come from modules which have scaled or transformed the mesh data, for example explode and scale. Axes generated by this module and displayed in the viewer are transformable with other objects in the viewer.
The user interface to axes is very comprehensive. Each coordinate direction axis can be individually controlled. Axis labels and tick marks for each axis can be specified. The label font, label precision, label orientation, and other label parameters are all user specified.
Axes requires a field input or renderable objects to position and size the axes. If you disconnect the field input port, you no longer lose the axes bounds values and your axes remain in place. This is useful when field data changes in an animation so that you don’t constantly recreate the axes.
The size of text and tick marks is based on a percentage of the x-y-z extent of the input field. This allows you to set the extent of one or more axes to zero so you can have a scale of only one or two dimensions.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Objects | Renderable | Any number of renderable objects used to determine extents. |
| Input | Input Geologic Field | Field | The field to use for determining extents. |
| Input | Explode | Number | The value used to determine whether the model has been exploded. |
| Input | Z Scale | Number | The factor for vertical scaling. |
| Output | Output Object | Renderable | The renderable object used for connecting to the viewer. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | This toggle will prevent the module from running when turned to the Off position. |
| Z Scale | Double | The Z Scale is required to assure that axes are matched to scaled input. |
| Explode | Double | The Explode value is used to turn off the labelling along the Z Axis as this would be inappropriate for any exploded models. |
| Execute | Button | The Run Once button will allow the module to run one time even if the Allow Run toggle is turned to the off position. This allows the user to make multiple changes with only one update. |
Spatial Definition
| Property | Type | Description |
|---|---|---|
| Axes Extents | 3D Range | The Axes Extents are used to specify the extents for the axes when Define Extents is selected. Choose “Refresh Extents” to recalculate based on the currently connected view or objects. |
| Round Extents | Boolean | Round Extents increases the extents of the model to have the labeling start at logical coordinates rounded down at the minimum of x, y, and z and rounded up at the maximum. |
| Offset Factor | Double | Offset Factor is a percentage to offset the extents beyond the data extents. |
| Center Coordinates | Coordinate 3D | The Center Coordinates allow the user to set the actual coordinate to use for each axis center. When linked the values are set by the Display X, Y, and Z Label controls. |
| Display X Label | Choice: At Min Extent, At Max Extent | The Display X Label allows the user to choose whether to place the labels for the X axis at the min or max extent. |
| Display Y Label | Choice: At Min Extent, At Max Extent | The Display Y Label allows the user to choose whether to place the labels for the Y axis at the min or max extent. |
| Display Z Label | Choice: At Min Extent, At Max Extent | The Display Z Label allows the user to choose whether to place the labels for the Z axis at the min or max extent. |
| Label Origin Method | Choice: Default, Application Origin, Custom | The Label Origin Method determines how the origin is set for labeling axes. The Application Origin option is intended for fences projected to 2D. Custom allows you to define your own origin for labels. |
| Label Origin | Coordinate 3D | Axes Origin lets you change the labelling (e.g. to make axes with labels starting at zero in x, y and z lined up to local origin). |
| Interval Reference Point | Coordinate 3D | The Interval Reference Point is used when Set Interval is selected. This control allows the user to set the origin point for the grid lines. |
| Interval Spacing | Coordinate 3D | The Interval Spacing is used when Set Interval is selected. This control allows the user to set the spacing between each grid line for the X, Y, and Z axis. |
| Minor To Major Intervals | Integer | The Minor To Major Intervals control is used to determine how many minor intervals for every major interval. |
| Max Intervals | Integer | The Max Intervals will limit the number of intervals created when the Set Interval toggle is selected. |
Display Settings
| Property | Type | Description |
|---|---|---|
| Label Subsetting | Choice: None, Blank Labels | The Label Subsetting option enables or disables the automatic removal of overlapping labels. |
| Blank Factor | Double | The Blank Factor value represents a scale used when determining the bounds of a label for overlap avoidance. The scale is based off the height of the label. |
| Draw Box | Boolean | The Draw Box toggle is used to specify if the axes should be drawn as a box around the data domain or as single X, Y, and Z lines. |
| Draw Ticks | Boolean | The Draw Ticks toggle is used to specify if the ticks should be drawn along the axes. |
| Box Line Width | Integer | Box Line Width determines the thickness of the box lines. 0 (and 1) give a single pixel wide line and larger numbers give wider lines. |
| Display Major | Boolean | The Display Major toggle is used to specify whether the major tick marks and labels are displayed. |
| Display Minor | Boolean | The Display Minor toggle is used to specify whether the minor tick marks and labels are displayed. |
| Major Gridline Style | Choice: Solid, Dashed, Dotted, Dashed-Dotted | The Major Gridline Style controls the way the Major Gridline is displayed. |
| Minor Gridline Style | Choice: Solid, Dashed, Dotted, Dashed-Dotted | The Minor Gridline Style controls the way the Minor Gridline is displayed. |
| Major Line Width | Integer | The Major Line Width control allows the user to set the width of the Major Gridline in pixels. |
| Minor Line Width | Integer | The Minor Line Width control allows the user to set the width of the Minor Gridline in pixels. |
| Display XY Grid At Min | Boolean | The Display XY Grid At Min toggle will determine whether grid lines are displayed at the XY Grid minimum extents. |
| Display XY Grid At Max | Boolean | The Display XY Grid At Max toggle will determine whether grid lines are displayed at the XY Grid maximum extents. |
| Display XZ Grid At Min | Boolean | The Display XZ Grid At Min toggle will determine whether grid lines are displayed at the XZ Grid minimum extents. |
| Display XZ Grid At Max | Boolean | The Display XZ Grid At Max toggle will determine whether grid lines are displayed at the XZ Grid maximum extents. |
| Display YZ Grid At Min | Boolean | The Display YZ Grid At Min toggle will determine whether grid lines are displayed at the YZ Grid minimum extents. |
| Display YZ Grid At Max | Boolean | The Display YZ Grid At Max toggle will determine whether grid lines are displayed at the YZ Grid maximum extents. |
All Axes Settings
| Property | Type | Description |
|---|---|---|
| Display Axes | Boolean | The Display Axes toggle will turn on or off the visibility of all axes. |
| Axes Color | Color | The Axes Color allows the user to set the color for all axes. |
| Label Type | Choice: Forward Facing Fonts, TrueType Fonts, Line Fonts | The Label Type allows the user to select between three font types. Forward Facing Fonts will always be aligned to the View. TrueType fonts are standard fonts. Line fonts are low impact fonts which perform better when large numbers of labels are generated. |
| TrueType Font Style | Font | The TrueType Font Style allows the user to alter the basic look of the font. |
| Forward Facing Style | Forward Facing | Forward Facing Style allows the user to align the labels to an appropriate view and to alter the basic layout of the font. |
| Title Height Factor | Double | The Title Height value allows the user to set the height for the title on each axis as a percentage of the Tick Label Height. |
| Title Offset | Double | The Title Offset is a distance to offset the Name from the corner of the axes box. This value affects all axes. |
| Tick Label Height | Double | The Tick Label Height value allows the user to set the height for the tick labels on each axis as a percentage of the total axes extent. |
| Tick Label Precision | Integer | The Tick Label Precision determines how the tick positions (numeric values) will be determined. For values of zero and larger it determines the number of decimal points. Negative values attempt to automatically determine the optimal number of decimal points. |
| Tick Scale | Double | The Tick Scale affects the relative size of the Tick marks and the label offsetting for all axes. |
| Tick Label Offset | Double | Tick Label Offset is a distance to offset the Tick label from the end of the tick mark. This value will be set for all axes. |
| Show Labels | Boolean | The Show Labels toggle will turn on or off the labels for all axes. |
| Automatic Text Placement | Boolean | Automatic Text Placement automatically handles the label options based on centering options selected. This toggle does not affect Forward Facing Font styles. |
X Axis Settings
| Property | Type | Description |
|---|---|---|
| Display Axis | Boolean | The Display Axis will allow the user to turn on or off the visibility of the axis. |
| Axis Color | Color | The Axis Color allows the user to set the color for the entire axis and the labels for that axis. |
| Title Name | String | The Title Name allows the user to set the label for the axis. |
| Title Offset | Double | The Title Offset is a distance to offset the Title Name from the corner of the axes box. |
| Tick Label Precision | Integer | Tick Label Precision determines how the tick labels will be determined. For values of zero and larger it determines the number of decimal points. Negative values attempt automatic determination. |
| Tick Label Offset | Double | Tick Label Offset is a distance to offset the Tick label from the end of the tick mark. |
| Show Labels | Boolean | The Show Labels toggle will allow the user to turn on or off the labels along the axis. |
| 3D Label Settings | Label Settings | 3D Label Settings allow the user to align the labels to an appropriate view. This is disabled when Automatic Text Placement is on. |
Y Axis Settings
| Property | Type | Description |
|---|---|---|
| Display Axis | Boolean | The Display Axis will allow the user to turn on or off the visibility of the axis. |
| Axis Color | Color | The Axis Color allows the user to set the color for the entire axis and the labels for that axis. |
| Title Name | String | The Title Name allows the user to set the label for the axis. |
| Title Offset | Double | The Title Offset is a distance to offset the Title Name from the corner of the axes box. |
| Tick Label Precision | Integer | Tick Label Precision determines how the tick labels will be determined. For values of zero and larger it determines the number of decimal points. Negative values attempt automatic determination. |
| Tick Label Offset | Double | Tick Label Offset is a distance to offset the Tick label from the end of the tick mark. |
| Show Labels | Boolean | The Show Labels toggle will allow the user to turn on or off the labels along the axis. |
| 3D Label Settings | Label Settings | 3D Label Settings allow the user to align the labels to an appropriate view. This is disabled when Automatic Text Placement is on. |
Z Axis Settings
| Property | Type | Description |
|---|---|---|
| Display Axis | Boolean | The Display Axis will allow the user to turn on or off the visibility of the axis. |
| Axis Color | Color | The Axis Color allows the user to set the color for the entire axis and the labels for that axis. |
| Title Name | String | The Title Name allows the user to set the label for the axis. |
| Title Offset | Double | The Title Offset is a distance to offset the Title Name from the corner of the axes box. |
| Tick Label Precision | Integer | Tick Label Precision determines how the tick labels will be determined. For values of zero and larger it determines the number of decimal points. Negative values attempt automatic determination. |
| Tick Label Offset | Double | Tick Label Offset is a distance to offset the Tick label from the end of the tick mark. |
| Show Labels | Boolean | The Show Labels toggle will allow the user to turn on or off the labels along the axis. |
| 3D Label Settings | Label Settings | 3D Label Settings allow the user to align the labels to an appropriate view. This is disabled when Automatic Text Placement is on. |
direction indicator
The direction indicator module is used to place a 3D North Arrow or Compass Rose in the 3D viewer scaled by the model data and/or user defined parameters.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Z Scale | Number | The factor for vertical scaling. |
| Output | Output Object | Renderable | A renderable object displaying a north arrow or compass rose. |
Properties
| Property | Type | Description |
|---|---|---|
| Visible | Visibility | Controls the visibility of the object. Excluded prevents inclusion in supported exports. Locked makes the object always visible in supported exports. |
| Z Scale | Double | The Z Scale is the vertical exaggeration to be applied to the input field and this is used to determine default sizes and positions. |
| Display Type | Choice: North Arrow, Compass Rose | The Display Type allows the user to select between a north arrow and a compass rose as output. |
| X Center | Double | The X center of the chosen display type object. |
| Y Center | Double | The Y center of the chosen display type object. |
| Z Center | Double | The Z center of the chosen display type object. |
| Height Factor | Double | The Height Factor scales the vertical height of the output object. |
North Arrow Settings
| Property | Type | Description |
|---|---|---|
| Arrow Size | Double | The Arrow Size scales the size in all dimensions of the output object. |
| Arrow Bevel | Double | The Arrow Bevel affects the degree of bevelling on the north arrow. |
| Stem Width | Double | The Stem Width affects the width of the arrow’s stem (shaft). |
| Stem Length | Double | The Stem Length Factor affects the length of the arrow’s stem (shaft). |
| Triangle Base Factor | Double | The Triangle Base Factor affects the width of the arrow’s head. |
| North Color | Color | The North Arrow is a solid color which can be selected using this control. |
Compass Rose Settings
| Property | Type | Description |
|---|---|---|
| Rose Size | Double | The Rose Size scales the output object in all dimensions. |
| North Length | Double | The North Length Factor allows you to exaggerate the length of the north pointing shaft. |
| Sub Cardinal Length | Double | The Sub-Cardinal Length Factor controls the length of the 45 degree shafts relative to the primary shafts. |
| Inner Radius Factor | Double | The Inner Radius Factor controls the radius of the solid core section. |
| Primary Color | Color | The compass rose is made of two colors; the first can be set using this control. |
| Secondary Color | Color | The compass rose is made of two colors; the second can be set using this control. |
Label Settings
| Property | Type | Description |
|---|---|---|
| Label Type | Choice: TrueType Fonts, Line Fonts | The Label Type allows the user to select between two font types. TrueType fonts are standard fonts. Line fonts are low impact fonts which perform better when large numbers of labels are generated. |
| Font Base Scale | Double | The Font Base Scale affects the size of all text objects. |
| Flip Labels | Boolean | Flip Labels makes the text readable from the underside. |
| TrueType Font Style | Font | The TrueType Font Style allows the user to alter the basic look of the font. |
| Font Color | Color | The Font Color allows the user to set the value for the color of the Font. |
| North Label | Cardinal | The North Label sets all values related to the text on the North end of either the compass rose or the north arrow. |
| East Label | Cardinal | The East Label sets all values related to the text on the East end of the compass rose. |
| South Label | Cardinal | The South Label sets all values related to the text on the South end of the compass rose. |
| West Label | Cardinal | The West Label sets all values related to the text on the West end of the compass rose. |
| Sub Cardinal Labels | Sub Cardinal | The Sub Cardinal Labels control sets all values related to the text at the sub cardinal directions of the compass rose. |
viewer to frame
The viewer to frame module is used to place an image of one viewer inside a second viewer’s non-transformable overlay. There are sliders to adjust size and position.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | View | View | The view containing all associated renderable objects. |
| Output | Output Object | Renderable | A renderable object displaying the logo. |
Properties
| Property | Type | Description |
|---|---|---|
| Include Overlay | Boolean | Include the overlays (such as legend and titles) from the original viewer. |
| Include Background | Boolean | Include the background and underlays (such as titles behind scene) from the original viewer. |
| Size | Double | Specify the width and height of the image in percentage of screen height or width. |
| Size By | Choice: Width, Height | Specify whether the sizing is determined by screen height or width. |
Positioning
| Property | Type | Description |
|---|---|---|
| Anchor Point | Placement | The Anchor Point determines where to place the legend, and which point on the legend to base placement on. |
| Position Offset | 2D Percentage | The position offset for placement. |
| Overlay | Choice: Behind Scene, In front of scene | The Overlay control allows the user to put the logo behind the model or in front of it. |
add logo
The add logo module is used to place a logo or other graphic object in the viewer’s non-transformable overlay. There are sliders to adjust size and position and a control to select the image file to use as a logo.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Output | Output Object | Renderable | A renderable object displaying the logo. |
Properties
| Property | Type | Description |
|---|---|---|
| Filename | File | The image file to be used for the logo. |
| Size | Double | Specify the width and height of the image in percentage of screen height. |
| Size By | Choice: Width, Height | Specify whether the sizing is determined by screen height or width. |
Positioning
| Property | Type | Description |
|---|---|---|
| Anchor Point | Placement | The Anchor Point determines where to place the legend, and which point on the legend to base placement on. |
| Position Offset | 2D Percentage | The position offset for placement. |
| Overlay | Choice: Behind Scene, In front of scene | The Overlay control allows the user to put the logo behind the model or in front of it. |
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. |
3d titles
The 3d titles module provides a means to place text in 3D space of your model. The text is transformed by viewer transformations and is positioned using X, Y, and Z sliders in the user interface.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input String | String | Text containing the string used to create the title. |
| Input | Z Scale | Number | The vertical factor applied to the input field. This is only used for 3D titles. |
| Output | Output Object | Renderable | A renderable object intended for using with transform group or when using field or object input. |
Properties
| Property | Type | Description |
|---|---|---|
| Z Scale | Double | The Z Scale is required to assure that text is matched to scaled input. |
| X Coordinate | Double | The X Coordinate specifies the location of the lower left edge of the title in coordinate space. |
| Y Coordinate | Double | The Y Coordinate specifies the location of the lower left edge of the title in coordinate space. |
| Z Coordinate | Double | The Z Coordinate specifies the location of the lower left edge of the title in coordinate space. |
| Width Height Ratio | Double | The Width Height Ratio allows you to stretch or compress the font to adjust for non-square Viewer induced distortions. |
| Title Text | String | The Title Text is the text to use for the Title. |
| Title Color | Color | The color of the title text. |
| Font Type | Choice: Forward Facing Fonts, TrueType Fonts, Line Fonts | The Font Type allows the user to select between three font types. Forward Facing Fonts will always be aligned to the View. TrueType fonts are standard fonts. Line fonts are low impact fonts which perform better when large numbers of labels are generated. |
| Forward Facing Style | Forward Facing | Forward Facing Style allows the user to align the labels to an appropriate view and to alter the basic layout of the font. |
| TrueType Font Style | Font | The TrueType Font Style allows the user to alter the basic look of the font. |
| 3D Font Settings | Label Settings | 3D Label Settings allow the user to align the labels to an appropriate view. |
place text
The place text module provides a means to interactively place 2D and 3D renderable text strings or to read a .PT file (or legacy .EMT file) to place the text. Text can be positioned interactively by probing in the viewer, or imported from a file.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Explode | Number | The value used to determine whether the model has been exploded. |
| Input | Input Z Scale | Number | The factor for vertical scaling. |
| Input | Subsetting Feature | Field | A field containing a line for subsetting. |
| Output | Output Explode | Number | The value used to determine whether the model has been exploded. |
| Output | Output Z Scale | Number | The factor for vertical scaling. |
| Output | Output Object | Renderable | A renderable object displaying the placed text. |
Properties
| Property | Type | Description |
|---|---|---|
| Import File | File | Import existing text from a .pt (place text) file. |
| Reload Import File | Button | The Reload Import File button forces the module to reload the Import File. |
| Visible | Visibility | Controls the visibility of the object. Excluded prevents inclusion in supported exports. Locked makes the object always visible in supported exports. |
| Z Scale | Double | The Z Scale is required to assure that text is matched to scaled input. |
| Explode | Double | The explode factor to apply to each text string based on its Explode ID. |
| Export File | File | Export current text to a .pt (place text) file. |
Text Settings
| Property | Type | Description |
|---|---|---|
| Probe Action | Choice: None, Reset Position, Add Text | Allows for the changing of the text center or for adding a new string at the probed location. Only available when the viewer is connected. |
| Forward Facing Style | Forward Facing | Forward Facing Style allows the user to align the labels to an appropriate view and to alter the basic layout of the font. These values are module wide so apply to all Forward Facing selected fonts. |
| Trim White Space | Boolean | The Trim White Space control when selected will remove leading and trailing spaces from all text. |
| Texts | Text Editor | The text entries to place in the scene. |
Projection Options
| Property | Type | Description |
|---|---|---|
| Subset Region | Choice: Within Line Distance, Outside Line Distance | The Subset Region allows the user to either keep the text within Distance to Line or to keep only the text outside that distance. |
| Distance To Line | Double | The Distance To Line value is used to subset the text to within a distance from the line passed into the Subsetting Feature port. |
| Straighten To 2D | Boolean | The Straighten to 2D toggle is used to project the position of 3D text to a 2D representation, where each text x coordinate value becomes the distance to the line passed into the Subsetting Feature port. |
| Straightened Plane | Choice: Export in XZ, Export in XY | The Straightened Plane allows the user to set the plane the straightened text are in. This requires a line passed into the Subsetting Feature, and text that has been Straightened to 2D. |
interactive labels
The interactive labels module allows the user to place formatted labels at probed locations within the viewer. The data displayed is the data at the probed location. Labels use an expression editor that supports variables derived from the probed data as well as external inputs.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Z Scale | Number | The factor for vertical scaling. |
| Input | Input Explode | Number | The value used to determine whether the model has been exploded. |
| Input | Number Variable | Number | A value used as a variable in the expression. |
| Input | Input String Variable | String | A string used as a variable in the expression. |
| Output | Output Z Scale | Number | The factor for vertical scaling. |
| Output | Output Explode | Number | The value used to determine whether the model has been exploded. |
| Output | Output Number Variable | Number | A value used as a variable in the expression. |
| Output | Output String Variable | String | A string used as a variable in the expression. |
| Output | Output Object | Renderable | A renderable object displaying the labels. |
Properties
| Property | Type | Description |
|---|---|---|
| Visible | Visibility | Controls the visibility of the object. Excluded prevents inclusion in supported exports. Locked makes the object always visible in supported exports. |
| Z Scale | Double | The Z Scale is required to assure that labels are matched to scaled input. |
| Explode | Double | The explode factor to apply to each label based on its Explode ID. |
| Export File | File | Export current labels to a .pt (EVS place Text) file. This will also create an .elf to store the leader lines if the Create Leader Line option is selected. |
Label Settings
| Property | Type | Description |
|---|---|---|
| N1 | Double | The N1 value is a floating value that is passed in via the Number Variable port for use in the expressions. |
| S1 | String | The S1 value is a string value that is passed in via the Input String Variable port for use in the expressions. |
| Create Leader Lines | Boolean | Turning on the Create Leader Lines toggle will cause a line to be created from the probe point to the label origin. |
| Probe Action | Choice: None, Reset Position, Add Label | Allows for the changing of the label origin or for adding a new label at the probed location. Only available when the viewer is connected. |
| Forward Facing Style | Forward Facing | Forward Facing Style allows the user to align the labels to an appropriate view and to alter the basic layout of the font. These values are module wide so apply to all Forward Facing selected fonts. |
| Control Expression | Expression | The Control Expression is the expression used by all labels with a linked Expression value. Supports variables: {N1}, {S1}, {CoordinateX}, {CoordinateY}, {CoordinateZ}, {Name}, {Value}, {Units}. |
| Labels | Interactive Labels | The list of placed labels and their individual settings. |
format string
The format string module allows you to construct a complex string (for use in titles or as file names) using multiple string and numeric inputs. An expression determines the content of the output. The expression is treated as a Python f-string which allows for the use of variables with Python expressions and format specifiers.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Z Scale | Number | The factor for vertical scaling. |
| Input | Explode | Number | The value used for separating output based on geology. |
| Input | Number 1 | Number | A value to use as a variable. |
| Input | Number 2 | Number | A value to use as a variable. |
| Input | Number 3 | Number | A value to use as a variable. |
| Input | Number 4 | Number | A value to use as a variable. |
| Input | Number 5 | Number | A value to use as a variable. |
| Input | Number 6 | Number | A value to use as a variable. |
| Input | String 1 | String | A string to use as a variable. |
| Input | String 2 | String | A string to use as a variable. |
| Input | String 3 | String | A string to use as a variable. |
| Input | String 4 | String | A string to use as a variable. |
| Input | Date | Date | The date to use as an input. |
| Output | Result String | String | A string created by solving the module expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Expression | Expression | The Expression allows the user to control the sequence of variables used to create the output string. Supports variables: {Scale}, {Explode}, {N1} through {N6}, {S1} through {S4}, and {Date}. |
| Date Format | String | The Date Format allows the user to control how Date values will be displayed in the output string. |
Variables
| Property | Type | Description |
|---|---|---|
| Scale | Double | Scale is the scaling factor for vertical (z) coordinates. This value reflects a multiplication factor of the layer thickness. |
| Explode | Double | The Explode value is the distance between exploded layers, cell sets or materials. |
| 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. |
| N3 | Double | The N3 field is a double value that can be used as the variable {N3} in the expression. |
| N4 | Double | The N4 field is a double value that can be used as the variable {N4} in the expression. |
| N5 | Double | The N5 field is a double value that can be used as the variable {N5} in the expression. |
| N6 | Double | The N6 field is a double value that can be used as the variable {N6} in the expression. |
| S1 | String | The S1 field is a string value that can be used as the variable {S1} in the expression. |
| S2 | String | The S2 field is a string value that can be used as the variable {S2} in the expression. |
| S3 | String | The S3 field is a string value that can be used as the variable {S3} in the expression. |
| S4 | String | The S4 field is a string value that can be used as the variable {S4} in the expression. |
| Date | Date | The Date field is a date value that can be used as the variable {Date} in the expression. |
Output
| Property | Type | Description |
|---|---|---|
| Result | String | The Result is the output string created by resolving the Expression. This field is read-only. |