graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPXVCH - Set Extended View Characteristics

GPXVCH (wsid, view, number, charids, values)

Purpose

Use GPXVCH to set one or more characteristics of the specified view. Characteristics which may be set with this subroutine include: clipping indicators, appearance of the viewport, a value indicating if the view is displayed, and a value indicating if the display view option changes frequently.

The values specified are stored in the requested view table entries. When the application updates the workstation, the graPHIGS API sets the corresponding current values to the requested values.

The clipping indicators determine to which boundaries the contents of the view are clipped. The shielding indicator determines if the content of lower priority views may be displayed within the boundaries of the specified viewport. The border indicator specifies if a border is to be drawn around the viewport. The view active flag determines if the view and its contents are displayed.

When set to 2=ON , the temporary view indicator indicates that the corresponding view will have its view activity changed frequently. Where possible the device support saves the current underlying screen image. This allows deactivation to consist of restoring the underlying screen image without requiring structure traversal. A typical use of the temporary view capability is the "pop-up menu" found in many applications today.

Application developers should be aware of the following points:

The temporary view indicator acts as an indicator to the graPHIGS API that the corresponding view is active only for a short period of time. If used properly, it can greatly contribute to the interactive performance of viewport deactivation.

The best efficiency is gained when a temporary view is the highest priority active viewport.

The workstation's view table is 0 based, however, view entry 0 cannot be changed. (For the default values for the view entry 0, see The graPHIGS Programming Interface: Technical Reference )

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

view -- specified by user, fullword integer

View index (>=1) Index of view table entry to be altered.

number -- specified by user, fullword integer

Number of characteristic identifiers in the charids list (>=1)

charids -- specified by user, array of fullword integers

List of characteristic identifiers. Each integer identifies a view characteristic to be set.

values -- specified by user, array of fullword integers

List of characteristic values. Each list entry specifies the value to be applied to the corresponding characteristic identifier listed in the charids list.

Valid view characteristic identifiers and values are:

1 = View window clipping indicator (1=NOCLIP, 2=CLIP )

2 = Near clipping indicator (1=NOCLIP, 2=CLIP )

3 = Far clipping indicator (1=NOCLIP, 2=CLIP )

4 = View shielding indicator (1=OFF, 2=ON )

6 = View border indicator (1=OFF, 2=ON )

8 = View active flag (1=INACTIVE, 2=ACTIVE )

9 = Temporary view indicator (1=OFF, 2=ON )

Error Codes

25: SPECIFIED WORKSTATION DOES NOT EXIST
59: VIEW INDEX VALUE < ZERO
323: VIEW INDEX EXCEEDS VIEW TABLE CAPACITY
332: CLIP INDICATOR VALUE IS INVALID
334: TEMPORARY VIEW INDICATOR IS INVALID
507: SHIELDING INDICATOR VALUE IS INVALID
508: VIEW ACTIVE FLAG VALUE IS INVALID
518: VIEW ZERO CANNOT BE MODIFIED
547: VIEW BORDER INDICATOR IS INVALID
591: NUMBER OF CHARACTERISTICS IDENTIFIERS IS < ONE
592: VIEW CHARACTERISTICS IDENTIFIER IS INVALID

Related Subroutines

GPQCVR: Inquire Current View Representation
GPQRVR: Inquire Requested View Representation
GPXVR: Set Extended View Representation

RCP code

201330434 (X'0C000F02')