NAME

INQUIRE PREDEFINED EDGE REPRESENTATION PLUS - inquire for predefined extended edge representation for specified workstation type

SYNOPSIS

C Syntax

void

pinq_pred_edge_rep_plus ( type, index, error_ind, bundle )

Pint                  type;          workstation type
Pint                  index;         predefined index
Pint                  * error_ind;   OUT error indicator
Pedge_bundle_plus     * bundle;      OUT predefined edge representation

FORTRAN Syntax

SUBROUTINE pqpeer ( WKTYPE, INDEX, ERRIND, EFLAG, ETYPE, EWIDTH, COLTYPE, IECOLR, ECOLR )

INTEGER      WKTYPE       workstation type
INTEGER      INDEX        predefined edge index
INTEGER      ERRIND       OUT error indicator
INTEGER      EFLAG        OUT edge flag (PON/POFF)
INTEGER      ETYPE        OUT edge type
REAL         EWIDTH       OUT edge width scale factor
INTEGER      COLTYPE      OUT colour type
INTEGER      IECOLR       OUT indirect colour
REAL         ECOLR(3)     OUT array of colour

Required PHIGS Operating States

(PHOP, * ,* ,* )

DESCRIPTION

Purpose

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

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

The 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 Pedge_bundle_plus structure that returns the requested representation. Pedge_bundle_plus is defined as:

typedef struct {

Pedge_flag

flag;

/* edge flag * /

Pint                type;           /* edgetype * /
Pfloat               scale;          /* edgewidth scale factor * /
Pgcolr              colr;           /* edge colour * /

} Pedge_bundle_plus;

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

typedef enum {

PEDGE_OFF,

PEDGE_ON

} Pedge_flag;

Pgcolr is defined as:

typedef struct {

Pinttype;

/* 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;

Constants defined for colour type are:

0   PINDIRECT         Indirect
1   PMODEL_RGB        Red, Green, Blue
2   PMODEL_CIELUV     CIE
3   PMODEL_HSV        Hue, Saturation, Value
4   PMODEL_HLS        Hue, Lightness, Saturation

The index member of the val union is used for type PINDIRECT. The general member is used for the other types.

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 that this function detects.

EFLAG The edge flag.

ETYPE The edge type.

EWIDTH

The edge width scale factor.

COLTYPE

The colour type.

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, then the error indicator is returned as zero, and values are 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 EDGE REPRESENTATION PLUS (3PP)

INQUIRE EDGE REPRESENTATION PLUS (3PP)

INQUIRE PREDEFINED EDGE REPRESENTATION (3P)