Windowing and Flattening

(int) SetConvertFlags(use_window, clip, flatten, ecf_level, rw)
This function sets the status of flags used in format conversions and when writing output. The first three arguments correspond to the Use Window, Clip to Window, and Flatten Hierarchy buttons in the Format Conversion panel and similar. A nonzero integer value will set the flag, 0 will reset the flag.

The ecf_level is an integer 0-3 which sets the empty cell filtering level, as described for the Format Conversion panel in 14.10. The values are

0	No empty cell filtering.
1	Apply pre- and post-filtering.
2	Apply pre-filtering only.
3	Apply post-filtering only.

The rw argument is a boolean value that if zero indicates that the flags will be applied when converting archive files, as if set from the Format Conversion panel, and also apply to the FromArchive script function. With rw nonzero, the flags apply when writing output with the Export Control panel, or when using the Export and ToXXX script functions. In this case, the no_empties flag is ignored, and the windowing is ignored except when flattening.

The data window can be set with the SetConvertArea script function. To apply clipping, both the use_window and clip flags must be set.

This function returns the previous value of the internal variable that contains the flags. The two ecf filter bits encode the filtering level as above. The bits are:

flatten	0x1
use_window	0x2
clip	0x4
ecf level0	0x8
ecf level1	0x10

(int) SetConvertArea(l, b, r, t, rw)
This function sets the rectangular area used to filter or clip objects during format conversion or file writing. The first four arguments are the window coordinates in microns, in the coordinate system of the top level cell, after scaling (if any).

The rw argument is a boolean value that if zero indicates that the values will be applied when converting archive files, as if set from the Format Conversion panel, and also apply when using the FromArchive script function. With rw nonzero, the values apply when writing output with the Export Control panel, or when using the Export and ToXXX script functions. In this case, windowing is ignored except when flattening.

Use of the window can be enabled with the SetConvertFlags script function.

The function always returns 1.