hm_saveusermark

Store the entity IDs of the passed entity type on the user mark.

Syntax

hm_saveusermark entity_type mark_id ?panel_sensitive?

Type

HyperMesh Tcl Query Command

Description

This command stores the IDs of entity_type that exist on mark_id on the user mark. Valid mark_ids are 1 and 2. Only one user mark exists for each entity_type.

The ?panel_sensitive? option can be used when multiple panel levels have been pushed, either using the shortcut function keys, or the hm_pushpanel command. This option determines whether to use the current panel or the previous panel for the operation. This option is relevant only when the mark has been created from a panel entity selector under the above conditions. Valid panel_sensitive options are:

0 - Use the previous panel (default).

1 - Use the current panel.

The user mark is accessed either through the command hm_getusermark or through panel input collectors, hm_createmark and hm_appendmark via the "retrieve" option.

Example

To save the user mark of properties 1,3 and 5:

m_createmark props 1 "by id only" "1 3 5"
hm_saveusermark props 1

To create a mark of elements 1-3, save it to the element user mark and retrieve it later:

hm_createmark elems 1 "1 2 3"
hm_saveusermark elems
hm_markclear elems 1
…
hm_getusermark elems

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:

if { [ catch {command_name...} ] } {
   # Handle error
}

If mark_id is invalid, you will get the following error:

hm_saveusermark: invalid markmask specified