SchemeExt:Entity:dspindex
From DocR23
Contents |
Action
Returns the shell, wire, face, edge, tedge, coedge, tcoedge, vertex, or tvertex specified by the given debug output index.
Filename
scm/scmext/kern/dbg_scm.cpp
APIs
api_get_coedges, api_get_edges, api_get_faces, api_get_shells, api_get_vertices, api_get_wires
Syntax
(entity:dspindex entity type index)
Argument Types
| Argument | Scheme Data Type |
|---|---|
| entity | entity |
| type | string |
| index | integer |
Returns
entity | boolean
Description
Returns the shell, wire, face, edge, tedge, coedge, tcoedge, vertex, or tvertex specified by the given index into the debug output for the given entity. Note that usually the given entity will be a body. This is useful if you wish to highlight a specific entity in the debug output. For example, given the debug output for a body, you might want to highlight the edge that corresponds to "edge 32" in the debug output.
An entity is returned if a reasonable index value is given, otherwise FALSE.
Arguments
- entity specifies the entity to be queried.
- type is the string representing the entity type of the given index. Allowed values are "wire", "shell", "face", "edge", "coedge", "tedge", "tcoedge", "vertex", and "tvertex".
- index specifies the index as listed in the debug output of the given entity.
Example
; entity:dspindex ; Create a body. (define b (solid:block (position -10 -10 -10) (position 10 10 10))) ;; b ; Select the face corresponding to "face 3" in the body's debug output. (define c (entity:dspindex b "face" 3)) ;; c
