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