INQUIRE EXTENDED POLYLINE REPRESENTATION(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE EXTENDED POLYLINE REPRESENTATION − inquire the values of a workstation’s extended polyline representation

SYNOPSIS

C Syntax

void
pinqextlinerep ( wsid, index, type, error_ind, rep )
Pintwsid;workstation identifier
Pintindex;polyline index
Pinqtypetype;type of returned value (PSET,PREALIZED)
Pint∗error_ind;OUT error indicator
Pextlnbundl∗rep;OUT polyline representation

FORTRAN Syntax

SUBROUTINE pqeplr ( WKID, INDEX, TYPE, ERRIND, LTYPE, LWIDTH, COLMOD, ICOLR, COLR,
METHOD, ATYPE, AVALUE )
INTEGERWKIDworkstation identifier
INTEGERINDEXpolyline index
INTEGERTYPEtype of returned values (PSET,PREALI)
INTEGERERRINDOUT error indicator
INTEGERLTYPEOUT linetype
REALLWIDTHOUT linewidth scale factor
INTEGERCOLMODOUT colour model
INTEGERICOLROUT polyline colour index
REALCOLR(3)OUT colour values
INTEGERMETHODOUT polyline shading method
INTEGERATYPEOUT curve approximation type
REALAVALUEOUT curve approximation value

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE EXTENDED POLYLINE REPRESENTATION returns the attribute values of a specified entry in a workstation extended polyline bundle table. See SET EXTENDED POLYLINE REPRESENTATION for a full description of the contents of the bundle table entry and a description of the extended polyline bundle table.

This is a SunPHIGS Extension function based on PHIGS+ and is not part of the PHIGS standard.

C Input Parameters

All of the following data types are predefined in phigs.h.

wsidWorkstation identifier.

indexIndex of the entry to be returned from the workstation extended polyline bundle table. If this entry is not present in the table, and the type of returned value parameter is PREALIZED, the representation for polyline index one is returned.

typeAn enumerated value specifying whether the values to be returned are those originally specified by the application (PSET), or those resulting after PHIGS mapped them to ones available on the workstation (PREALIZED). A Pinqtype structure is defined as:

typedef enum {
PSET,
PREALIZED
} Pinqtype;

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

repA pointer to a Pextlnbundl structure which returns the specified extended polyline representation. Pextlnbundl is defined as:

typedef struct {
Pinttype;/∗ line type ∗/
Pfloatwidth;/∗ linewidth scale factor ∗/
Pgcolrcolour;/∗ polyline colour ∗/
Pintshading;/∗ polyline shading method ∗/
Pintapprox_type;/∗ curve approximation type ∗/
Pfloatapprox_value;/∗ curve approximation value ∗/
} Pextlnbundl;

See SET EXTENDED POLYLINE REPRESENTATION for a full description of the contents of this structure.

FORTRAN Input Parameters

All of the following data types are predefined in phigs77.h.

WKIDWorkstation identifier.

INDEX
Index of the entry to be returned from the workstation extended polyline bundle table. If this entry is not present in the table and the type of returned value parameter is PREALI, then representation for polyline index one is returned.

TYPEAn enumerated value specifying whether the values to be returned are those originally specified by the application (Set), or those resulting after PHIGS mapped them to ones available on the workstation (Realized). Valid values are:

0PSETSet
1PREALIRealized

FORTRAN Output Parameters

ERRIND
The error number of any error detected by this function.

LTYPE
The line type.

LWIDTH
The linewidth scale factor.

COLMOD
The colour model. The predefined values are:

0PINDIRColour Index Specified
1PRGBRed, Green, and Blue
2PCIECIE Colour Model
3PHSVHue, Saturation, and Value
4PHLSHue, Lightness, and Saturation

ICOLR
An integer value which is an index into the workstation colour table for determining the polyline colour. This value is not used if COLMOD is greater than zero.

COLR(3)
An array of reals containing the colours for the polyline. This array is unused if COLMOD is equal to zero (PINDIR).

COLR(1) = Red, Hue, etc.
COLR(2) = Green, Saturation, Lightness, etc.
COLR(3) = Blue, Value, Saturation, etc.

METHOD
The polyline shading method.

ATYPE
The curve approximation type.

AVALUE
The curve approximation value.

Execution

If the inquired information is available, the error indicator is returned as zero and the requested information is returned in the output parameters.

If the specified polyline index is not present in the polyline bundle table on the workstation and the specified type of returned value is Realized, the representation for polyline index one is returned.

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the below error numbers to indicate the reason for non-availability.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

100Ignoring function, the bundle index value is less than one

101Ignoring function, the specified representation has not been defined

Museum