|
Action:
|
Gets a list of shell entities from a topological entity or list of entities.
|
|
|
Filename:
|
kern/kern_scm/ent_scm.cxx
|
|
|
APIs:
|
api_get_shells
|
|
|
Syntax:
|
(entity:shells entity-list [include-pat])
|
|
|
Arg Types:
|
entity-list
|
entity | (entity ... )
|
|
include-pat
|
integer
|
|
|
Returns:
|
(shell ... )
|
|
|
Description:
|
This extension returns a list of the entity's shells. If no shell entities are found, this extension returns an empty list.
|
|
|
entity-list specifies a topological entity or an entity list.
|
|
|
The parameter
include-pat determines how this function deals with patterned objects. By default, patterned objects are included in the list of entities. The user may specify any one of the following through this argument:
|
|
|
0
|
patterned objects are created if they do not already exist, and are included in the list.
|
|
1
|
only those patterned objects that have already been created are included in the list.
|
|
2
|
no patterned objects besides seed pattern objects are included in the list.
|
|
|
Example:
|
; entity:shells
|
|
; Create a solid block.
|
|
(define block1
|
|
|
(solid:block (position 0 0 0)
|
|
|
(position 25 15 5)))
|
|
;; block1
|
|
; Get a list of the block's shells.
|
|
(entity:shells block1)
|
|
;; (#[entity 3 1])
|