NAME

INQUIRE POLYLINE REPRESENTATION PLUS - inquire for values of workstation's extended polyline representation

SYNOPSIS

C Syntax

void

pinq_line_rep_plus ( ws, index, type, error_ind, rep )

Pint                 ws;           workstation identifier
Pint                 index;        polyline index
Pinq_type            type;         type of returned value
Pint                 * error_ind;  OUT error indicator
Pline_bundle_plus    * rep;        OUT polyline representation

FORTRAN Syntax

SUBROUTINE pqeplr ( WKID, INDEX, TYPE, ERRIND, LTYPE, LWIDTH, COLMOD, ICOLR, COLR, METHOD, ATYPE, AVALUE )

INTEGER      WKID         workstation identifier
INTEGER      INDEX        polyline index
INTEGER      TYPE         type of returned values (PSET, PREALI )
INTEGER      ERRIND       OUT error indicator
INTEGER      LTYPE        OUT linetype
REAL         LWIDTH       OUT linewidth scale factor
INTEGER      COLMOD       OUT colour model
INTEGER      ICOLR        OUT polyline colour index
REAL         COLR(3)      OUT colour values
INTEGER      METHOD       OUT polyline shading method
INTEGER      ATYPE        OUT curve approximation type
REAL         AVALUE       OUT curve approximation value

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE POLYLINE REPRESENTATION PLUS returns the attribute values of a specified entry in a workstation extended polyline bundle table. See SET POLYLINE REPRESENTATION PLUS 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 PLUS and is not part of the PHIGS standard.

C Input Parameters

ws

Workstation 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 PINQ_REALIZED, the representation for polyline index one is returned.

type

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

typedef enum {

PINQ_SET,

PINQ_REALIZED

} Pinq_type;

C Output Parameters

error_ind

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

rep

A pointer to a Pline_bundle_plus structure that returns the specified extended polyline representation. Pline_bundle_plus is defined as:

typedef struct {

Pint     type;          /* line type * /
Pfloat    width;         /* linewidth scale factor * /
Pgcolr   colr;          /* polyline colour * /
Pint     shad_meth;     /* polyline shading method * /
Pint     approx_type;   /* curve approximation type * /
Pfloat    approx_val;    /* curve approximation value * /

} Pline_bundle_plus;

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

FORTRAN Input Parameters

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

WKID

Workstation 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.

TYPE

An 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:

0   PSET      Set
1   PREALI    Realized

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:

0   PINDIR   Colour Index Specified
1   PRGB     Red, Green, and Blue
2   PCIE     CIE Colour Model
3   PHSV     Hue, Saturation, and Value
4   PHLS     Hue, 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, and so on

COLR(2) = Green, Saturation, Lightness, and so on

COLR(3) = Blue, Value, Saturation, and so on

METHOD

The polyline shading method.

ATYPE The curve approximation type.

AVALUE

The curve approximation value.

Execution

If the inquired information is available, then 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, then the representation for polyline index one is returned.

If the inquired information is not available, then the values returned in the output parameters are undefined, and the error indicator is set to one of the error numbers below 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

003

Ignoring function, function requires state (PHOP, WSOP, * ,* )

054

Ignoring function, the specified workstation is not open

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT, OUTIN, or MO)

100

Ignoring function, the bundle index value is less than one

101

Ignoring function, the specified representation has not been defined

SEE ALSO

SET POLYLINE REPRESENTATION PLUS (3PP)

INQUIRE POLYLINE REPRESENTATION (3P)

INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS (3PP)