shapes

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
bias
Pointer to bias factors for handles.
Type: double array
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
handleids
Pointer to the perturbed handles.
Type: entity array
handleidsmax
The number of perturbed handles.
Type: unsigned integer
hpert
Pointer to x, y and z coordinates of perturbed handles.
Type: double array
id
The ID of the entity.
Type: unsigned integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
nodeids
Pointer to the perturbed nodes.
Type: entity array
nodeidsmax
The number of perturbed nodes.
Type: unsigned integer
npert
Pointer to the x, y and z coordinates of perturbed nodes.
Type: double array
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
parameterid
The ID of the design variable parameter associated with the shape.
Type: entity
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
radial
Returns true if the shape was created using rotation. Used when creating nonlinear desvars (bool). Valid for hm_getvalue query only.
Type: Boolean
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
systemid
The ID of the system associated with the shape.
Type: entity
vectorcollectorid
The ID of the vector collector associated with the shape.
Type: entity

Version History

2019.1 - Added new data name parameterid.

2020 - Added new data name color_rgb.

2020.1 - Added new data name solverkeyword.

2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.