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

NAME

INQUIRE EXTENDED POLYMARKER REPRESENTATION − inquire an extended polymarker representation on a workstation

SYNOPSIS

C Syntax

void
pinqextmarkerrep ( wsid, index, type, error_ind, rep )
Pintwsid;workstation identifier
Pintindex;polymarker index
Pinqtypetype;type of returned value (PSET, PREALIZED)
Pint∗error_ind;OUT error indicator
Pextmkbundl∗rep;OUT extended marker representation

FORTRAN Syntax

SUBROUTINE pqepmr ( WKID, INDEX, ITYPE, ERRIND, MTYPE, MSIZE, COLMOD, IMCOLR, MCOLR )
INTEGERWKIDworkstation identifier
INTEGERINDEXpolymarker bundle index
INTEGERITYPEtype of returned values (PSET,PREALI)
INTEGERERRINDOUT error indicator
INTEGERMTYPEOUT polymarker type
REALMSIZEOUT polymarker size scale factor
INTEGERCOLMODOUT colour model
INTEGERIMCOLROUT indirect colour index
REALMCOLR(3)OUT direct colour value

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE EXTENDED POLYMARKER REPRESENTATION returns the attribute values of a specified entry in a workstation extended polymarker 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 polymarker bundle table. If this entry is not present in the table, and the type of returned value parameter is PREALIZED, the representation for polymarker 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 Pextmkbundl structure which returns the specified extended polymarker representation. Pextmkbundl is defined as:

typedef struct {
Pinttype;/∗ marker type ∗/
Pfloatsize;/∗ marker size scale factor ∗/
Pgcolrcolour;/∗ marker colour ∗/
} Pextmkbundl;

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

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

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

WKIDThe identifier of the workstation for which the polymarker representation is being inquired.

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

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

0PSETSet
1PREALIRealized

FORTRAN Output Parameters

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

MTYPE
The polymarker type.

MSIZE
The polymarker size 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

IMCOLR
An integer containing the index into the workstation colour table for the polymarker colour. This value is not used if COLMOD is greater than zero.

MCOLR(3)
An array of reals containing the polymarker colour. This array is unused if COLMOD is equal to zero (PINDIR).

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

Execution

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

If the specified polymarker index is not present in the polymarker bundle table on the workstation and the specified type of returned value is Realized, the representation for polymarker 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 following 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

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