Programmer Guide/Command Reference/EVAL/pginit: Difference between revisions
From STX Wiki
< Programmer Guide | Command Reference | EVAL
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
Check or | Check or initialize a polygon stream. | ||
;Usage:<code> | ;Usage:<code>pginit(<var>X</var> {, <var>N</var>=0, {number}<var>E</var>=0} )</code> | ||
:;<var>X</var>:A [[../#polygons|closed point-list]] or a [[../#polygons|polygon-stream]] defining one or more polygons. | :;<var>X</var>:A [[../#polygons|closed point-list]] or a [[../#polygons|polygon-stream]] defining one or more polygons. | ||
:;<var>N</var>:The requested number of simple polygons: | :;<var>N</var>:The requested number of simple polygons: | ||
::{|class="keinrahmen" | ::{|class="keinrahmen" | ||
|<var>N</var> | |<var>N</var>≤0 ||undefined, polygons are counted during initialization | ||
|- | |- | ||
|<var>N</var>>0 || exactly <var>N</var> simple polygons must be contained in <var>X</var> | |<var>N</var>>0 || exactly <var>N</var> simple polygons must be contained in <var>X</var> | ||
|} | |} | ||
:;<var>E</var>:The maximum error for polygon simplification. If <var>E</var> | :;<var>E</var>:The maximum error for polygon simplification. If <var>E</var>≤0 the simplification is skipped. | ||
:;Result:A [[../#polygons|polygon-stream]] <var>P</var> containing all simple-polygons defined by <var>X</var>. The function failes if: | :;Result:A [[../#polygons|polygon-stream]] <var>P</var> containing all simple-polygons defined by <var>X</var>. The function failes if: | ||
::*no simple polygons can be found or one of the detected polygons is invalid | ::*no simple polygons can be found or one of the detected polygons is invalid | ||
::*<var>N</var>>0 and the number of polygons defined by <var>X</var> is not equal to <var>N</var> | ::*<var>N</var>>0 and the number of polygons defined by <var>X</var> is not equal to <var>N</var> | ||
;See also: [[../ | ;See also: [[../pgget|pgget]], [[../pgitest|pgitest]], [[../pgiline|pgiline]], [[../pgxgrid|pgxgrid]], [[../pgsplit|pgsplit]], [[../pgtrans|pgtrans]], [[../pghull|pghull]] | ||
[[../#Functions|<function list>]] | [[../#Functions|<function list>]] | ||
Latest revision as of 19:10, 21 April 2011
Check or initialize a polygon stream.
- Usage
pginit(X {, N=0, {number}E=0} )- X
- A closed point-list or a polygon-stream defining one or more polygons.
- N
- The requested number of simple polygons:
N≤0 undefined, polygons are counted during initialization N>0 exactly N simple polygons must be contained in X
- E
- The maximum error for polygon simplification. If E≤0 the simplification is skipped.
- Result
- A polygon-stream P containing all simple-polygons defined by X. The function failes if:
- no simple polygons can be found or one of the detected polygons is invalid
- N>0 and the number of polygons defined by X is not equal to N
