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

NAME

INQUIRE PREDEFINED EXTENDED EDGE REPRESENTATION − inquire a predefined extended edge representation for a specified workstation type

SYNOPSIS

C Syntax

void
pinqpredextedgerep ( wstype, index, error_ind, bundle )
Pwstypewstype;workstation type
Pintindex;predefined edge index
Pint∗error_ind;OUT error indicator
Pextedgebundl∗bundle;OUT predefined extended edge representation

FORTRAN Syntax

SUBROUTINE pqpeer ( WKTYPE, INDEX, ERRIND, EFLAG, ETYPE, EWIDTH, COLMOD,
IECOLR, ECOLR )
INTEGERWKTYPEworkstation type
INTEGERINDEXpredefined edge index
INTEGERERRINDOUT error indicator
INTEGEREFLAGOUT edge flag (PON/POFF)
INTEGERETYPEOUT edge type
REALEWIDTHOUT edge width scale factor
INTEGERCOLMODOUT colour model
INTEGERIECOLROUT indirect colour
REALECOLR(3)OUT array of colour

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED EXTENDED EDGE REPRESENTATION inquires a predefined extended edge representation for a specified workstation type.

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.

wstypeThe workstation type.

indexThe index of the 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 Pextedgebundl structure which returns the requested representation. Pextedgebundl is defined as:

typedef struct {
Pedgefflag;/∗ edge flag ∗/
Pinttype;/∗ edgetype ∗/
Pfloatscale;/∗ edgewidth scale factor ∗/
Pgcolrcolour;/∗ edge colour ∗/
} Pextedgebundl;

Valid values for the Pedgef enumerated type are defined in phigs.h as:

typedef enum {
PEDGE_OFF,
PEDGE_ON
} Pedgef;

Pgcolr is defined as:

typedef struct {
Pint type;/∗ indirect, RGB, CIE, HSV, HLS ∗/
union {
   Pintindex;/∗ colour table index ∗/
   struct {
Pfloatx;/∗ red, hue, etc. ∗/
Pfloaty;/∗ green, saturation, lightness, etc. ∗/
Pfloatz;/∗ blue, value, saturation, etc. ∗/
   } general;
} val;
} Pgcolr;

FORTRAN Input Parameters

WKTYPE
The workstation type.

INDEX
Index of the predefined entry to be returned.

FORTRAN Output Parameters

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

EFLAG
The edge flag.

ETYPE
The edge type.

EWIDTH
The edge width scale factor.

COLMOD
The colour model that determines the type of colour to be used.

IECOLR
An integer containing the index into the workstation colour table for the edge colour.

ECOLR(3)
An array of reals containing the edge colour.

Execution

If the inquired information is available, the error indicator is returned as zero and values are 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