SchemeExt:Cover:options
From DocR21
Contents |
Action
Creates cover_options scheme object.
Filename
scm/scmext/cover/covr_scm.cpp
APIs
None
Syntax
(cover:options [property-name property-value ... ])
Argument Types
| Argument | Scheme Data Type |
|---|---|
| property-name | string |
| property-value gap_tol | type depends on which property is being set: |
Returns
cover_options
Description
cover_options objects specify optional behavior for the following covering APIs:
The option behavior includes specifying a covering surface, specifying an allowable gap tolerance used when covering with planes or a user-specified covering surface, and a tolerize_entity_opts which is used along with the gap tolerance to produce valid tolerant covers.
If you specify a covering surface, the APIs attempt to make a face with the given input circuit and the surface you specify: this will fail if the edges or vertices in the input circuit are more than gap_tol away from the covering surface. The default behavior is to have no covering surface specified. In this case, the APIs attempt to make a surface which covers the given loops.
The gap_tol specifies how far circuit geometry can be from the covering surface you specify, or how far the circuit can be from planar, and still get covered. When the APIs produce a cover where the circuit geometry is further than SPAresabs from the covering surface, the result is tolerized, to produce a valid body.
Arguments
- property-name is of string type. Valid values are:
- gap_tol
- covering_surface
- tolerize_entity_opts
- property argument type depends upon which property you are setting. Refer to the Argument Types table above.
Example
(define co (cover:options 'gap_tol .001 'covering_surface my-face 'tolerize_entity_opts my-te-opts)) (sheet:cover my-sheet co)
