NAME

INQUIRE INTERIOR FACILITIES PLUS - inquire for extended interior facilities of specified workstation type

SYNOPSIS

C Syntax

void

pinq_int_facs_plus ( type, is_length, is_start, hs_length, hs_start, re_length, re_start, sh_length, sh_start, error_ind, facil, tot_is_length, tot_hs_length, tot_re_length, tot_sh_length )

Pint             type;             workstation type
Pint             is_length;        length of application's interior style list
Pint             is_start;         starting position
Pint             hs_length;        length of application's hatch style list
Pint             hs_start;         starting position
Pint             re_length;        length of application's reflectance equation list
Pint             re_start;         starting position
Pint             sh_length;        length of application's shading method list
Pint             sh_start;         starting position
Pint             * error_ind;      OUT error indicator
Pint_facs_plus   * facil;          OUT extended interior facilities
Pint             * tot_is_length;  OUT total length of interior styles list
Pint             * tot_hs_length;  OUT total length of hatch styles list
Pint             * tot_re_length;  OUT total length of reflectance equation list
Pint             * tot_sh_length;  OUT total length of shading method list

FORTRAN Syntax

SUBROUTINE pqeif ( WKTYPE, ISTYLE, IHATCH, IREFEQ, ISHADE, ERRIND, NSTYLE, STYLE, NHATCH, HATCH, NREFEQ, REFEQ, NSHADE, SHADE, NPRE )

INTEGER      WKTYPE       workstation type
INTEGER      ISTYLE       list element of interior styles to return
INTEGER      IHATCH       list element of hatch styles to return
INTEGER      IREFEQ       list element of reflectance equation
INTEGER      ISHADE       list element of shading method to return
INTEGER      ERRIND       OUT error indicator
INTEGER      NSTYLE       OUT number of available interior styles
INTEGER      STYLE        OUT ISTYLE-th element of list of available interior styles
INTEGER      NHATCH       OUT number of available hatch styles
INTEGER      HATCH        OUT IHATCH-th element of list of available hatch style indices
INTEGER      NREFEQ       OUT number of available reflectance eqns
INTEGER      REFEQ        OUT IREFEQ-th element of list of available reflectance equations
INTEGER      NSHADE       OUT number of available shading methods
INTEGER      SHADE        OUT ISHADE-th element of list of available shading methods
INTEGER      NPRE         OUT number of predefined interior indices

Required PHIGS Operating States

(PHOP, * ,* ,* )

DESCRIPTION

Purpose

INQUIRE INTERIOR FACILITIES PLUS returns the extended interior 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

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

type

The workstation type in question.

is_length

The number of entries to return from the list of interior styles.

is_start Starting position of the portion of the list to return.

hs_length

The number of entries to return from the list of hatch styles.

hs_start Starting position of the portion of the list to return.

re_length

The number of entries to return from the list of reflectance equations.

re_start Starting position of the portion of the list to return.

sh_length

The number of entries to return from the list of interior shading method.

sh_start Starting position of the portion of the list to return.

C Output Parameters

error_ind

A pointer to the location in which to store the error number of any error that this function detects.

facil

A pointer to a Pint_facs_plus structure, which returns the requested information. Pint_facs_plus is defined in phigs.h as follows:

typedef struct {

Pint        num_int_styles;   /* number of interior styles * /
Pint_style  * int_styles;     /* list of available interior
                                  styles * /
Pint_list   hatch_styles;     /* list of available hatch styles * /
Pint        num_pred_inds; /* number of predefined interior
                                  indices * /
Pint_list   refl_eqns;         /* list of available reflectance
                                  equations * /
Pint_list   shad_meths;       /* list of available shading
                                  methods * /

} Pint_facs_plus;

Pint_style is defined in phigs.h as follows:

typedef enum {

PSTYLE_HOLLOW,

PSTYLE_SOLID,

PSTYLE_PAT,

PSTYLE_HATCH,

PSTYLE_EMPTY,

} Pint_style;

Pint_list is defined in phigs.h as follows:

typedef struct {

Pint  num_ints;    /* number of Pints in list * /
Pint  * ints;      /* list of integers * /

} Pint_list;

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

tot_is_length

A pointer to the location to store the total length of the interior style list in the workstation description table.

tot_hs_length

A pointer to the location to store the total length of the hatch style list in the workstation description table.

tot_re_length

A pointer to the location to store the total length of the reflectance equation list in the workstation description table.

tot_sh_length

A pointer to the location to store the total length of the interior shading method list in the workstation description table.

FORTRAN Input Parameters

WKTYPE

The workstation type in question.

ISTYLE The index of the entry desired from the interior style list.

IHATCH

The index of the entry desired from the hatch style list.

IREFEQ

The index of the entry desired from the reflectance equation list.

ISHADE

The index of the entry desired from the interior shading method list.

FORTRAN Output Parameters

ERRIND

The error number of any error detected by this function.

NSTYLE

The number of entries in the list of available interior styles.

STYLE

The requested entry of the interior style list.

NHATCH

The number of entries in the list of available hatch styles.

HATCH The requested entry of the hatch style list.

NREFEQ

The number of entries in the list of available reflectance equations.

REFEQ The requested entry of the reflectance equation list.

NSHADE

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

SHADE The requested entry of the interior shading method list.

NPRE

The number of predefined extended interior bundle table entries.

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

INQUIRE INTERIOR REPRESENTATION PLUS (3PP)

INQUIRE PREDEFINED INTERIOR REPRESENTATION PLUS (3PP)