|
Action:
|
Gets a list of wires from an entity or list of entities.
|
|
|
Filename:
|
kern/kern_scm/ent_scm.cxx
|
|
|
APIs:
|
api_get_wires
|
|
|
Syntax:
|
(entity:wires entity-list [include-pat])
|
|
|
Arg Types:
|
entity-list
|
entity | (entity ... )
|
|
include-pat
|
integer
|
|
|
Returns:
|
(wire ... )
|
|
|
Description:
|
This extension returns a list of the entity's wires. If no wire entities are found, this extension returns an empty list.
|
|
|
entity-list specifies an 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:wires
|
|
; Create circular edge 1.
|
|
(define edge1
|
|
|
(edge:circular (position 0 0 0) 25 0 180))
|
|
;; edge1
|
|
; Create circular edge 2.
|
|
(define edge2
|
|
|
(edge:circular (position 0 0 0) 25 180 270))
|
|
;; edge2
|
|
; Create linear edge 3.
|
|
(define edge3
|
|
|
(edge:linear (position 0 0 0) (position 25 0 0)))
|
|
;; edge3
|
|
; Create a wire body from the three edges.
|
|
(define body1
|
|
|
(wire-body (list edge3 edge1 edge2)))
|
|
;; body1
|
|
; Get a list of the body's wires.
|
|
(entity:wires body1)
|
|
;; (#[entity 6 1])
|