NAME

INQUIRE PREDEFINED VIEW REPRESENTATION − inquire a predefined view representation for a workstation type

SYNOPSIS

C Syntax

void
pinq_pred_view_rep ( type, index, error_ind, rep )
Pinttype;workstation type
Pintindex;predefined view index
Pint∗error_ind;OUT error indicator
Pview_rep3∗rep;OUT view representation

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED VIEW REPRESENTATION determines the predefined view representation for a specified workstation type at a given view index. 

C Input Parameters

type
Type of workstation.

index
Entry to be returned from the workstation table of predefined view representations.

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 Pview_rep3 structure in which the system returns the view representation at index in the workstation table of predefined view representations. Pview_rep3 is defined in phigs.h as follows:

typedef struct {
Pmatrix3ori_matrix;/∗ orientation matrix ∗/
Pmatrix3map_matrix;/∗ mapping matrix ∗/
Plimit3clip_limit;/∗ clipping limits ∗/
Pclip_indxy_clip;/∗ x-y clipping indicator ∗/
Pclip_indback_clip;/∗ back clipping indicator ∗/
Pclip_indfront_clip;/∗ front clipping indicator ∗/
} Pview_rep3;

The Pmatrix3 type definition is a 4x4 matrix, defined in phigs.h as: typedefPfloatPmatrix3[4][4]; The Plimit3 structure used to define the clipping limits is defined in phigs.h as follows:

typedef struct {
Pfloatx_min;/∗ x min ∗/
Pfloatx_max;/∗ x max ∗/
Pfloaty_min;/∗ y min ∗/
Pfloaty_max;/∗ y max ∗/
Pfloatz_min;/∗ z min ∗/
Pfloatz_max;/∗ z max ∗/
} Plimit3;

The clipping indicators control whether the clipping limits for the associated plane are active or inactive. Valid values for the Pclip enumerated type are defined in phigs.h as:

typedef enum {
PIND_NO_CLIP, /∗ Do Not Clip ∗/
PIND_CLIP/∗ Perform Clipping ∗/
} Pclip_ind;

Execution

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

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 below 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

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

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

052Ignoring function, workstation type not recognized by the implementation

057Ignoring function, specified workstation is of category MI

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

101Ignoring function, the specified representation has not been defined

114Ignoring function, the view index value is less than zero

SEE ALSO

INQUIRE VIEW FACILITIES (3P)
SET VIEW REPRESENTATION 3 (3P)
INQUIRE VIEW REPRESENTATION (3P)

September 02, 1992