.\"##
.\" $XConsortium: p204,v 5.2 94/04/17 20:56:48 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "INQUIRE PREDEFINED VIEW REPRESENTATION" 3P "29 February 1991"
.SH NAME
INQUIRE PREDEFINED VIEW REPRESENTATION \- inquire a predefined view representation for a workstation type
.IX "INQUIRE PREDEFINED VIEW REPRESENTATION" "" "" "" PRINT "See \fIWorkstation Transformation\fP"
.IX "Viewing" "INQUIRE PREDEFINED VIEW REPRESENTATION"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_pred_view_rep ( type, index, error_ind, rep )
Pint	type;	\fIworkstation type\fP
Pint	index;	\fIpredefined view index\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pview_rep3	*rep;	\fIOUT view representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE PREDEFINED VIEW REPRESENTATION\s+2 determines
the predefined view representation for a specified workstation type
at a given view index.
.
.SS C Input Parameters
.IP \fItype \fP
Type of workstation.
.IP \fIindex \fP
Entry to be returned from the workstation table of predefined view 
representations.
.
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error
detected by this function.
.IP \fIrep\fP
A pointer to a Pview_rep3 structure in which the system returns the view representation at \fIindex\fP in the workstation table of predefined view representations. Pview_rep3 is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pclip_ind     'u +\w'map_matrix;	'u
.sp .4
typedef struct {
.sp .2
	Pmatrix3	ori_matrix;	/* orientation matrix */
	Pmatrix3	map_matrix;	/* mapping matrix */
	Plimit3	clip_limit;	/* clipping limits */
	Pclip_ind	xy_clip;	/* \fIx-y\fP clipping indicator */
	Pclip_ind	back_clip;	/* back clipping indicator */
	Pclip_ind	front_clip;	/* front clipping indicator */
.sp .2
} Pview_rep3; 
.fi
.sp
The Pmatrix3 type definition is a 4x4 matrix, defined in phigs.h as:
.sp
typedef	Pfloat	Pmatrix3[4][4];
.sp
The Plimit3 structure used to define the clipping limits
is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pfloat     'u +\w'x_max;     'u
.sp .4
typedef struct {
.sp .2
	Pfloat	x_min;	/* x min */
	Pfloat	x_max;	/* x max */
	Pfloat	y_min;	/* y min */
	Pfloat	y_max;	/* y max */
	Pfloat	z_min;	/* z min */
	Pfloat	z_max;	/* z max */
.sp .2
} Plimit3;
.fi
.sp
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:
.nf
.ta .5i +1.25i
.sp .4
typedef enum {
.sp .2
	PIND_NO_CLIP,	/* Do Not Clip */
	PIND_CLIP	/* Perform Clipping */
.sp .2
} Pclip_ind;
.fi
.sp
.
.SS Execution
.LP
If the inquired information is available, the error indicator is returned
as zero and values are returned in the output parameters.
.LP
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.
.LP
Since this is an inquiry function, \s-2ERROR HANDLING\s+2 is not invoked
when an error is detected by this function.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP\s+2, *, *, *)
.IP 051
Ignoring function, this information is
not yet available for this generic
workstation type; open a workstation of
this type and use the specific
workstation type
.IP 052
Ignoring function, workstation type not recognized by the implementation
.IP 057
Ignoring function, specified workstation is of category \s-2MI\s+2
.IP 062
Ignoring function, this information is not available for this
\s-2MO\s+2 workstation type
.IP 101
Ignoring function, the specified representation has not been defined
.IP 114
Ignoring function, the view index value is less than zero
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE VIEW FACILITIES (3P)"
.SM "SET VIEW REPRESENTATION 3 (3P)"
.SM "INQUIRE VIEW REPRESENTATION (3P)"
.fi
