sketches

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
cardimage
The name of the assigned card image.
Type: string
cardimagetype
The type of the assigned card image.
Type: string
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
config
The configuration of the entity.
Type: unsigned integer
curvescount
The number of the independent curves not owned by other sketch entities present in the sketch. Valid for hm_getvalue query only.
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
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
internalname
The internal name of the entity.
Type: string
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
planenormal
The normal vector of the sketch work plane (normalized).
Type: triple double
planeorigin
The origin of the sketch workplane.
Type: triple double
planexdir
The x-axis reference direction vector of the sketch work plane (normalized).
Type: triple double
pointscount
The number of the independent points not owned by other sketch entities present in the sketch. Valid for hm_getvalue query only.
Type: unsigned integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
realize_mode
The current sketch data realization mode. For unrealized sketch entities, the value is 0.
Type: unsigned integer
0 – None
1 – Lines
2 – Surfaces
realize_opt_surfs_create_holes
When true, the inner closed regions are created as holes when the sketch entity is realized as surfaces.
Type: Boolean
realize_opt_surfs_merge_faces
When true, the adjacent connected regions are merged when the sketch entity is realized as surfaces.
Type: Boolean
realizedlines
The list of the line entities realized from the sketch data. Valid for hm_getvalue query only.
Type: entity array
realizedpoints
The list of the point entities realized from the sketch data. Valid for hm_getvalue query only.
Type: entity array
realizedsurfaces
The list of the surface entities realized from the sketch data. Valid for hm_getvalue query only.
Type: entity array
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
solvername
The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Type: string
variablesused
The list of the parameter entities referenced in the parameteric expressions of the sketch constraints.
Type: entity array

Version History

2021.2