NAME

INQUIRE POLYMARKER REPRESENTATION PLUS - inquire for extended polymarker representation on workstation

SYNOPSIS

C Syntax

void

pinq_marker_rep_plus ( wsid, index, type, error_ind, rep )

Pint                     wsid;         workstation identifier
Pint                     index;        polymarker index
Pinq_type                type;         type of returned value
Pint                     * error_ind;  OUT error indicator
Pmarker_bundle_plus      * rep;        OUT polymarker representation

FORTRAN Syntax

SUBROUTINE pqepmr ( WKID, INDEX, ITYPE, ERRIND, MTYPE, MSIZE, COLMOD, IMCOLR, MCOLR )

INTEGER      WKID          workstation identifier
INTEGER      INDEX         polymarker bundle index
INTEGER      ITYPE         type of returned values (PSET, PREALI )
INTEGER      ERRIND        OUT error indicator
INTEGER      MTYPE         OUT polymarker type
REAL         MSIZE         OUT polymarker size scale factor
INTEGER      COLMOD        OUT colour model
INTEGER      IMCOLR        OUT indirect colour index
REAL         MCOLR(3)      OUT direct colour value

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE POLYMARKER REPRESENTATION PLUS returns the attribute values of a specified entry in a workstation extended polymarker bundle table.

This is a SunPHIGS Extension function based on PHIGS PLUS and is not part of the PHIGS standard.

C Input Parameters

wsid

Workstation identifier.

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 PINQ_REALIZED, then the representation for polymarker 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 that this function detects.

rep

A pointer to a Pmarker_bundle_plus structure, which returns the specified extended polymarker representation. Pmarker_bundle_plus is defined as:

typedef struct {

Pint     type;    /* marker type * /
Pfloat    size;    /* marker size scale factor * /
Pgcolr   colr;    /* marker colour * /

} Pmarker_bundle_plus;

Pgcolr is defined as:

typedef struct {

Pint

type;

/* indirect, RGB, CIE, HSV, HLS * /

union {

Pint ind;

/* index in workstation colour bundle table * /

struct {

         Pfloat     x;      /* red, hue, and so on * /
         Pfloat     y;      /* green, saturation, lightness, and so on * /
         Pfloat     z;      /* blue, value, saturation, and so on * /
      } general;
    } val;
} Pgcolr;

FORTRAN Input Parameters

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

WKID

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

0   PSET      Set
1   PREALI    Realized

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:

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

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, and so on

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

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

Execution

If the inquired information is available, then 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, then the representation for polymarker 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 this function detects an error.

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 POLYMARKER REPRESENTATION PLUS (3PP)

INQUIRE POLYMARKER REPRESENTATION (3P)

INQUIRE PREDEFINED POLYMARKER REPRESENTATION PLUS (3PP)