*setoption

Sets various option values.

Syntax

*setoption <option>=<value>

Type

HyperMesh Tcl Modify

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.
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.
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, HyperMesh will not redraw unless the size of its window changes or it is de-iconified or maximized. When the redraw operation is unblocked, HyperMesh returns to normal.
0 - Allows redraw
1 - Blocks redraw
buffer_command_file=<value>
Controls the command file writing state.
0 - Disable writing to the command file
1 - Enable writing to the command file
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
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
contour_type=<value>
The result color mode.
0 - Blended contour
1 - Discrete contour
delete_elements_mode=<value>
The remesh setting for topology revision.
0 - Keep mesh
1 - Delete mesh
2 - Remesh
3 - Advanced 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 HyperMesh.
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
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 - Reserved for future use
  • 9 - By element quality
  • 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
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_size=<value>
The default element size to use when calculating element densities in the auto-meshing module.
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
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
force_text_black=<value>
The display of graphical text between black and white. By default, text in HyperMesh 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_feature_angle=<value>
The geometry feature angle used for geometry creation and editing operations.
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
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_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
hv_launch_flag=<value>
Controls the launching of HyperView after an H3D creation.
0 - Disable HyperView launch
1 - Enable HyperView launch
line_handle=<value>
The display of line handles.
0 - Off
1 - On
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_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 – HyperMesh 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. 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.
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.
node_tolerance=<value>
The global node tolerance. Must be greater than cleanup_tolerance/100.
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_thickness_factor=<value>
The ply thickness scale factor for composite layer visualization. This applies for show_composite_layers values 1 and 2.
retain_loads=<value>
Keep/delete loads when associated nodes/elements are deleted.
0 - Delete
1 - Keep
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)
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).
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_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
solid_transparency=<value>
The solid geometry transparency value 0-10.
stereo_display=<value>
The normal (2D) or stereo (3D) display mode.
0 - Normal display mode
1 - Stereo display mode
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.
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_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
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