NAME

INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS - inquire for predefined extended polyline representation from specified workstation type

SYNOPSIS

C Syntax

void

pinq_pred_line_rep_plus ( type, index, error_ind, bundle )

Pint                 type;         workstation type
Pint                 index;        predefined index
Pint                 * error_ind;  OUT error indicator
Pline_bundle_plus    * bundle;     OUT predefined polyline representation

FORTRAN Syntax

SUBROUTINE pqpepr ( WKTYPE, INDEX, ERRIND, LTYPE, LWIDTH, COLMOD, ICOLR, COLR, METHOD, ATYPE, AVALUE )

INTEGER      WKTYPE       workstation type
INTEGER      INDEX        predefined polyline index
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, * ,* ,* )

DESCRIPTION

Purpose

INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS 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 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

type

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.

bundle

A pointer to a Pline_bundle_plus structure that returns the requested 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 criteria * /
Pfloat    approx_val;    /* curve approximation criteria * /

} Pline_bundle_plus;

See SET POLYLINE REPRESENTATION PLUS 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 POLYLINE REPRESENTATION PLUS 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:

0   PINDIR   Indirect
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 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, 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 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 this function detects an error.

ERRORS

002

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

051

Ignoring function, this information unavailable for this workstation type

052

Ignoring function, workstation type not recognized by the implementation

062

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

100

Ignoring function, the bundle index value is less than one

102

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

SEE ALSO

SET POLYLINE REPRESENTATION PLUS (3PP)

INQUIRE POLYLINE REPRESENTATION PLUS (3PP)

INQUIRE PREDEFINED POLYLINE REPRESENTATION (3P)