# VTFx Properties

Envision VTFx File Format - Properties Documentation

# Envision VTFx File Format - Properties Documentation

This file contains a detailed description of each property available in the VTFx format. This documentation is a part of the HOOPS Envision VTFx documentation and describes the contents of the PropertySetCollection specified in cee::vtfx::Case::setProperties()

## Class type='background'

Specification of the background color(s). Specify either single_background_color or both top_background_color and bottom_background_color.

Property name | Type | Default Value | Legal Values | Description
single_background_color | Color3f |  |  | Single (uniform) background color
top_background_color | Color3f |  |  | Top color of a graded background
bottom_background_color | Color3f |  |  | Bottom color of a graded background

## Class type='overlay_image'

Specification of an overlay image (2D image shown somwhere fixed in the 3D view, e.g. a company logo). A property set can have many such groups.

Property name | Type | Default Value | Legal Values | Description
image_name | String |  |  | Name of the image to display
image_scale_width | Double | 1.0 |  | Scale factor (x direction) for the image
image_scale_height | Double | 1.0 |  | Scale factor (y direction) for the image
layout_corner | String |  | top_left, bottom_left, top_right, bottom_right | Corner to position the layout item in
layout_direction | String |  | horizontal, vertical | Direction from the given corner to layout the item
blending_mode | String |  | no_blending, global_alpha, texture_alpha | Image blending mode (transparency)
global_alpha | Float |  |  | Global alpha opacity value (1.0 opaque, 0.0 totally transparent)

## Class type='camera'

Spesification of the default camera configuration to use when the file is opened. Only one camera group is supported in one property set.

Property name | Type | Default Value | Legal Values | Description
eye | Vec3d |  |  | Eye point
vrp | Vec3d |  |  | View reference point
vup | Vec3d |  |  | Up vector
projection_type | String | perspective | perspective, ortho | Projection type
field_of_view_y_degrees | Double |  |  | Total field of view in Y direction in degrees. Only applicable for perspective projections.
ortho_height | Double |  |  | Size of the view volume in Y direction. Only applicable for orthographic projections.

## Class type='view_clipping_plane'

Spesification of clipping planes. Only one view clipping plane is supported in one property set.

Property name | Type | Default Value | Legal Values | Description
point | Vec3d |  |  | Point in plane
normal | Vec3d |  |  | Plane normal

## Class type='result_selection'

Specify which results (scalars, vectors, displacments, etc) to show on the model. Only one result_selection group is supported in one property set.

Property name | Type | Default Value | Legal Values | Description
fringes_result_id | Int |  |  | Result id of the scalar result used for fringes (filled contours)
contour_lines_result_id | Int |  |  | Result id of the scalar result used for contour lines
vector_result_ids | Array |  |  | Array of result id(s) of the vector results to use
displacement_result_id | Int |  |  | Result id of the displacements result to use
transformation_result | Bool |  |  | If true, transformation result should be used
visibility_result | Bool |  |  | If true, the visibility result should be used
per_part_fringes_result_ids | Array |  |  | Array with strings describing the part fringes result id map: 'RES_ID,FEM_MODEL_ID,PART_ID'

## Class type='set_selection'

Specify which sets are visible. Only one set group is supported in one property set.

Property name | Type | Default Value | Legal Values | Description
visible_set_ids | Array |  |  | Array of the visible set ids
show_complement | Bool |  |  | If true, show complement of visible sets

## Class type='state_selection'

Use this group to specify the animation setup of the file. For state/transient animations, specify an array of state ids. The order of the array will define the animation frames. For mode shape animation, specify the number of frames with the num_mode_shape_frames property.

Property name | Type | Default Value | Legal Values | Description
state_ids | Array |  |  | Array of ids of the states to use for an animation.
num_mode_shape_frames | Int | 0 |  | Number of mode shape animation frames. Requires displacements and a single state id specified.
mode_shape_animation_type | String |  | quarter, half, full | Mode shape animation type
mode_shape_interpolation_type | String |  | linear, sine | Mode shape interpolation type
mode_shape_interpolate_scalars | Bool |  |  | Mode shape. Interpolate scalars.

## Class type='color_mapper_filled_contours_uniform'

This group defines a color mapper with filled contours with uniform (equal sized) levels. You specify which result the mapper should be used on with the context_result_id property. Number of levels is specified with the num_colors property, and the levels are evenly distributed between the range_min and range_max values. You can also use the color_scheme property to specify one of the built-in color mappings.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of scalar result that the mapper is valid for
range_min | Double |  |  | Minimal value of the range
range_max | Double |  |  | Maximum value of the range
color_scheme | String | normal | normal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3 | Built-in color mappings
num_colors | Int | 10 |  | Number of discrete colors
logarithmic_scale | Bool | false |  | If true, a logarithmic scale is used
level_colors | Array |  |  | Array of colors for each of the 'num_colors' levels
above_range_color | Color3f |  |  | Color to use for values that are above the given range
below_range_color | Color3f |  |  | Color to use for values that are below the given range
undefined_color | Color3f |  |  | Color to use for values that are undefined
undefined_opacity | Float | 1.0 |  | Opacity of the part of the surface that is mapped with an undefined value. 1.0 = totally opaque, 0.0 = totally transparent.

## Class type='color_mapper_filled_contours'

This group defines a color mapper with filled contours but with custom level spacing (e.g. non-uniform). You specify which result the mapper should be used on with the context_result_id property. The levels are configured with the level_values array specifying the minimum, maximum and level transition values and the level_colors specifying the color of each level. You can also use the color_scheme property to specify one of the built-in color mappings.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of scalar result that the mapper is valid for.
color_scheme | String | normal | normal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3 | Built-in color mappings
logarithmic_scale | Bool | false |  | If true, a logarithmic scale is used
level_values | Array |  |  | Values for each tick mark on the color legend. First value is minimum range, last value is maximum range. The legend will have level_values.size - 1 levels.
level_colors | Array |  |  | Array with the color for each level. Size of array is level_values.size - 1.
above_range_color | Color3f |  |  | Color to use for values that are above the given range
below_range_color | Color3f |  |  | Color to use for values that are below the given range
undefined_color | Color3f |  |  | Color to use for values that are undefined
undefined_opacity | Float | 1.0 |  | Opacity of the part of the surface that is mapped with an undefined value. 1.0 = totally opaque, 0.0 = totally transparent.

## Class type='color_mapper_continuous'

This group defines a color mapper with continuous color scheme (gradient). You specify which result the mapper should be used on with the context_result_id property. The mapper is set up with a range_min, range_max range. The gradient could be described either by a specified color mapper or with a custom gradient specified with the colors_at_values property.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of scalar result that the mapper is valid for
range_min | Double |  |  | Minimal value of the range
range_max | Double |  |  | Maximum value of the range
color_scheme | String | normal | normal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3 | Built-in color mappings
logarithmic_scale | Bool | false |  | If true, a logarithmic scale is used
colors_at_values | Array |  |  | Pairs of <value,color> to configure a custom color scheme
above_range_color | Color3f |  |  | Color to use for values that are above the given range
below_range_color | Color3f |  |  | Color to use for values that are below the given range
undefined_color | Color3f |  |  | Color to use for values that are undefined
undefined_opacity | Float | 1.0 |  | Opacity of the part of the surface that is mapped with an undefined value. 1.0 = totally opaque, 0.0 = totally transparent.

## Class type='overlay_color_legend'

Specification of the appearance of a color legend. The groups applies to color legend for the result specified in the context_result_id property.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of scalar result that the mapper is valid for
text_color | Color3f |  |  | Color of the legend text
line_color | Color3f |  |  | Color of the legend lines (including tick marks)
visibility_mode | String | auto | auto, always, never | Visibility mode for the color legend
visible | Bool |  |  | If true, legend is visible. Same as visibility_mode = (auto/never)
marker_position | Array |  | above, below | Array with color marker positions
marker_colors | Array |  |  | Array with color marker colors
marker_descriptions | Array |  |  | Array with color marker descriptions
custom_legend_title | String |  |  | If specified, this will be used as the title for the legend
numeric_format | String |  | g, G, e, E, f, F | Numeric format to use when showing the legend tick values
numeric_precision | Int |  |  | Numeric precision to use when showing the legend tick values. 'f'/'e': The number of digits after the decimal point to show. 'g': The maximum number of significant digits to show.
user_scaling_first_degree | Double |  |  | User scaling of tick mark values. First degree term. Value will be constant + legendValue*first_degree_term.
user_scaling_constant | Double |  |  | User scaling of tick mark values. Constant term. Value will be constant + legendValue*first_degree_term.
force_uniform_level_spacing | Bool | true |  | If true, the spacing between all tick marks will be uniform (same spacing). If false, the tick marks will follow the range/size of the level/custom values.
above_below_range_marker_mode | String | auto | auto, always, never | Visibility mode for the above/below range color markers
marker_box_height | Float |  |  | Height of a legend color marker box
marker_vertical_margin | Float |  |  | Vertical margin between color marker boxes
force_tickmarks_over_legend | Bool |  |  | If true, tick mark lines will be drawn on top of the legend bar for continuous legends
tickmarks_position | String | follow_layout | follow_layout, left, right, top, bottom | The tick marks position on the color legend
direction | String | horizontal | horizontal, vertical | The direction of the legend
tickmarks_skip_overlapping | Bool |  |  | If true, overlapping tick mark labels are skipped
tickmarks_minimum_distance | Uint |  |  | The minimum distance between tick mark labels
line_width | Uint |  |  | Legend line width
bar_width | Uint |  |  | Legend bar width

## Class type='scalar_settings'

Settings for the scalar result with the result id specified in the context_result_id property.??This group is used to apply scalar filtering and control if the scalar should be node averaged or not.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of scalar result that the mapper is valid for
filter_min | Double |  |  | Scalar filtering minimum visible value
filter_max | Double |  |  | Scalar filtering maximum visible value
node_average | Bool | false |  | If true, node averaged results should be shown
auto_range_mode | String |  | off, all_items, visible_items | Determines if and how the scalar range is automatically computed
num_contour_levels | Uint |  |  | Number of contour levels
contour_lines_width | Uint | 1 |  | Contour lines line width
contour_lines_mode | String |  | single, color_by_scalar | Contour lines color mode
contour_lines_single_color | Color3f |  |  | Contour lines single color

## Class type='vector_settings'

Settings for the vector result with the result id specified in the context_result_id property.

Property name | Type | Default Value | Legal Values | Description
context_result_id | Int |  |  | Context: Result id of vector result that these settings apply to
scale_mode | String |  | absolute, relative | Scale mode for vector scaling
scale_factor | Double |  |  | Scale factor
color_mode | String |  | single, color_by_fringes | Coloring mode for vectors
single_color | Color3f |  |  | Color to use when color mode is set to single
clamp_min_length | Double |  |  | Minimum length of the (non-zero) vectors. All vectors shorter than this value will be set to the given length.
clamp_max_length | Double |  |  | Maximum length of the vectors. All vectors longer than this value will be set to the given length.
filter_min_length | Double |  |  | Required minimum length of the vector in order to be drawn
filter_max_length | Double |  |  | Required maximum length of the vector in order to be drawn
arrow_shaft_relative_radius | Double |  |  | Radius of the vector arrow shaft as a fraction of the vector length. Default 0.025.
arrow_head_relative_radius | Double |  |  | Radius of the vector arrow head relative to the vector length. Default 0.085.
arrow_head_relative_length | Double |  |  | Length of the vector arrow head relative to the vector length. Default 0.25.
local_coordinates | Bool | true |  | If true, the vectors are defined in local coordinates and will be transformed with the part. If false, they are in world coordinates
show_on_referenced_nodes_only | Bool | true |  | If true, the vectors are only shown on the nodes referenced by the display model. If false, all vectors are shown including interior ones
simple_vector_line_width | Int |  |  | The line width used to draw the simple vectors. Default 1.
draw_mode | String |  | normal, simple | Draw using normal or simple-unlit geometry.
draw_skipby | Uint |  |  | Number of arrows to skip between each arrow that is drawn
draw_max_count | Uint |  |  | Maximum number of vector arrows do draw
vector_type | String |  | arrow, symmetric_arrow, reverse_symmetric_arrow | Visualization type of the vector result

## Class type='part_settings'

Visual settings for the part identified by the context_geometry_index and context_part_id properties.

Property name | Type | Default Value | Legal Values | Description
context_geometry_index | Uint |  |  | Context: Part geometry Index
context_part_id | Int |  |  | Context: Part Id
visible | Bool | true |  | If true, part is visible
draw_style | String | surface | surface, surface_mesh, surface_outline_mesh, line, point, outline, hidden_line_removed, none | Draw style for the part
color | Color3f |  |  | Part color
opacity | Float | 1.0 |  | Opacity of the part. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensity | Float | 0.5 |  | Specular intensity of the part.
lighting | Bool | true |  | Lighting of the part. If false the part will be have a uniform color independent of the angle of the surface in relation to the viewing angle.
smooth_shading | Bool | false |  | Smooth shading
line_width | Uint | 1 |  | Line width
point_size | Uint | 1 |  | Point size
fringes_visible | Bool | true |  | If true, the current fringes (specified in the result_selection block) will be shown on this part
contour_lines_visible | Bool | true |  | Show contour lines
vectors_visible | Bool | true |  | If true, the current vector results (specified in the result_selection block) will be shown on this part
displacement_visible | Bool | false |  | If true, the current displacement result (specified in the result_selection block) will be used on this part
eye_lift_factor | Float | 0.0f |  | Eye lift factor. Will move the part slightly towards (if positive) or away (if negative) from the eye/camera.
texture_image_name | String |  |  | Name of the texture to use. The file name in the VTFx file must be 'PartTexture_.{raw|jpg}'
texture_environment_mapping | Bool | false |  | If true, environment texture mapping is used
texture_repeat_factor | Float | 4.0 |  | Number of times the texture should be repeated on the face of the object
texture_auto_image_scale | Bool | true |  | If true, the image is scaled so the whole image is shown on the part. If false, the image aspect is used (which might introduce cropping)
texture_modulate | Bool | false |  | If true, the resulting color of each fragment is the multiplication of the texture texel and the part color. If false, the part color is ignored.
texture_filter_nearest | Bool | false |  | If true, a nearest filter is used for the texture sampler. This gives a texture where you can see sharp edges around the pixels. No resampling of the texture.
element_set_filtering_enabled | Bool | true |  | If true, the part is included in element sets setup

## Class type='cutting_plane'

This group defines a cutting plane. You have to specify the point and normal properties. The map_scalar_result_id and map_vector_result_id properties specifies which results to show on the cutting plane. The property set can have many cutting plane groups.

Property name | Type | Default Value | Legal Values | Description
visible | Bool |  |  | If true, the cutting plane and its features (vectors, grid, etc) are visible
point | Vec3d |  |  | Point in plane
normal | Vec3d |  |  | Normal of plane
map_scalar_result_id | Int |  |  | Result id of scalar result to map onto the cutting plane
map_vector_result_id | Int |  |  | Result id of vector result to map onto the cutting plane
vector_grid_spacing_mode | String |  | absolute, relative | Spacing mode for grid when showing vectors on the cutting plane
vector_grid_spacing | Double |  |  | Grid spacing when showing vectors on the cutting plane
surface_visible | Bool | true |  | If false, the surface of the cutting plane will be hidden (only vectors visible)
surface_color | Color3f |  |  | Color of the cutting plane if no scalar is shown
clip_model | Bool | false |  | If true, the model geometry will be clipped by the cutting plane
compute_from_visible_parts | Bool | false |  | If true, the cutting plane will only be computed from the visible parts
draw_style | String |  | surface, surface_mesh, surface_outline_mesh, line, outline | Draw style of the cutting plane
opacity | Float | 1.0 |  | Opacity of the cutting plane. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensity | Float | 0.5 |  | Specular intensity of the cutting plane.
use_source_part_color | Bool | false |  | If true, color the cutting plane with the color of the source part.
grid_lines_visible | Bool | false |  | If true, the regular grid specified for the vectors are drawn as mesh lines
project_vectors_on_plane | Bool | false |  | If true, vectors will be projected onto the cutting plane
crinkle_cut_surface | Bool | false |  | If true, a crinkle cut surface will be shown instead of the flat surface
id | Int |  |  | Id of the cutting plane
description | String |  |  | Description of the cutting plane
show_vectors | Bool | false |  | If true, the regular grid specified for the vectors are drawn as mesh lines
show_grid_vectors | Bool | true |  | If true, the regular grid specified for the vectors are drawn as mesh lines

## Class type='isosurface'

This group defines an isosurface. You have to specify the iso_scalar_result_id and the iso_value properties. The map_scalar_result_id and map_vector_result_id properties specifies which results to show on the isosurface. The property set can have many isosurface groups.

Property name | Type | Default Value | Legal Values | Description
visible | Bool |  |  | If true, the isosurface and its features (vectors) are visible
iso_value | Double |  |  | Scalar value to find isosurface for
iso_scalar_result_id | Int |  |  | Scalar result id to use when generating the isosurface
map_scalar_result_id | Int |  |  | Result id of scalar result to map onto the isosurface
map_vector_result_id | Int |  |  | Result id of vector result to map onto the isosurface
surface_visible | Bool | true |  | If false, the surface of the isosurface will be hidden (only vectors visible)
surface_color | Color3f |  |  | Color of the isosurface if no scalar is shown
compute_from_visible_parts | Bool | false |  | If true, the isosurface will only computed from the visible parts
id | Int |  |  | Id of the isosurface
description | String |  |  | Description of the isosurface
draw_style | String |  | surface, surface_mesh, surface_outline_mesh, line, outline | Draw style of the isosurface
opacity | Float | 1.0 |  | Opacity of the isosurface. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensity | Float | 0.5 |  | Specular intensity of the isosurface.

## Class type='isovolume'

This group defines an isovolume. You have to specify the iso_scalar_result_id, min_iso_value and the max_iso_value properties. The map_scalar_result_id and map_vector_result_id properties specifies which results to show on the isovolume. The property set can have many isovolume groups.

Property name | Type | Default Value | Legal Values | Description
visible | Bool |  |  | If true, the isovolume and its features (vectors) are visible
min_iso_value | Double |  |  | Minimum scalar value of the isovolume
max_iso_value | Double |  |  | Maximum scalar value of the isovolume
iso_scalar_result_id | Int |  |  | Scalar result id to use when generating the isovolume
map_scalar_result_id | Int |  |  | Result id of scalar result to map onto the isovolume
map_vector_result_id | Int |  |  | Result id of vector result to map onto the isovolume
volume_visible | Bool | true |  | If false, the surface of the isovolume will be hidden (only vectors visible)
volume_color | Color3f |  |  | Color of the isovolume if no scalar is shown
compute_from_visible_parts | Bool | false |  | If true, the isovolume will only computed from the visible parts
id | Int |  |  | Id of the isovolume
description | String |  |  | Description of the isovolume
draw_style | String |  | surface, surface_mesh, surface_outline_mesh, line, outline | Draw style of the isovolume
opacity | Float | 1.0 |  | Opacity of the isovolume. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensity | Float | 0.5 |  | Specular intensity of the isovolume.
texture_image_name | String |  |  | Name of the texture to use. The file name in the VTFx file must be 'IsoVolTexture_.{raw|jpg}'.
texture_environment_mapping | Bool | false |  | If true, environment texture mapping is used

## Class type='particle_trace_group'

This group defines a group of particle traces sharing the same settings. You have to specify at least one seed_points and the vector field to compute from in the vector_result_id property.
The property set can have many particle trace groups.

Property name | Type | Default Value | Legal Values | Description
visible | Bool |  |  | If true, the traces in the group are visible
vector_result_id | Int |  |  | Result id of vector result to compute the particle trace on
map_scalar_result_id | Int |  |  | Result id of scalar result to map onto the trace
seed_points | Array |  |  | Array of seed points defining the traces
visualization_style | String |  | cylinders, spheres, ribbons, comets, lines | Visualization style of the traces
single_color | Color3f |  |  | Color of the particle traces if no scalar is shown
radius_scale_mode | String |  | absolute, relative | Scale mode for the radius of the trace
radius_scale_factor | Double |  |  | Scale factor for the radius of the trace
point_sampling_num_pulses | Double |  |  | Number of spheres or comets to draw
cometh_length | Double |  |  | Length of the comet
ribbon_relative_width | Double |  |  | Width of the ribbon relative to the current scaling
ribbon_relative_thickness | Double |  |  | Thickness of the ribbon relative to the current scaling
arrow_length | Double |  |  | Length of the arrow
id | Int |  |  | Id of the particle trace group
show_fringes | Bool |  |  | If true, fringes result are shown on the trace(s)
description | String |  |  | Description of the particle trace group
trace_forward | Bool | true |  | Trace forward from the trace point
trace_backward | Bool | true |  | Trace backward from the trace point
ignore_clipping | Bool | false |  | If true, traces in the group will ignore clipping

## Class type='mirror_settings'

This groups specifies the mirror settings to use. Only one mirror group is supported.

Property name | Type | Default Value | Legal Values | Description
num_mirror_passes | Int |  |  | Number of rotational mirror passes
plane_first_a | Double |  |  | First mirror plane. A in plane equation.
plane_first_b | Double |  |  | First mirror plane. B in plane equation.
plane_first_c | Double |  |  | First mirror plane. C in plane equation.
plane_first_d | Double |  |  | First mirror plane. D in plane equation.
plane_second_a | Double |  |  | Second mirror plane. A in plane equation.
plane_second_b | Double |  |  | Second mirror plane. B in plane equation.
plane_second_c | Double |  |  | Second mirror plane. C in plane equation.
plane_second_d | Double |  |  | Second mirror plane. D in plane equation.
plane_master_a | Double |  |  | Master mirror plane. A in plane equation.
plane_master_b | Double |  |  | Master mirror plane. B in plane equation.
plane_master_c | Double |  |  | Master mirror plane. C in plane equation.
plane_master_d | Double |  |  | Master mirror plane. D in plane equation.
reflective | Bool |  |  | Reflective mirroring flag.

## Class type='viewer'

This group contains default settings for the viewer loading the VTFx file.

Property name | Type | Default Value | Legal Values | Description
animation_fps | Double |  |  | Default animation speed in frames per second
animation_first_frame_delay | Int |  |  | First frame delay in milliseconds
animation_last_frame_delay | Int |  |  | Last frame delay in milliseconds
num_particle_trace_steps | Int |  |  | Number of steps for particle trace animation
start_animation | Bool |  |  | Flag that controls if animations should be started when file is opened
halo_color | Color3f |  |  | Color of halos in the view, e.g. to highlight parts
cutting_plane_anim_num_frames | Int |  |  | Number of frames in cutting plane animation
cutting_plane_index_to_animate | Int |  |  | Index of cutting plane to animate
cutting_plane_anim_per_frame_distance | Double |  |  | Cutting plane distance between frames
view_title | String |  |  | Custom description for view

## Class type='overlay_plot'

Specification of an overlay plot (2D plot shown somwhere fixed in the 3D view). A property set can have many such groups.

Property name | Type | Default Value | Legal Values | Description
context_overlay_plot_id | Int |  |  | Overlay plot id
plot_title | String |  |  | Title of the plot to display
width | Uint |  |  | Width of plot
height | Uint |  |  | Height of plot
draw_background | Bool |  |  | Draw background
background_color | Color3f |  |  | Background color
background_opacity | Float |  |  | Background opacity
draw_border | Bool |  |  | Draw border
border_color | Color3f |  |  | Border color
border_width | Float |  |  | Border width
x_axis_title | String |  |  | X axis title
y_axis_title | String |  |  | Y axis title
x_axis_range_min | Double |  |  | X axis minimum range
x_axis_range_max | Double |  |  | X axis maximum range
y_axis_range_min | Double |  |  | Y axis minimum range
y_axis_range_max | Double |  |  | Y axis maximum range
draw_legend | Bool |  |  | Draw curve legend
text_color | Color3f |  |  | Text color
axis_color | Color3f |  |  | Axis color
draw_grid_lines | Bool |  |  | Draw grid lines
axis_grid_lines_color | Color3f |  |  | Axis grid lines color
draw_marker_line | Bool |  |  | Draw marker line
marker_line_value | Double |  |  | Marker line value
marker_line_color | Color3f |  |  | Marker line color
logarithmic_scale_x | Bool |  |  | Use logarithmic scaling (X axis)
logarithmic_scale_y | Bool |  |  | Use logarithmic scaling (Y axis)

## Class type='overlay_plot_curve'

Specification of an overlay plot curve (2D plot shown somwhere fixed in the 3D view). A property set can have many such groups.

Property name | Type | Default Value | Legal Values | Description
context_overlay_plot_id | Int |  |  | Overlay plot id
plot_title | String |  |  | Title of the plot to display
color | Color3f |  |  | Curve color
plot_data_index | Uint |  |  | Plot data index
plot_data_variable_index_x | Uint |  |  | Plot data variable X index
plot_data_variable_index_y | Uint |  |  | Plot data variable Y index

File updated: 2022-9-13 14:34:49
Copyright © 2022 Ceetron AS

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Desktop or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...