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. |