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

NAME

INQUIRE PREDEFINED EXTENDED POLYLINE REPRESENTATION − inquire a predefined extended polyline representation from a specified workstation type

SYNOPSIS

C Syntax

void
pinqpredextlinerep ( wstype, index, error_ind, rep )
Pwstypewstype;workstation type
Pintindex;predefined polyline index
Pint∗error_ind;OUT error indicator
Pextlnbundl∗rep;OUT predefined polyline representation

FORTRAN Syntax

SUBROUTINE pqpepr ( WKTYPE, INDEX, ERRIND, LTYPE, LWIDTH, COLMOD, ICOLR, COLR,
METHOD, ATYPE, AVALUE )
INTEGERWKTYPEworkstation type
INTEGERINDEXpredefined polyline index
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, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED EXTENDED POLYLINE REPRESENTATION returns the attribute values of a specified predefined entry in the extended polyline bundle table of a workstation type’s workstation description 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.

wstype
The workstation type.

index
Index of the predefined entry to be returned.

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 requested 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

WKTYPE
The workstation type.

INDEX
Index of the predefined entry to be returned.

FORTRAN Output Parameters

See SET EXTENDED POLYLINE REPRESENTATION for a full description of the below 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 containing the index into the workstation colour table for the polyline colour. This value is not used if COLMOD is greater than zero.

COLR(3)
An array of reals containing the polyline colour. 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 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 nonavailability.

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 unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

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

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

102Ignoring function, the specified representation has not been predefined on this workstation

Museum