NAME

INQUIRE POLYLINE FACILITIES PLUS - inquire for workstation type extended polyline facilities

SYNOPSIS

C Syntax

void

pinq_line_facs_plus ( type, lt_length, lt_start, sm_length, sm_start, error_ind, tot_lt_length, tot_sm_length, facilities )

Pint              type;              workstation type
Pint              lt_length;         number of line types to return
Pint              lt_start;          starting position
Pint              sm_length;         number of shading methods to return
Pint              sm_start;          starting position
Pint              * error_ind;       OUT error indicator
Pint              * tot_lt_length;   OUT length of line type list in PHIGS
Pint              * tot_sm_length;   OUT length of shading method list in PHIGS
Pline_facs_plus   * facilities;      OUT extended polyline facilities

FORTRAN Syntax

SUBROUTINE pqeplf ( WKTYPE, ILT, ISM, ERRIND, NLT, LT, NLW, NOMLW, MINLW, MAXLW,NSM, SM, NPPLI )

INTEGER      WKTYPE               workstation type
INTEGER      ILT                  index into linetype list
INTEGER      ISM                  index into shading method list
INTEGER      ERRIND               OUT error indicator
INTEGER      NLT                  OUT number of available linetypes
INTEGER      LT                   OUT ILT entry from linetype list
INTEGER      NLW                  OUT number of available linewidths
REAL         NOMLW                OUT nominal linewidth (DC)
REAL         MINLW, MAXLW         OUT range of linewidths (DC)
INTEGER      NSM                  OUT number of available shading methods
INTEGER      SM                   OUT ISM entry from shading methods list
INTEGER      NPPLI                OUT number of predefined polyline indices

Required PHIGS Operating States

(PHOP, * ,* ,* )

DESCRIPTION

Purpose

INQUIRE POLYLINE FACILITIES PLUS returns the extended polyline support available from 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

Get the polyline facilities for this workstation type.

lt_length

The number of ints in the facilities.types.ints output parameter for which the

application has allocated memory. length is the number of list elements that the system can return in facilities.types.ints . If a value of 0 is used here, then no data is returned in the facilities.types.ints list, but the total number of elements is returned in tot_lt_length.

lt_start Starting position of inquiry. The elements in the list, beginning with the item

number specified by start, are copied sequentially into facilities.types.ints until facilities.types.ints is full or all the elements have been copied.

sm_length

The number of ints in the facilities.shads.ints output parameter for which the application has allocated memory. length is the number of list elements that the system can return in facilities.shads.ints. If a value of 0 is used here, then no data is returned in the facilities.shads.ints list, but the total number of elements is returned in tot_sm_length.

sm_start

Starting position of inquiry. The elements in the list, beginning with the item number specified by sm_start, are copied sequentially into facilities.shads.ints until facilities.shads.ints is full or all the elements have been copied.

C Output Parameters

error_ind

A pointer to the location to store the error number of any error detected by this function.

tot_lt_length

A pointer to an integer in which to return the total length of the line type list. This is the value required for lt_length if all the items in the list are to be returned.

tot_sm_length

A pointer to an integer in which to return the total length of the shading method list. This is the value required for sm_length if all the items in the list are to be returned.

facilities

A pointer to a structure in which the system returns the portion of the list of polyline facilities from the workstation description table, starting with start. Pline_facs_plus is defined in phigs.h as:

typedef struct {

Pint_list types;             /* list of line types * /
Pint      widths;            /* number of available line widths * /
Pint      num_widths;        /* number of available line widths * /
Pfloat     nom_width;         /* nominal line width * /
Pfloat     min_width;         /* minimum line width * /
Pfloat     max_width;         /* maximum line width * /
Pint      num_pred_inds;     /* number of predefined bundles * /
Pint_list shads;             /* list of shading methods * /

} Pline_facs_plus;

And Pint_list is defined in phigs.h as:

typedef struct {

        Pint            num_ints;       /* number of integers * /
        Pint            * ints;         /* list of integers * /
} Pint_list;

Prior to calling this function, the ints field of the Pint_list structure must contain a pointer to an application-supplied buffer. This buffer must be at least as large as the corresponding length parameter.

FORTRAN Input Parameters

WKTYPE

The workstation type.

ILT

The index of the entry desired from the list of available linetypes.

ISM

The index of the entry desired from the list of available shading methods.

FORTRAN Output Parameters

ERRIND

The error number of any error detected by this function.

NLT

The number of entries in the list of available linetypes.

LT

The requested entry of the available linetype list.

NLW

The number of available linewidths.

NOMLW

The nominal linewidth in Device Coordinates (DC).

MINLW The minimum linewidth in DC.

MAXLW

The maximum linewidth in DC.

NSM

The number of entries in the list of available shading methods.

SM

The requested entry of the available shading method list. Defined shading methods are:

1   PSDNON     No Shading
2   PSDCOL     Colour Interpolation Shading

NPPLI

The number of predefined polyline indices.

Execution

If the inquired information is available, 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, * ,* ,* )

052

Ignoring function, workstation type not recognized by the implementation

051

Ignoring function, this information is not yet available for this workstation type; open a workstation of this type and use the specific workstation type

062

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

SEE ALSO

SET POLYLINE REPRESENTATION PLUS (3PP)

INQUIRE POLYLINE REPRESENTATION PLUS (3PP)

INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS (3PP)