*setoption

Sets various option values.

Syntax

*setoption <option>=<value>

Type

HyperMesh Tcl Modify Command

Description

Sets various option values.

Inputs

<option>=<value>
The name of the option and the corresponding value to assign. Valid options and values are as follows:
1d_at_centroid=<value>
Controls whether the 3D representation of 1D elements is relative to the centroid or the shear center. Valid values are:
0 - The 3D representation of 1D elements is relative to the shear center.
1 - The 3D representation of 1D elements is relative to the centroid.
alt_lmb_rmb_binding=<value>
Select action for Alt key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
alt_mmb_binding=<value>
Select action for Alt key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
alt_rmb_binding=<value>
Select action for Alt key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
anti_alisasing=<value>
Sets the anti-aliasing mode:
0 - Disable anti-aliasing.
1 - Enable anti-aliasing.
auto_cleanuptol=<value>
Sets the geometry cleanup calculation mode. Valid values are:
0 - Manually set the tolerance.
1 - Auto calculate the tolerance.
auto_elementsize=<value>
Sets the element size calculation mode. Valid values are:
0 - Manually set the size.
1 - Auto calculate the size.
auto_nodetol=<value>
Sets the node tolerance calculation mode. Valid values are:
0 - Manually set the tolerance.
1 - Auto calculate the tolerance.
auto_mesh_color_mode=<value>
Sets the auto mesh color mode for mesh lines. Valid values are:
0 - Disable auto mesh line coloring and instead use the color specified by mesh_line_color.
1 - Enable auto mesh line coloring.
beam_lod_threshold=<value>
The zoom level required to make beams visible, as an integer value from 0-10 (default 6.5). 0 means mesh lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
beam_lod_threshold=<value>
0 - Off/disabled
1 - The number of elements in the frustum (default 4080).
background_colors-<item>={<r> <g> <b>}
The colors for the gradient background. The actual RGB values are not used. The closest of the standard 64 colors are selected based on the RGB values.
The item modifier is required and specifies a specific item:
1 - Background color 1
2 - Background color 2
bitmap_animation=<value>
The bitmap animation graphics mode. Valid values are:
0 - None (default)
1 - Simple
2 - Compressed
block_error_messages=<value>
Controls the display of error messages.
0 - Displays error messages
1 - Blocks error messages. Error messages can still be displayed from Tcl scripts by using hm_errormessage.
block_messages=<value>
Controls the display of info messages.
0 - Displays info messages
1 - Blocks info messages. Info messages can still be displayed from Tcl scripts by using hm_usermessage.
block_redraw=<value>
Controls the graphics redraw. When the redraw operation is blocked, HyperWorks Desktop will not redraw unless the size of its window changes or it is de-iconified or maximized. When the redraw operation is unblocked, HyperWorks Desktop returns to normal.
0 - Allows redraw
1 - Blocks redraw
buffer_command_file=<value>
Controls the command file buffering state.
0 - Disable buffering the command file
1 - Enable buffering the command file
cadupdate_parameter_immediate=<value>
0 - When changing parameters associated to external CAD files, do not update the parameters back in the CAD system automatically
0 - When changing parameters associated to external CAD files, update the parameters back in the CAD system automatically
cleanup_tolerance=<value>
The geometry cleanup tolerance used for geometry creation and editing operations.
clip_boundary_elements=<value>
The boundary element display mode for hidden line, section cut and spherical clipping.
0 - Boundary elements are not clipped and entire elements are shown
1 - Boundary elements are clipped and a smooth boundary is shown
ctrl_lmb_rmb_binding=<value>
Select action for Ctrl key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
ctrl_mmb_binding=<value>
Select action for Ctrl key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
ctrl_rmb_binding=<value>
Select action for Ctrl key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
coincident_picking=<value>
The state of coicident graphical picking.
0 - Disable coincident picking
1 - Enable coincident picking
command_file_state=<value>
The state of writing to the command file.
0 - Disable writing to the command file
1 - Enable writing to the command file
contact_surface_peak_factor=<value>
The factor for scaling the contact surface graphical height.
contact_surface_percent=<value>
The percent of the element size to use for scaling the contact surface graphical length and width.
contour_type=<value>
The result color mode.
0 - Blended contour
1 - Discrete contour
delete_discrete_topology_mode=<value>
Select a remeshing method for revising modified discrete topology.
Valid values are "Keep mesh", Remesh and "Advanced remesh".
delete_elements_mode=<value>
The remesh setting for topology revision.
0 - Keep mesh
1 - Delete mesh
2 - Remesh
3 - Advanced remesh
4 - 2D + 3D (tetra) remesh
detailed_elements=<value>
The 3D visualization mode for 1D/2D elements.
0 - Traditional 1D/2D element display.
1 - Detailed 1D/2D element display. 1D elements are viewed as 3D representations with proper cross-section, orientation and offset. 2D elements are views as 3D representations with proper thickness and offset.
2 - Combined traditional and detailed 1D/2D element display.
detailed_elements_beamvis=<value>
The 3D visualization mode for 1D elements.
0 - Traditional 1D element display
1 - Detailed 1D element display. 1D elements are viewed as 3D representations with proper cross-section, orientation and offset.
2 - Combined traditional and detailed 1D element display
detailed_elements_shellvis=<value>
The 3D visualization mode for 2D elements.
0 - Traditional 2D element display.
1 - Detailed 2D element display. 2D elements are views as 3D representations with proper thickness and offset.
2 - Combined traditional and detailed 2D element display.
display_color-<item>=<value>
The color for various objects. Valid values are 1-64. A value of 0 indicates to set the color of that object to the background color value.
The item modifier is required and specifies a specific item:
  • 1 - Free edges
  • 2 - Shared edges
  • 3 - Suppressed edges
  • 4 - Non-manifold edges
  • 5 - Global coordinate axis labels
  • 6 - Fin faces on solids
  • 7 - Bounding faces on solids
  • 8 - Full partition faces on solids
  • 9 - 2D topology faces
  • 10 - Component edges
  • 12 - Ignored topology faces
  • 13 - Elements no props/mats
  • 14 - Ignored solid mappable
  • 15 - Not solid mappable
  • 16 - 1 directional solid mappable
  • 17 - 3 directional solid mappable
  • 18 - Global X axis
  • 19 - Global Y axis
  • 20 - Global Z axis
display_import_errors=<value>
Defines whether the import process errors/warnings are displayed in a Tcl window in HyperWorks Desktop.
0 - Import process errors/warnings will not be displayed
1 - Import process errors/warnings will be displayed.
domain_handle=<value>
The display of domain handles.
0 - Off
1 - On
duplicate_ids=<value>
Defines whether duplicate entity IDs are allowed for supported solvers.
0 - Duplicate IDs are not allowed
1 - Duplicate IDs are allowed
dynamic_center_of_rotation=<value>
Dynamic center during model rotation. values are 1 or 0.
edge_density_visible=<value>
0 - Disable the visualization of edge density values in the automesh panel
0 - Enable the visualization of edge density values in the automesh panel
edge_lod_threshold=<value>
The zoom level required to make geometry lines visible, as an integer value from 0-10. 0 means geometry lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
edge_lod_width_auto=<value>
Defines whether to enable edge LOD auto mode.
0 - Auto mode disabled
1 - Auto mode enabled
element_color_mode=<value>
The element color mode value:
1 - By component
2 - By property
3 - By material
4 - By thickness
5 - 1D/2D/3D
6 - By config
7 - By assembly
8 - By body
9 - By 2D element quality criteria
10 - By thickness difference
11 - Reserved for future use
12 - Reserved for future use
13 - By domain
14 - Reserved for future use
15 - Reserved for future use
16 - By part
17 - By topology
18 - By 3D topology
19 - By mappable
20 - By 3D element quality criteria
21 - By 2D element quality QI
22 - Reserved for future use
23 - By subsystem
element_connectivity=<value>
Select how newly created elements and any adjacent existing elements are connected.
Valid values are Previous, Break, Keep, and Redo.
element_handle=<value>
The display of element handles.
0 - Off
1 - On
element_internal_edges_mode=<value>
The element internal edges visualization mode. This only applies to the two wireframe modes supported by *setdisplayattributes/*setmarkdisplayattributes.
0 - Do not visualize internal element edges
1 - Visualize internal element edges
element_order=<value>
The order of newly created elements.
1 - First
2 - Second
element_organization=<value>
Select in which component the newly created elements are placed.
Valid values are "Current component" and "Surface component".
element_size=<value>
The default element size to use when calculating element densities in the auto-meshing module.
element_window_selection_mode=<value>
all - All nodes of an element must be inside the window to be selected
any - Any node of an element must be inside the window to be selected
centroid - The centroid of an element must be inside the window to be selected
entity_highlighting=<value>
The mode for pre-highlighting selected entities.
0 - Do not pre-highlight. This may improve script performance.
1 - Pre-highlight
equation_handle=<value>
The display of equation handles.
0 - Off
1 - On
exponential_display=<value>
The display of floating-point numbers in the menu as standard or exponential.
0 - Standard
1 - Exponential
exponential_display=<value>
The display of floating-point numbers in the menu as standard or exponential.
0 - Standard
1 - Exponential
feature_angle=<value>
The feature angle used for mesh creation and editing operations.
fe_display=<value>
0 - Turns off FE display without changing the state of components.
1 - Turns on FE display without changing the state of components.
feoutput_time_info=<value>
Generates a text file containing export time info for FE entities. The file is written to the same directory as the exported file, with the name <export_file_name>_timing.txt.
0 - Do not write file
1 - Write file
fixed_point_handle=<value>
The display of fixed point handles.
0 - Off
1 - On
force_text_black=<value>
The display of graphical text between black and white. By default, text in HyperWorks Desktop is displayed in white. However white text is not always legible, especially when users change the background color to a lighter color.
0 - White
Non-zero - Black
geom_display=<value>
0 - Turns off geometry display without changing the state of components.
1 - Turns on geometry display without changing the state of components.
geom_feature_angle=<value>
The geometry feature angle used for geometry creation and editing operations.
geom_point_size=<value>
Sets the size of the geometry points, between 1 and 10 (default 4).
geom_refine_level=<value>
The refinement level for geometry graphical faceting. Valid values are 1-5 and 11 (which indicates auto refinement). Each level increases the refinement, but also uses more memory and takes more time to compute.
geom_stitching=<value>
The automatic stitching mode when creating surfaces. This applies to all surface creation commands.
0 - Created surfaces are stitched to surfaces from the same component
1 - Created surfaces are stitched to any surfaces that are within geometry cleanup tolerance
2 - Created surfaces are stitched to surfaces attached to selected surfaces/edges
3 - Created surfaces are stitched only to selected surfaces or surfaces that have edges/vertices selected
geometry_parasolid_boolean=<value>
0 - Boolean operations will use the legacy AFC (default)
1 - Boolean operations will use Parasolid (not tested or recommended for use with panels)
graph_plot=<value>
Enable/disable drawing of plots:
0 - Do not draw plots
1 - Draw plots
graphics_file_blank_background=<value>
The graphics file image background color mode.
0 - Use the graphics window background color for the image
Non-zero - Use a blank (white) background color for the image
graphics_optimize_view_control=<value>
0 - Do not remove graphical annotations and entities when you rotate, zoom (via the mouse wheel), or pan the model.
1 - Remove graphical annotations and entities when you rotate, zoom (via the mouse wheel), or pan the model. Graphical annotations and entities are restored once you release the mouse button.
graphics_simplification_component=<value>
The graphics simplification component.
0 - Do not simplify the current component
1 - Simplify the current component
graphics_simplification_mode={<mode> <style>}
The graphics simplification mode. This produces smoother animation when rotating or panning a model by refraining from calculating and rendering some model elements until the model manipulation stops.
mode values:
  • 0 - None
  • 1 - Automatic
  • 2 - Ctrl-Shift
style values:
  • 0 - No simplification
  • 1 - Feature lines (default)
  • 2 - Bounding box
  • 3 - Node cloud
  • 4 - Element centroid
  • 5 - Simplified shading
hide_panels_automatically=<value>
0 - Do not hide panels automatically.
1 - Hide panels automatically.
highlight-<option>=<value>
Sets various highlight options. The option modifier is required and specifies a specific highlight type.
  • edge_thickness - The thickness of feature edge higlight (default 2.0).
  • face_alpha - A value between 0 and 1 (default 0.5)
  • face_color - The RGB highlight face color (default #FEB317) .
  • onoff - The transparent highlight, 0 (off, default) or 1 (on).
history_memory_limit=<value>
The amount of memory to allow for undo-redo.
hv_launch_flag=<value>
Controls the launching of HyperView after an H3D creation.
0 - Disable HyperView launch
1 - Enable HyperView launch
legend_allow_background_transparency=<value>
0 - Do not allow
1 - Allow
legend_beyond_threshold=<value>
The visualization for elements beyond the legend threshold.
0 - Off
1 - Transparent
2 - Feature lines
legend_ranged_discrete_button=<value>
Controls the legend double button.
0 - Off
1 - On
lighting_mode=<value>
The lighting mode.
0 - 1 light (legacy)
2 - 2 light
line_handle=<value>
The display of line handles.
0 - Off
1 - On
lmb_rmb_binding=<value>
Select action for left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
load_base_size=<value>
Change the base size of loads.
load_handle=<value>
The display of load handles.
0 - Off
1 - On
load_label-<config>=<value>
The display of load labels.
0 - Off
1 - On
The config modifier is required and specifies a specific load config. Currently all config values besides 3 are linked together.
  • 1 - Forces
  • 2 - Moments
  • 3 - Constraints
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_label_color=<value>
The load label color. Valid values are 1-64. A value of 0 indicates to set the color to the background color value.
load_max_size=<value>
Change the maximum size of loads.
load_min_size=<value>
Change the minimum size of loads.
load_new_scaling=<value>
Set new scaling options
Valid values are New and Legacy.
load_scale_type=<value>
Set scale type fixed or limits on load entities.
Valid values are Limits and Fixed.
load_size_magnitude-<config>=<value>
The load display percentage when load_size_type is 1.
The config modifier is required and specifies a specific load config. Currently all config values are linked together.
  • 1 - Forces
  • 2 - Moments
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_size_type-<config>=<value>
0 - Uniform display
1 - Magnitude display
The config modifier is required and specifies a specific load config. Currently all config values are linked together.
  • 1 - Forces
  • 2 - Moments
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_size_uniform-<config>=<value>
The load display size in model units when load_size_type is 0.
The config modifier is required and specifies a specific load config. Currently all config values besides 3 are linked together.
  • 1 - Forces
  • 2 - Moments
  • 3 - Constraints
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_solver_label=<value>
The label type for elements and loads.
0 - HyperWorks Desktop labels
1 - Template labels
load_visual_vector=<value>
The location of the vector in relation to the attachment location.
0 - Tip
1 - Tail
lod_threshold=<value>
The zoom level required to make element handles visible, as an integer value from 0-10. 0 means element handles are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
mesh_line_color=<value>
The mesh line color. Valid values are 1-64.
mesh_lod_threshold=<value>
The zoom level required to make element mesh lines visible, as an integer value from 0-10 (default 6.5). 0 means mesh lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
mesh_transparency=<value>
The mesh transparency as a double value from 0-10. 0 means no transparency. Smaller values indicate minimal transparency. Higher values mean more transparency.
method_xml_file=<value>
The user defined StressToolMethodDefinition.xml file path to access the user defined design methods.
mixed_property_warning=<value>
The state of the mixed direct/indirect property assignment warning dialog.
0 - Do not show the warning when mixing direct/indirect property assignments.
1 - Show the warning when mixing direct/indirect property assignments.
mmb_binding=<value>
Select action for middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
morph_color-<option>=<value>
Sets various morph color options. The option modifier is required and specifies a specific morph color object.
  • domain - The domain RGB color.
  • face - The face RGB color.
  • symmetry - The symmetry RGB color.
  • volume - The morph volume RGB color.
mouse_append_mode=<value>
Always add to the current selection in idle mode without holding Ctrl.
Valid values are 1 and 0.
mouse_mapping=<value>
Set current mouse controls.
Valid values are HyperWorks and Legacy.
mouse_over_highlighting=<value>
Highlight entities on mouse hover.
Valid values are 1 and 0.
nearby_output_entities=<types>
Sets the nearby output entity types. Valid values are components, elements, equations, loads, systems and vectors.
nearby_radius=<value>
Sets the nearby search radius/tolerance.
nearby_search_method=<value>
Sets the nearby search method. Valid values are sphere and box.
nearby_selected_operation=<value>
Sets the nearby selection operation. Valid values are 0 (show) and 1 (isolate).
nodelod=<value>
0 - Disable node level-of-detailing
1 - Enable node level-of-detailing
node_size=<value>
Sets the size of the nodes, between 1 and 10 (default 6).
node_tolerance=<value>
The global node tolerance. Must be greater than cleanup_tolerance/100.
num_history_steps=<value>
The maximum number of undo-redo steps to store in memory.
numeric_legend_force_ranged=<value>
0 - Discrete legend
1 - Ranged legend
numeric_legend_threshold=<value>
The threshold value for automatic switching from discrete to ranged.
number_remesh_layers=<value>
Number of layers for advanced remesh.
performance_normal=<value>
The light setting, based on the direction of element normals.
0 - Flat, each face has a normal
1 - Smooth, vertices have normals
perspective_fov=<value>
The perspective field of view.
perspective_view=<value>
The state of the perspective view.
0 - Off
1 - On
pick_tolerance=<value>
The picking tolerance in pixels which the cursor must be within before an entity is selected.
ply_link_color_and_orientation=<value>
Auto update of colors based on ply orientation.
Valid values are 1 and 0.
ply_thickness_factor=<value>
The ply thickness scale factor for composite layer visualization. This applies for show_composite_layers values 1 and 2.
pr_auto_preserve_connections=<value>
1 - Preserve the internal connections.
0 - Do not preserve the internal connections (default).
pr_box_approach_node_set=<value>
0 - Proximity approach will be used to find the replacement nodes to update the SETS of type NODES. (default).
1 - Bounding box approach will be used to find the replacement nodes to update the SETS of type NODES. All the nodes of an element will be used to update the SETS of type NODES or none of it.
pr_check_log=<value>
0 - Do not allow the user to provide a file path to log replacement details. (default 0)
1 - Allow the user to provide a file path to log replacement details.
pr_custom_bbox_for_equivalence=<value>
Custom tolerance for bounding box can be provided for connecting the 1D elements from incoming file to source components
0 - Use default tolerance.
1 - Use custom tolerance (default).
pr_delete_src_comp=<value>
0 - Delete existing component.
1 - Do not delete existing component. Both existing and incoming component(s) will remain in session after replacement (default).
pr_invoke_model_checker=<value>
0 - Do not invoke a Model Checker browser (default).
1 - Invokes a Model Checker browser after replacement.
This option is not available for single component replacement.
pr_keep_src_comp_cardimage=<value>
0 - Do not copy existing component card image to incoming component.
1 - Copy existing component card image to incoming component (default).
pr_keep_src_comp_id=<value>
0 - Do not assign existing component ID to incoming component.
1 - Assign existing component ID to incoming component (default).
pr_keep_src_comp_name=<value>
0 - Do not assign existing component Name to incoming component.
1 - Assign existing component Name to incoming component (default).
pr_keep_src_ent_type=<value>
0 - Do not assign existing component element type to incoming component element type (default).
1 - Assign existing component element type to incoming component element type.
pr_keep_src_include=<value>
0 - Organize incoming entities to new include.
1 - Organize incoming entities to existing component include (default).
pr_keep_src_mat=<value>
0 - Do not assign existing component material to incoming component.
1 - Assign existing component material to incoming component (default).
pr_keep_src_prop=<value>
0 - Do not assign the existing component material/property to incoming component.
1 - Assign existing the component material/property to incoming component (default).
pr_merge_nodes=<value>
0 - Do not merge the nodes present on the boundaries of incoming component (default).
1 - Merge the nodes present on the boundaries of incoming component.
pr_prefix_basename_suffix_based_name_pairing=<value>
Controls whether component pairing should be done using prefix-basename-suffix matching approach. Valid values are:
0 – Do not use prefix-basename-suffix approach to find the component pairing
1 - Use prefix-basename-suffix approach first to find the component pairing
pr_retain_plotel_elem_nodeIds_from_src_comp=<value>
The node IDs of the source component can be retained if its nodes have comments.
It is available only for OptiStruct and Nastran.
0 - Do not retain the node ids of source component. (default 0)
1 - Retain the node ids of source component.
pr_show_component_pairing=<value>
0 - Do not show component pairing (default ).
1 - Show component pairing.
quick_topo_selection=<value>
Controls holding the ALT key to enable quick advanced selection for faces and edges (elements) and by path (lines and nodes).
0 - Disable
1 - Enable
realize_loads=<value>
Realize loads to their engineering form at the time of model load.
It is available only for OptiStruct and Nastran.
0 - Unrealize (default, classical loads are created)
1 - Realize (engineering loads are created after model load)
retain_element_values=<value>
Keep/delete certain element values upon mesh edit or remesh.
0 - Delete (legacy behavior)
1 - Keep
retain_loads=<value>
Keep/delete loads when associated nodes/elements are deleted.
0 - Delete
1 - Keep
reverse_zoom_direction=<value>
Reverse scroll wheel direction.
Valid values are 1 and 0.
rmb_binding=<value>
Select action for right mouse button drag.
Valid values are Pan Rotate Zoom CircleZoom.
rotation_angle=<value>
The rotation angle used by various view commands.
rotation_center_mode=<value>
The rotation mode.
0 - Rotate about center of model
1 - Rotate about center of screen (legacy behavior)
rotation_center_off_screen=<value>
Defines if the rotation center is allowed to be off screen.
0 - The rotation center is reset to the screen center if a zoom, translation or fit operation causes it to be off the screen (legacy behavior)
1 - The rotation center is not reset to the screen center if a zoom, translation or fit operation causes it to be off the screen
scale_color=<value>
The color of the modeling window model scale. Valid values are 1-64.
scale_height=<value>
The height of the modeling window model scale. Valid values are S (for small), M (for medium) and L (for large).
scale_position=<value>
The position of the modeling window model scale. Valid values are bottomleft, bottom, bottomright, centerleft, center, centerright, topleft, top, topright.
scale_width=<value>
The width of the modeling window model scale. Valid values are S (for small), M (for medium) and L (for large).
shift_lmb_rmb_binding=<value>
Select action for Shift key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
shift_mmb_binding=<value>
Select action for Shift key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
shift_rmb_binding=<value>
Select action for Shift key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
show_composite_layers=<value>
The composite layers visualization mode.
0 - Composite layers are not visualized.
1 - Composite layers are visualized when defined.
2 - Composite layers are visualized when defined, with overlaid ply orientation vectors.
3 - Composite layers are visualized when defined, showing only edges.
show_global_axes=<value>
The global axes visualization mode.
0 - Off
1 - On
show_line_dir=<value>
Displays symbols indicating geometry lines parametric direction.
0 - Turn off display of line direction symbols
1 - Turn on display of line direction symbols
show_model_title=<value>
Show the file path of the current model in the graphics area.
Valid values are 1 and 0.
show_newly_created_entities=<value>
If new entities are created/updated in a collector that is hidden:
0 - Do not turn the collector on
1 - Turn the collector on
show_plots=<value>
Show plots when loading the model.
Valid values are 1 and 0.
show_scale=<value>
The scale visualization mode.
0 - Off
1 - On
shrink_factor=<value>
The element shrink factor, between 0 and 1.
shrink_mode=<value>
The state of the element shrink mode.
0 - Off
1 - On
snap_circle_center=<value>
0 - Off
1 - On
snap_global_xyz=<value>
0 - Off
1 - On
snap_line_end=<value>
0 - Off
1 - On
snap_line_line_intersect=<value>
0 - Off
1 - On
snap_line_middle=<value>
0 - Off
1 - On
snap_mesh_node=<value>
0 - Off
1 - On
snap_on=<value>
0 - Off
1 - On
snap_on_empty_space=<value>
0 - Off
1 - On
snap_on_tangent_extension=<value>
0 - Off
1 - On
snap_perp_from_line=<value>
0 - Off
1 - On
snap_perp_from_surf=<value>
0 - Off
1 - On
snap_perp_to_line=<value>
0 - Off
1 - On
snap_perp_to_surf=<value>
0 - Off
1 - On
snap_surf_center=<value>
0 - Off
1 - On
snap_surf_line_intersect=<value>
0 - Off
1 - On
snap_system_center=<value>
0 - Off
1 - On
snap_tangent_from_line=<value>
0 - Off
1 - On
snap_tangent_to_line=<value>
0 - Off
1 - On
solid_transparency=<value>
The solid geometry transparency value 0-10.
solid_edge_width=<value>
The solid geometry edge width 1.0-10.0. 2.5 is the legacy value.
specular_intensity=<value>
The specular intensity value.
stereo_display=<value>
The normal (2D) or stereo (3D) display mode.
0 - Normal display mode
1 - Stereo display mode
surface_edge_width=<value>
The solid geometry edge width 1.0-10.0. 1.0 is the legacy value.
surface_uv_lines=<value>
The number of uv lines to draw on surfaces for *settopologydisplaytype 3. Must be between 0 and 20.
system_size_uniform=<value>
The size in model units in which systems will be drawn.
tag_display=<value>
The graphical display mode for tag entities.
0 - Show text only at tag locations
1 - Show text and graphics at tag locations
2 - Show graphics only at tag locations
tag_text_display_mode=<value>
The text display mode for tag entities. Valid values are:
0 - Show the label of the tag
1 - Show the body of the tag
2 - Show the name (label:body) of the tag
3 - Show the description of the tag. If no tag exists, the label will be shown.
thick_1d_lines=<value>
The state of 1D element line graphical thickness.
0 - Normal display mode
1 - Thick display mode
thick_mesh_lines=<value>
The state of mesh line graphical thickness.
0 - Normal display mode
1 - Thick display mode
thickness_legend_colors={<color1> <color2> ... <colorN>}
The colors for the thickness legend. A color can be specified for each row. Valid values are 1-64.
thickness_legend_rows=<value>
The number of rows for the thickness legend.
thickness_legend_values={<value1> <value2> ... <valueN>}
The values for the thickness legend. A value can be specified for each row. Values should be specified in order.
topoedgecolor=<value>
The FE topology and geometry topology edge colors:
1 - Automatic
2 - Topology
3 - 3D topology
topofacecolor=<value>
The FE topology and geometry topology face colors:
1 - Automatic
2 - Assembly
3 - Parts
4 - Components
5 - Mixed
6 - Topology
7 - 3D Topology
8 - Mappable
9 - 2D element quality criteria
10 - Property
11 - Material
12 - Thickness
13 - Domain
14 - Configuration
15 - Dimension
16 - Body
22 - Element normal
24 - Include
The element color mode value:
  • 9 - By 2D element quality criteria
  • 10 - By thickness difference
  • 20 - By 3D element quality criteria
  • 23 - By subsystem
topofacemode=<value>
The FE topology and geometry topology face mode:
1 - Wireframe
2 - Shaded
3 - Shaded with edges
4 - Transparent with edges
topology_display_mode=<value>
The geometry color mode.
0 - Automatic. The color switches between topology colors and component colors, based on specific panels.
1 - By component
2 - By topology
3 - By 2D topology. 3D geometry is colored using the "ignored (topo)" color.
4 - By 3D topology. 2D geometry is colored using the "ignored (topo)" color.
5 - Mixed. Geometry edges are colored using topology colors, while shaded surfaces use component colors.
6 - Mappable. Solids are colored using the mappable colors (ignored map, not mappable, 1 dir map and 3 dir map). 2D geometry is colored using the "ignored (topo)" color.
7 - By assembly
8 - By part
topology_edge_display_color-<type>=<value>
The color of topology edges, from 0-64.
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_edge_display_mode-<type>=<value>
The display state of topology edges.
0 - Off
1 - On
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_solid_display_mode-<type>=<value>
The display state of solid topology faces.
0 - Off
1 - On
The type modifier is required and specifies a specific face type:
  • 0 - Fin faces
  • 1 - Full partition faces
  • 2 - Bounding faces
topology_solid_edge_display_color-<type>=<value>
The color of solid topology edges, from 0-64.
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_solid_edge_display_mode-<type>=<value>
The display state of solid topology edges.
0 - Off
1 - On
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
transparent_with_mesh_lines=<value>
The mesh line display when a component is transparent.
0 - If a component is transparent, do not show mesh lines
1 - If a component is transparent, show mesh lines
vector_auto_scale=<value>
The display of vector auto-scaling.
0 - Off
1 - On
vector_handle=<value>
The display of vector handles.
0 - Off
1 - On
vector_label=<value>
The display of vector labels.
0 - Off
1 - On
vector_size_magnitude=<value>
The vector display percentage when vector_size_type is 1.
vector_size_type=<value>
0 - Uniform display
1 - Magnitude display
vector_size_uniform=<value>
The vector display size in model units when vector_size_type is 0.
zoom_factor=<value>
The zoom in/out factor.

Examples

To set the rotation angle to 10 degrees:

*setoption rotation_angle=10
To set gradient background to the standard colors closest to (100, 200, 100) and (123, 0, 0):
*setoption background_colors-1={100 200 100}
*setoption background_colors-2={123 0 0}

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:
if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

14.0.130

2017.1 - Added new options anti_aliasing, edge_lod_threshold, edge_lod_width_auto, lighting_mode, specular_intensity and solidedge_width.

2019 - Added new options alt_lmb_rmb_binding, alt_mmb_binding, alt_rmb_binding, auto_cleanuptol, auto_elementsize, auto_nodetol, contact_surface_peak_factor, contact_surface_percent, ctrl_lmb_rmb_binding, ctrl_mmb_binding, ctrl_rmb_binding, delete_discrete_topology_mode, dynamic_center_of_rotation, element_connectivity, fe_display, geom_display, geom_point, hide_panels_automatically, legend_beyond_threshold, lmb_rmb_binding, load_max_size, load_min_size, load_new_scaling, load_scale_type, mmb_binding, mouse_append_mode, mouse_mapping, mouse_over_highlighting, node_size, number_remesh_layers, ply_link_color_and_orientation, pr_auto_preserve_connections, pr_box_approach_node_set, pr_check_log, pr_custom_bbox_for_equivalence, pr_delete_src_comp, pr_invoke_model_checker, pr_keep_src_comp_cardimage, pr_keep_src_comp_id, pr_keep_src_comp_name, pr_keep_src_ent_type, pr_keep_src_include, pr_keep_src_mat, pr_keep_src_prop, pr_merge_nodes, pr_retain_plotel_elem_nodeIds_from_src_comp, pr_show_component_pairing, reverse_zoom_direction, rmb_binding, shift_lmb_rmb_binding, shift_mmb_binding, shift_rmb_binding, show_model_title, show_plots, solid_edge_width, surface_edge_width, topoedgecolor, topofacecolor, topofacemodetopology_edge_display_color, topology_solid_edge_display_color and topology_solid_edge_display_mode. Added new delete_elements_mode value 4.

2019.1 - Added new options beam_lod_threshold, cadupdate_parameter_immediate, element_window_selection_mode, graphics_optimize_view_control, legend_allow_background_transparency, method_xml_file, numeric_legend_force_ranged, numeric_legend_threshold, snap_circle_center, snap_circle_center, snap_global_xyz, snap_line_end, snap_line_line_intersect, snap_line_middle, snap_on, snap_on_empty_space, snap_on_tangent_extension, snap_perp_from_line, snap_perp_from_surf, snap_perp_to_line, snap_perp_to_surf, snap_surf_center, snap_surf_line_intersect, snap_system_center, snap_tangent_from_line and snap_tangent_to_line.

2020 - Added new options edge_density_visible, highlight, graph_plot, legeng_ranged_discrete_button, morph_color, nearby_output_entities, nearby_radius, nearby_search_method, nearby_selected_operation, nodelod, quick_topo_selection, realize_loads, retain_element_values, show_newly_created_entities and snap_mesh_node. Added new element_color_mode values 8, 17, 18, 19, 20, 21 and 23.

2020.1 - Added new options geometry_parasolid_boolean and pr_prefix_basename_suffix_based_name_pairing.