INQUIRE DISPLAY SPACE SIZE 3(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE DISPLAY SPACE SIZE 3− inquire the display space size of a workstation type

SYNOPSIS

C Syntax

void
pinq_disp_space_size3 ( type, error_ind, size )
Pinttype;workstation type
Pint∗error_ind;OUT error indicator
Pdisp_space_size3∗size; OUT display size

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE DISPLAY SPACE SIZE 3 returns the display space size associated with the workstation type specified. The workstation type passed as an argument to this function can be either a generic type or a specific type, a specific type being one associated with an open workstation and obtained by a call to INQUIRE WORKSTATION CONNECTION AND TYPE. The information is retrieved from the workstation description table associated with the workstation type.

C Input Parameters

typeThe workstation type, either generic or specific.

C Output Parameters

error_ind
The error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

sizeA pointer to a Pdisp_space_size3 structure in which to store the requested information. Pdisp_space_size3 is defined in phigs.h as:

typedef struct {
Pdc_unitsdc_units;/∗ device coordinate units ∗/
Pfloat_size3size_dc;/∗ device volume in coordinate units ∗/
Pint_size3size_raster;/∗ addressable units ∗/
} Pdisp_space_size3;

dc_units indicates the unit type, if any, of the device coordinate units. Pdc_units is defined in phigs.h as:

typedef enum {
PDC_METRES,
PDC_OTHER
} Pdc_units;

size_dc contains the upper limits of the device coordinate units. The lower limits are zero in all dimensions. See the Execution section below for a description of the meaning of these values. Pfloat_size3 is defined in phigs.h as:

typedef struct {
Pfloatsize_x;
Pfloatsize_y;
Pfloatsize_z;
} Pfloat_size3;

size_raster contains the number of addressable units corresponding to the device coordinate units. See the Execution section below for a description of the meaning of these values for each supported workstation type. Pint_size3 is defined in phigs.h as:

typedef struct {
Pintsize_x;
Pintsize_y;
Pintsize_z;
} Pint_size3;

Execution

INQUIRE DISPLAY SPACE SIZE 3 retrieves the device coordinate space limits and the number of addressable units of a workstation type. The device coordinate space limits correspond to the maximum device coordinate (DC) values of a workstation. DC is the conceptual coordinate system of the display device and is the coordinate system used by the application to specify the workstation viewport and input device echo areas. The lower limits of DC are always zero in all three dimensions.

The DC limits and addressable units are specified in the workstation description table associated with a workstation type. They can be different in all three dimensions. The DC limits are set to the size of the workstation’s X window when the workstation is opened. When the window is resized the DC limits change to the new size of the window. Subsequent calls to INQUIRE DISPLAY SPACE SIZE 3 will reflect this change by returning the limits in effect at the time of the function call. See the PHIGS_DC_MODEL attribute description in WORKSTATION TYPE SET for a description of how to change this behavior so that DC limits do not change with the window size.

If the type specified is a generic x_tool workstation type (in other words, one not associated with an open workstation), then the display space size corresponds to the size of the window that would be used if a workstation were opened with that type.

If the type specified is a generic x_drawable workstation type, then error 51 will be returned in the error indicator, indicating that the information is unavailable for such a workstation type and a specific workstation type is required.

If an error is detected by this function the error indicator will indicate the error number of the error detected and no other output data will be returned. If no error is detected, the error indicator will be set to zero and the inquired information will be available in the output parameters. Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

051Ignoring function, this information is not yet available for this workstation type; open a workstation of this type and use the specific workstation type

052Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

057Ignoring function, specified workstation is of category MI

062Ignoring function, this information is not available for this MO workstation type

Museum