.\"##
.\" $XConsortium: p223,v 5.3 94/04/17 20:57:01 hersh 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 VIEW REPRESENTATION" 3P "29 February 1991"
.SH NAME
INQUIRE VIEW REPRESENTATION \- inquire a view representation
on a workstation
.IX "Attribute Representations" "INQUIRE VIEW REPRESENTATION"
.IX "Viewing" "INQUIRE VIEW REPRESENTATION"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_view_rep ( ws, view_index, error_ind, update_state, cur_rep, req_rep )
Pint	ws;	\fIworkstation identifier\fP
Pint	view_index;	\fIview index\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pupd_st	*update_state;	\fIOUT transformation update state\fP
Pview_rep3	*cur_rep;	\fIOUT current view representation\fP
Pview_rep3	*req_rep;	\fIOUT requested view representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE VIEW REPRESENTATION\s+2 to obtain the current and requested
view representation in an entry of the specified workstation's view table.
.
.SS C Input Parameters
.IP \fIws\fP
The \fIworkstation identifier\fP of the workstation whose state list is queried.
.IP \fIview_index\fP
The view index whose representation is desired from
the workstation's table of defined 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 \fIupdate_state\fP
A pointer to a location in which the system returns the
\fIview transformation update state\fP.
Pupd_st is an enumerated type defined in phigs.h as follows:
.ta .5i +1.75i
.nf
.sp .4
typedef enum {
.sp .2
	PUPD_NOT_PEND,	/* Not Pending */
	PUPD_PEND	/* Pending */
.sp .2
} Pupd_st;
.fi
.IP \fIcur_rep\fP
A pointer to a Pview_rep3 structure in which the system returns the
definition of the \fIcurrent view representation\fP.
.IP \fIreq_rep\fP
A pointer to a Pview_rep3 structure in which the system returns the
definition of the \fIrequested view representation\fP.
.IP
Pview_rep3 is defined in phigs.h as follows:
.nf
.ta .5i +1.0i +1.0i
.sp .4
typedef struct {
.sp .2
        Pmatrix3	ori_matrix;	/* view orientation matrix */
        Pmatrix3	map_matrix;	/* mapping matrix */
        Plimit3	clip_limit;	/* clipping limits */
        Pclip_ind	xy_clip;	/* X-Y 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 .2
Pclip_ind is an enumerated type defined in phigs.h as follows:
.ta .5i +1.25i
.nf
.sp .4
typedef enum {
.sp .2
	PIND_CLIP,	/* Clipping */
	PIND_NO_CLIP	/* Not Clipping */
.sp .2
} Pclip_ind;
.fi
.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 003
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2WSOP\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 114
Ignoring function, the view index value is less than zero
.IP 101
Ignoring function, the specified representation has not been defined
.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE PREDEFINED VIEW REPRESENTATION (3P)"
.SM "SET VIEW INDEX (3P)"
.SM "SET VIEW REPRESENTATION 3 (3P)"
.SM "INQUIRE VIEW FACILITIES (3P)"
.fi