graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQRVX - Inquire Requested Viewing Transformation

GPQRVX (wsid, view, errind, matrix, window, viewpt, viewt, refpt, dist, near, far, wincp, nearcp, farcp, shield, shldci, border, brdrci, viewact)

Purpose

Use GPQRVX to inquire the viewing parameters of a specified view in the specified workstation view table. These values are not current, if the values have been passed to the graPHIGS API but the workstation has not been updated. If your application uses direct color to set the shielding or border color of the specified view, then you must use the Inquire Requested View Representation (GPQRVR) subroutine to inquire the view information.

The graPHIGS API returns the requested viewing transformation matrix, the requested viewport, and the view characteristics.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

view -- specified by user, fullword integer

View index (>=0)

errind -- returned by the graPHIGS API, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:

25: SPECIFIED WORKSTATION DOES NOT EXIST
59: VIEW INDEX VALUE < ZERO
323: VIEW INDEX EXCEEDS VIEW TABLE CAPACITY
526: REQUESTED DATA NOT AVAILABLE FOR THIS FUNCTION

matrix -- returned by the graPHIGS API, 16 short floating-point numbers

Requested viewing transformation matrix. For the transformation matrix, the elements are returned in the following order:

                
 |m11 m12 m13 m14|
 |m21 m22 m23 m24|---> (m11,m12,m13,m14,m21....m44)
 |m31 m32 m33 m34|
 |m41 m42 m43 m44|

window -- returned by the graPHIGS API, 4 short floating-point numbers (VC)

Requested window (Umin, Umax, Vmin, Vmax)

viewpt -- returned by the graPHIGS API, 6 short floating-point numbers (NPC)

Requested viewport (Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)

viewt -- returned by the graPHIGS API, fullword integer

Requested view type (1=PARALLEL, 2=PERSPECTIVE )

refpt -- returned by the graPHIGS API, 3 short floating-point numbers (VC)

Requested projection reference point (u, v, n)

dist -- returned by the graPHIGS API, short floating-point number (VC)

Requested distance of the view plane from the view reference point along the n-axis.

near -- returned by the graPHIGS API, short floating-point number (VC)

Requested distance of the near clipping plane from the view reference point along the n-axis.

far -- returned by the graPHIGS API, short floating-point number (VC)

Requested distance of the far clipping plane from the view reference point along the n-axis.

wincp -- returned by the graPHIGS API, fullword integer

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

nearcp -- returned by the graPHIGS API, fullword integer

Requested near clipping indicator (1=NOCLIP, 2=CLIP )

farcp -- returned by the graPHIGS API, fullword integer

Requested far clipping indicator (1=NOCLIP, 2=CLIP )

shield -- returned by the graPHIGS API, fullword integer

Requested shielding indicator (1=OFF, 2=ON )

shldci -- returned by the graPHIGS API, fullword integer

Requested shielding color index.

Note:

Direct shielding color returns error indicator 526

border -- returned by the graPHIGS API, fullword integer

Requested view border indicator (1=OFF, 2=ON )

brdrci -- returned by the graPHIGS API, fullword integer

Requested view border color index.

Note:

Direct border color returns error indicator 526

viewact -- returned by the graPHIGS API, fullword integer

Requested view active indicator for output (1=INACTIVE, 2=ACTIVE )

Error Codes

None

Related Subroutines

GPQRVR: Inquire Requested View Representation

RCP code

201336840 (X'0C002808')