hm_getvectoroption

Returns the current value of the settings for vector display.

Syntax

hm_getvectoroption option

Type

HyperMesh Tcl Query

Description

This command returns the current display setting for the passed vector option.

Inputs

option
The option to query. Valid values are:
vectorautoscale
Returns the *vectorautoscale setting (0 = off, 1 = on).
vectorhandle
Returns the *vectorhandle setting (0 = off, 1 = on).
vectorlabel
Returns the *vectorlabel setting (0 = off, 1 = on).
vectorsize_magnitude
Returns the *vectordrawoptions "magnitude %" size. This can be queried regardless of the vectorsize_type value.
vectorsize_type
Returns the *vectordrawoptions type setting (0 = uniform, 1 = magnitude %).
vectorsize_uniform
Returns the *vectordrawoptions "uniform" size value. Not valid for load_config 10. This option can be queried regardless of the vectorsize_type value.

Examples

To get the vectorlabel setting:

hm_getvectoroption vectorlabel

To get the vectorsize_type setting:

hm_getvectoroption vectorsize_type

To get the vectorsize_uniform setting:

hm_getvectoroption vectorsize_uniform

To get the vectorsize_magnitude setting:

hm_getvectoroption vectorsize_magnitude

Errors

If option is invalid, you will get the following error:
hm_getvectoroption:  invalid option specified.
Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:
if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

9.0