hm_getplanepanel

Provides a widget to define a plane.

Syntax

hm_getplanepanel ?message? ?default_value? ?node_coordinates?

Type

HyperMesh Tcl GUI Command

Description

Provides a widget to define a plane. A list with two sublists is returned from this command when successfully executed: {{normal_x normal_y normal_z} {base_x base_y base_z}}

If the node_coordinates option is enabled, if the user has defined the plane using N1N2N3, the coordinates of those nodes are also returned as: {{normal_x normal_y normal_z} {base_x base_y base_z}} {n1_x n1_y n1_z n2_x n2_y n2_z n3_x n3_y n3_z}

Inputs

?message?
Optional string to show in the status bar when displaying the widget.
?default_value?
Optional default value to set the entity filter to when displaying the widget. message must be specified to use this option.
Valid values are:
  • N1N2N3 (default if not specified)
  • X_AXIS
  • Y_AXIS
  • Z_AXIS
  • AV_VECTOR
  • SCREEN_NORMAL
  • SCREEN_PARALLEL
?node_coordinates?
0 - Do not output node coordinates for N1N2N3 selection (default if not specified)
1 - Output node coordinates for N1N2N3 selection

Example

To get a plane definition from a user:

set plane [hm_getplanepanel "Please define a plane"]
foreach {nx ny nz} [lindex [lindex $plane 0] 0] {}
foreach {bx by bz} [lindex [lindex $plane 0] 1] {}

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

12.0.110

2017.1 - Added new option default_value.

2020.1 - Added new option node_coordinates.