*hideentity

Turns off the display of an entity.

Syntax

*hideentity entity_type search_type id_name string_array number_of_strings

Type

HyperMesh Tcl Modify

Description

Turns off the display of an entity.

Inputs

entity_type
The type of entity to display.
search_type
The method used to specify the entity. The entity is specified using the id_name argument. Valid values are:
"by name" - Entity is specified using the entity name.
"by id" - Entity is specified using the entity ID.
id_name
The ID or name of the entity, depending on search_type.
string_array
The ID of the string array that contains the additional input parameters. The string array is created using the *createstringarray command. This should always be set to 1.
number_of_strings
Integer indicating the size (number of strings) in the string array created using *createstringarray. The valid strings are:
elements_off - This indicates that elements in the specified collectors should not be considered. If not provided, the default is to consider elements in the specified collectors.
geometry_off - This indicates that geometry in the specified collectors should not be considered. If not provided, the default is to consider geometry in the specified collectors.
showcomps - This indicates that components in which elements/geometry are referred will also be hidden when we hide elements/geometry. If not provided, only specified elements/geometry are hidden.
refflag_# - A flag that indicates the referenced entities to also hide when hiding an entity. # is a value from 1-7 and is defined as below. If not provided, the default is 7.
  • 1 - Hide all referenced collected entities
  • 2 - Hide all referenced data name entities
  • 3 - Hide all referenced collected and data name entities
  • 4 - Hide all referenced attribute entities
  • 5 - Hide all referenced attribute and collected entities
  • 6 - Hide all referenced attribute and data name entities
  • 7 - Hide all referenced attribute, data name and collected entities

Examples

To hide geometry and elements for component with ID 3, and all referenced entities:

*hideentity comps "by id" 3

or

*createstringarray 1 refflag_7
*hideentity comps "by id" 3 1 1

To hide elements only for component with ID 3, and only referenced collected entities:

*createstringarray 2 geometry_off refflag_1
*hideentity comps "by id" 3 1 2

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

11.0.130