Scene settings¶
Commands of the scene_settings chapter of the database, 6 entries. The status words are defined once, on the compatibility matrix, which says what each rests on and what the script builder does with it. Read it before this page: broken and removed are refusals, so a row here can be telling you the emitter will not write that command for that version.
SET_SCENE_COLORMAP_CUSTOM_MODE¶
Phase control, layout keyword_block. Manual: SRC-003 p.357.
Switches the colour scale between automatic limits and the custom ones. It is the gate for SET_SCENE_COLORMAP_CUSTOM_RANGE below: the two are separate commands, so the limits can be set while the mode is disabled and take effect only when it is enabled.
| Argument | Specification |
|---|---|
colormap |
enum in |
custom_range |
enum in |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.318, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.331, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.330, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.353, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.356, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.357 |
| 26.121 | documented | SRC-740 p.360, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.363, unchanged from SRC-750 p.363 |
| 26.124 | documented | SRC-752 p.363, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_SCENE_COLORMAP_CUSTOM_RANGE¶
Phase control, layout keyword_block. Manual: SRC-003 p.357.
Limits of the custom colour range and what is done with values outside them. CUT_OFF_MODE selects which tail is clipped: OFF clips neither, ABOVE_MAX and BELOW_MIN one each, ABOVE_AND_BELOW both. THIS COMMAND HAS NO SAMPLE OF ITS OWN IN ANY EDITION. All four print a sample under this heading whose first line names the NEIGHBOURING SET_SCENE_COLORMAP_CUSTOM_MODE while the keyword lines beneath it are this command's, CUT_OFF_MODE, MAXIMUM and MINIMUM, none of which appears in that neighbour's parameter table. So the sample is not a runnable call of either command, and it is the heading and the table that are recorded here. The same copy shape appears on the two CCS export commands (PLN-20260808-1730), where the consequence is an argument count rather than a command name.
| Argument | Specification |
|---|---|
colormap |
enum in |
cut_off_mode |
enum in |
maximum |
float |
minimum |
float |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.318, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.331, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.330, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.353, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.356, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.357 |
| 26.121 | documented | SRC-740 p.360, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.363, unchanged from SRC-750 p.363 |
| 26.124 | documented | SRC-752 p.363, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_SCENE_COLORMAP_POSITION¶
Phase control, layout keyword_block. Manual: SRC-003 p.356.
Position of the colour bar in screen pixels. These are window coordinates and not a location in the model's reference frame; no edition states the origin corner or the sign convention.
| Argument | Specification |
|---|---|
colormap |
enum in |
x |
int [pixels] |
y |
int [pixels] |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.317, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.330, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.329, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.352, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.355, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.356 |
| 26.121 | documented | SRC-740 p.359, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.362, unchanged from SRC-750 p.362 |
| 26.124 | documented | SRC-752 p.362, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_SCENE_COLORMAP_SHADING¶
Phase control, layout keyword_block. Manual: SRC-003 pp.356-357.
REVERSE flips the ramp end for end; SMOOTH draws it as a continuous gradient rather than as discrete bands. Both are display choices and neither changes the range being coloured, which is SET_SCENE_COLORMAP_CUSTOM_RANGE's subject.
| Argument | Specification |
|---|---|
colormap |
enum in |
reverse |
enum in |
smooth |
enum in |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.317, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.330, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.329, same grammar as 26.120 |
| 26.100 | documented | SRC-741 pp.352-353, same grammar as 26.120 |
| 26.101 | documented | SRC-725 pp.355-356, same grammar as 26.120 |
| 26.120 | documented | SRC-003 pp.356-357 |
| 26.121 | documented | SRC-740 pp.359-360, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.362, unchanged from SRC-750 p.362 |
| 26.124 | documented | SRC-752 p.362, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_SCENE_COLORMAP_SIZE¶
Phase control, layout keyword_block. Manual: SRC-003 p.356.
Size of the colour bar in screen pixels. THICKNESS IS THE LONG DIMENSION HERE, not the short one the word suggests: the manual's own sample passes 300 for THICKNESS and 15 for HEIGHT.
| Argument | Specification |
|---|---|
colormap |
enum in |
thickness |
int [pixels] |
height |
int [pixels] |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.317, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.330, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.329, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.352, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.355, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.356 |
| 26.121 | documented | SRC-740 p.359, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.362, unchanged from SRC-750 p.362 |
| 26.124 | documented | SRC-752 p.362, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_SCENE_COLORMAP_TYPE¶
Phase control, layout keyword_block. Manual: SRC-003 p.356.
Selects the colour ramp. The eleven names are the manual's own, in the order it prints them, and all four editions list the same eleven. They are perceptual choices rather than numerical ones and none of them changes a computed value.
| Argument | Specification |
|---|---|
colormap |
enum in |
type |
enum in |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.317, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.330, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.329, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.352, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.355, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.356 |
| 26.121 | documented | SRC-740 p.359, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.362, unchanged from SRC-750 p.362 |
| 26.124 | documented | SRC-752 p.362, the SRC-751 file, carried from 26.123; not run on 26.124 |