VTFx Properties

Ceetron VTFx File Format - Properties Documentation

Ceetron 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 Ceetron 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 nameTypeDefault ValueLegal ValuesDescription
single_background_colorColor3fSingle (uniform) background color
top_background_colorColor3fTop color of a graded background
bottom_background_colorColor3fBottom 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 nameTypeDefault ValueLegal ValuesDescription
image_nameStringName of the image to display
image_scale_widthDouble1.0Scale factor (x direction) for the image
image_scale_heightDouble1.0Scale factor (y direction) for the image
layout_cornerStringtop_left, bottom_left, top_right, bottom_rightCorner to position the layout item in
layout_directionStringhorizontal, verticalDirection from the given corner to layout the item
blending_modeStringno_blending, global_alpha, texture_alphaImage blending mode (transparency)
global_alphaFloatGlobal 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 nameTypeDefault ValueLegal ValuesDescription
eyeVec3dEye point
vrpVec3dView reference point
vupVec3dUp vector
projection_typeStringperspectiveperspective, orthoProjection type
field_of_view_y_degreesDoubleTotal field of view in Y direction in degrees. Only applicable for perspective projections.
ortho_heightDoubleSize 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 nameTypeDefault ValueLegal ValuesDescription
pointVec3dPoint in plane
normalVec3dPlane 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 nameTypeDefault ValueLegal ValuesDescription
fringes_result_idIntResult id of the scalar result used for fringes (filled contours)
contour_lines_result_idIntResult id of the scalar result used for contour lines
vector_result_idsArrayArray of result id(s) of the vector results to use
displacement_result_idIntResult id of the displacements result to use
transformation_resultBoolIf true, transformation result should be used
visibility_resultBoolIf true, the visibility result should be used
per_part_fringes_result_idsArrayArray 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 nameTypeDefault ValueLegal ValuesDescription
visible_set_idsArrayArray of the visible set ids
show_complementBoolIf 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 nameTypeDefault ValueLegal ValuesDescription
state_idsArrayArray of ids of the states to use for an animation.
num_mode_shape_framesInt0Number of mode shape animation frames. Requires displacements and a single state id specified.
mode_shape_animation_typeStringquarter, half, fullMode shape animation type
mode_shape_interpolation_typeStringlinear, sineMode shape interpolation type
mode_shape_interpolate_scalarsBoolMode 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 nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of scalar result that the mapper is valid for
range_minDoubleMinimal value of the range
range_maxDoubleMaximum value of the range
color_schemeStringnormalnormal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3Built-in color mappings
num_colorsInt10Number of discrete colors
logarithmic_scaleBoolfalseIf true, a logarithmic scale is used
level_colorsArrayArray of colors for each of the 'num_colors' levels
above_range_colorColor3fColor to use for values that are above the given range
below_range_colorColor3fColor to use for values that are below the given range
undefined_colorColor3fColor to use for values that are undefined
undefined_opacityFloat1.0Opacity 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 nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of scalar result that the mapper is valid for.
color_schemeStringnormalnormal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3Built-in color mappings
logarithmic_scaleBoolfalseIf true, a logarithmic scale is used
level_valuesArrayValues 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_colorsArrayArray with the color for each level. Size of array is level_values.size - 1.
above_range_colorColor3fColor to use for values that are above the given range
below_range_colorColor3fColor to use for values that are below the given range
undefined_colorColor3fColor to use for values that are undefined
undefined_opacityFloat1.0Opacity 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 nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of scalar result that the mapper is valid for
range_minDoubleMinimal value of the range
range_maxDoubleMaximum value of the range
color_schemeStringnormalnormal, normal_inverted, black_to_white, white_to_black, green_to_brown, white_to_brown, metal_casting, thermal_1, thermal_2, thermal_3Built-in color mappings
logarithmic_scaleBoolfalseIf true, a logarithmic scale is used
colors_at_valuesArrayPairs of <value,color> to configure a custom color scheme
above_range_colorColor3fColor to use for values that are above the given range
below_range_colorColor3fColor to use for values that are below the given range
undefined_colorColor3fColor to use for values that are undefined
undefined_opacityFloat1.0Opacity 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 nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of scalar result that the mapper is valid for
text_colorColor3fColor of the legend text
line_colorColor3fColor of the legend lines (including tick marks)
visibility_modeStringautoauto, always, neverVisibility mode for the color legend
visibleBoolIf true, legend is visible. Same as visibility_mode = (auto/never)
marker_positionArrayabove, belowArray with color marker positions
marker_colorsArrayArray with color marker colors
marker_descriptionsArrayArray with color marker descriptions
custom_legend_titleStringIf specified, this will be used as the title for the legend
numeric_formatStringg, G, e, E, f, FNumeric format to use when showing the legend tick values
numeric_precisionIntNumeric precision to use when showing the legend tick values. 'f'/'e': The number of digits after the decimal point to show. 'g': The the maximum number of significant digits to show.
user_scaling_first_degreeDoubleUser scaling of tick mark values. First degree term. Value will be constant + legendValue*first_degree_term.
user_scaling_constantDoubleUser scaling of tick mark values. Constant term. Value will be constant + legendValue*first_degree_term.
force_uniform_level_spacingBooltrueIf 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_modeStringautoauto, always, neverVisibility mode for the above/below range color markers
marker_box_heightFloatHeight of a legend color marker box
marker_vertical_marginFloatVertical margin between color marker boxes
force_tickmarks_over_legendBoolIf true, tick mark lines will be drawn on top of the legend bar for continuous legends
tickmarks_positionStringfollow_layoutfollow_layout, left, right, top, bottomThe tick marks position on the color legend
directionStringhorizontalhorizontal, verticalThe direction of the legend
tickmarks_skip_overlappingBoolIf true, overlapping tick mark labels are skipped
tickmarks_minimum_distanceUintThe minimum distance between tick mark labels
line_widthUintLegend line width
bar_widthUintLegend 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 nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of scalar result that the mapper is valid for
filter_minDoubleScalar filtering minimum visible value
filter_maxDoubleScalar filtering maximum visible value
node_averageBoolfalseIf true, node averaged results should be shown
auto_range_modeStringoff, all_items, visible_itemsDetermines if and how the scalar range is automatically computed
num_contour_levelsUintNumber of contour levels
contour_lines_widthUint1Contour lines line width
contour_lines_modeStringsingle, color_by_scalarContour lines color mode
contour_lines_single_colorColor3fContour lines single color

Class type='vector_settings'

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

Property nameTypeDefault ValueLegal ValuesDescription
context_result_idIntContext: Result id of vector result that these settings apply to
scale_modeStringabsolute, relativeScale mode for vector scaling
scale_factorDoubleScale factor
color_modeStringsingle, color_by_fringesColoring mode for vectors
single_colorColor3fColor to use when color mode is set to single
clamp_min_lengthDoubleMinimum length of the (non-zero) vectors. All vectors shorter than this value will be set to the given length.
clamp_max_lengthDoubleMaximum length of the vectors. All vectors longer than this value will be set to the given length.
filter_min_lengthDoubleRequired minimum length of the vector in order to be drawn
filter_max_lengthDoubleRequired maximum length of the vector in order to be drawn
arrow_shaft_relative_radiusDoubleRadius of the vector arrow shaft as a fraction of the vector length. Default 0.025.
arrow_head_relative_radiusDoubleRadius of the vector arrow head relative to the vector length. Default 0.085.
arrow_head_relative_lengthDoubleLength of the vector arrow head relative to the vector length. Default 0.25.
local_coordinatesBooltrueIf 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_onlyBooltrueIf 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_widthIntThe line width used to draw the simple vectors. Default 1.
draw_modeStringnormal, simpleDraw using normal or simple-unlit geometry.
draw_skipbyUintNumber of arrows to skip between each arrow that is drawn
draw_max_countUintMaximum number of vector arrows do draw
vector_typeStringarrow, symmetric_arrow, reverse_symmetric_arrowVisualization 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 nameTypeDefault ValueLegal ValuesDescription
context_geometry_indexUintContext: Part geometry Index
context_part_idIntContext: Part Id
visibleBooltrueIf true, part is visible
draw_styleStringsurfacesurface, surface_mesh, surface_outline_mesh, line, point, outline, hidden_line_removed, noneDraw style for the part
colorColor3fPart color
opacityFloat1.0Opacity of the part. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensityFloat0.5Specular intensity of the part.
lightingBooltrueLighting 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_shadingBoolfalseSmooth shading
line_widthUint1Line width
point_sizeUint1Point size
fringes_visibleBooltrueIf true, the current fringes (specified in the result_selection block) will be shown on this part
contour_lines_visibleBooltrueShow contour lines
vectors_visibleBooltrueIf true, the current vector results (specified in the result_selection block) will be shown on this part
displacement_visibleBoolfalseIf true, the current displacement result (specified in the result_selection block) will be used on this part
eye_lift_factorFloat0.0fEye lift factor. Will move the part slightly towards (if positive) or away (if negative) from the eye/camera.
texture_image_nameStringName of the texture to use. The file name in the VTFx file must be 'PartTexture_.{raw|jpg}'
texture_environment_mappingBoolfalseIf true, environment texture mapping is used
texture_repeat_factorFloat4.0Number of times the texture should be repeated on the face of the object
texture_auto_image_scaleBooltrueIf 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_modulateBoolfalseIf 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_nearestBoolfalseIf 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_enabledBooltrueIf 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 nameTypeDefault ValueLegal ValuesDescription
visibleBoolIf true, the cutting plane and its features (vectors, grid, etc) are visible
pointVec3dPoint in plane
normalVec3dNormal of plane
map_scalar_result_idIntResult id of scalar result to map onto the cutting plane
map_vector_result_idIntResult id of vector result to map onto the cutting plane
vector_grid_spacing_modeStringabsolute, relativeSpacing mode for grid when showing vectors on the cutting plane
vector_grid_spacingDoubleGrid spacing when showing vectors on the cutting plane
surface_visibleBooltrueIf false, the surface of the cutting plane will be hidden (only vectors visible)
surface_colorColor3fColor of the cutting plane if no scalar is shown
clip_modelBoolfalseIf true, the model geometry will be clipped by the cutting plane
compute_from_visible_partsBoolfalseIf true, the cutting plane will only be computed from the visible parts
draw_styleStringsurface, surface_mesh, surface_outline_mesh, line, outlineDraw style of the cutting plane
opacityFloat1.0Opacity of the cutting plane. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensityFloat0.5Specular intensity of the cutting plane.
use_source_part_colorBoolfalseIf true, color the cutting plane with the color of the source part.
grid_lines_visibleBoolfalseIf true, the regular grid specified for the vectors are drawn as mesh lines
project_vectors_on_planeBoolfalseIf true, vectors will be projected onto the cutting plane
crinkle_cut_surfaceBoolfalseIf true, a crinkle cut surface will be shown instead of the flat surface
idIntId of the cutting plane
descriptionStringDescription of the cutting plane
show_vectorsBoolfalseIf true, the regular grid specified for the vectors are drawn as mesh lines
show_grid_vectorsBooltrueIf 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 nameTypeDefault ValueLegal ValuesDescription
visibleBoolIf true, the isosurface and its features (vectors) are visible
iso_valueDoubleScalar value to find isosurface for
iso_scalar_result_idIntScalar result id to use when generating the isosurface
map_scalar_result_idIntResult id of scalar result to map onto the isosurface
map_vector_result_idIntResult id of vector result to map onto the isosurface
surface_visibleBooltrueIf false, the surface of the isosurface will be hidden (only vectors visible)
surface_colorColor3fColor of the isosurface if no scalar is shown
compute_from_visible_partsBoolfalseIf true, the isosurface will only computed from the visible parts
idIntId of the isosurface
descriptionStringDescription of the isosurface
draw_styleStringsurface, surface_mesh, surface_outline_mesh, line, outlineDraw style of the isosurface
opacityFloat1.0Opacity of the isosurface. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensityFloat0.5Specular 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 nameTypeDefault ValueLegal ValuesDescription
visibleBoolIf true, the isovolume and its features (vectors) are visible
min_iso_valueDoubleMinimum scalar value of the isovolume
max_iso_valueDoubleMaximum scalar value of the isovolume
iso_scalar_result_idIntScalar result id to use when generating the isovolume
map_scalar_result_idIntResult id of scalar result to map onto the isovolume
map_vector_result_idIntResult id of vector result to map onto the isovolume
volume_visibleBooltrueIf false, the surface of the isovolume will be hidden (only vectors visible)
volume_colorColor3fColor of the isovolume if no scalar is shown
compute_from_visible_partsBoolfalseIf true, the isovolume will only computed from the visible parts
idIntId of the isovolume
descriptionStringDescription of the isovolume
draw_styleStringsurface, surface_mesh, surface_outline_mesh, line, outlineDraw style of the isovolume
opacityFloat1.0Opacity of the isovolume. 1.0 = totally opaque, 0.0 = totally transparent.
specular_intensityFloat0.5Specular intensity of the isovolume.
texture_image_nameStringName of the texture to use. The file name in the VTFx file must be 'IsoVolTexture_.{raw|jpg}'.
texture_environment_mappingBoolfalseIf 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 nameTypeDefault ValueLegal ValuesDescription
visibleBoolIf true, the traces in the group are visible
vector_result_idIntResult id of vector result to compute the particle trace on
map_scalar_result_idIntResult id of scalar result to map onto the trace
seed_pointsArrayArray of seed points defining the traces
visualization_styleStringcylinders, spheres, ribbons, comets, linesVisualization style of the traces
single_colorColor3fColor of the particle traces if no scalar is shown
radius_scale_modeStringabsolute, relativeScale mode for the radius of the trace
radius_scale_factorDoubleScale factor for the radius of the trace
point_sampling_num_pulsesDoubleNumber of spheres or comets to draw
cometh_lengthDoubleLength of the comet
ribbon_relative_widthDoubleWidth of the ribbon relative to the current scaling
ribbon_relative_thicknessDoubleThickness of the ribbon relative to the current scaling
arrow_lengthDoubleLength of the arrow
idIntId of the particle trace group
show_fringesBoolIf true, fringes result are shown on the trace(s)
descriptionStringDescription of the particle trace group
trace_forwardBooltrueTrace forward from the trace point
trace_backwardBooltrueTrace backward from the trace point
ignore_clippingBoolfalseIf 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 nameTypeDefault ValueLegal ValuesDescription
num_mirror_passesIntNumber of rotational mirror passes
plane_first_aDoubleFirst mirror plane. A in plane equation.
plane_first_bDoubleFirst mirror plane. B in plane equation.
plane_first_cDoubleFirst mirror plane. C in plane equation.
plane_first_dDoubleFirst mirror plane. D in plane equation.
plane_second_aDoubleSecond mirror plane. A in plane equation.
plane_second_bDoubleSecond mirror plane. B in plane equation.
plane_second_cDoubleSecond mirror plane. C in plane equation.
plane_second_dDoubleSecond mirror plane. D in plane equation.
plane_master_aDoubleMaster mirror plane. A in plane equation.
plane_master_bDoubleMaster mirror plane. B in plane equation.
plane_master_cDoubleMaster mirror plane. C in plane equation.
plane_master_dDoubleMaster mirror plane. D in plane equation.
reflectiveBoolReflective mirroring flag.

Class type='viewer'

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

Property nameTypeDefault ValueLegal ValuesDescription
animation_fpsDoubleDefault animation speed in frames per second
animation_first_frame_delayIntFirst frame delay in milliseconds
animation_last_frame_delayIntLast frame delay in milliseconds
num_particle_trace_stepsIntNumber of steps for particle trace animation
start_animationBoolFlag that controls if animations should be started when file is opened
halo_colorColor3fColor of halos in the view, e.g. to highlight parts
cutting_plane_anim_num_framesIntNumber of frames in cutting plane animation
cutting_plane_index_to_animateIntIndex of cutting plane to animate
cutting_plane_anim_per_frame_distanceDoubleCutting plane distance between frames
view_titleStringCustom 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 nameTypeDefault ValueLegal ValuesDescription
context_overlay_plot_idIntOverlay plot id
plot_titleStringTitle of the plot to display
widthUintWidth of plot
heightUintHeight of plot
draw_backgroundBoolDraw background
background_colorColor3fBackground color
background_opacityFloatBackground opacity
draw_borderBoolDraw border
border_colorColor3fBorder color
border_widthFloatBorder width
x_axis_titleStringX axis title
y_axis_titleStringY axis title
x_axis_range_minDoubleX axis minimum range
x_axis_range_maxDoubleX axis maximum range
y_axis_range_minDoubleY axis minimum range
y_axis_range_maxDoubleY axis maximum range
draw_legendBoolDraw curve legend
text_colorColor3fText color
axis_colorColor3fAxis color
draw_grid_linesBoolDraw grid lines
axis_grid_lines_colorColor3fAxis grid lines color
draw_marker_lineBoolDraw marker line
marker_line_valueDoubleMarker line value
marker_line_colorColor3fMarker line color
logarithmic_scale_xBoolUse logarithmic scaling (X axis)
logarithmic_scale_yBoolUse 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 nameTypeDefault ValueLegal ValuesDescription
context_overlay_plot_idIntOverlay plot id
plot_titleStringTitle of the plot to display
colorColor3fCurve color
plot_data_indexUintPlot data index
plot_data_variable_index_xUintPlot data variable X index
plot_data_variable_index_yUintPlot data variable Y index

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