.\"##
.\" $XConsortium: p331,v 5.2 94/04/17 20:58:16 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.
.ds f \s-2SET INTERIOR REPRESENTATION PLUS\s+2
.TH "SET INTERIOR REPRESENTATION PLUS" 3P+ "29 February 1991"
.SH NAME
SET INTERIOR REPRESENTATION PLUS \- set an extended interior attribute
bundle on a workstation
.IX "PHIGS Extension Functions" "SET INTERIOR REPRESENTATION PLUS"
.IX "Attribute Representations" "SET INTERIOR REPRESENTATION PLUS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_int_rep_plus ( wsid, index, rep )
Pint	wsid;	\fIworkstation id\fP
Pint	index;	\fIinterior index\fP
Pint_bundle_plus	*rep;	\fIrepresentation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET INTERIOR REPRESENTATION PLUS\s+2 
sets a bundle table entry 
in the workstation extended interior bundle
table.
.SS C Input Parameters
.IP \fIwsid\fP
The identifier of the workstation for which the representation is being set.
.IP \fIindex\fP
The index of the entry being set.
.IP \fIrep\fP
A pointer to a Pint_bundle_plus structure containing the extended interior
attributes.
Pint_bundle_plus is defined as:
.nf
.ta .5i +1.25i   +1.25i  +1.25i
.sp .4
typedef struct {
.sp .2
	Pint_style	style;	/* interior style */
	Pint	style_ind;	/* interior style index */
	Pgcolr	colr;	/* interior colour */
	Pint	refl_eqn;	/* reflectance equation */
	Pint	shad_meth;	/* shading method */
	Prefl_props	refl_props;	/* area properties */
	Pint_style	back_style;	/* interior style */
	Pint	back_style_ind;	/* interior style index */
	Pgcolr	back_colr;	/* interior colour */
	Pint	back_refl_eqn;	/* back reflectance equation */
	Pint	back_shad_meth;	/* back shading method */
	Prefl_props	back_refl_props;	/* back area properties */
	Pint	approx_type;	/* approximation method */
	Pfloat	approx_val[2];	/* approximation values, u and v */
.sp .2
} Pint_bundle_plus;
.fi
.IP
Pint_style is defined as:
.ta .5i
.nf
.sp .4
typedef enum {
.sp .2
	PSTYLE_HOLLOW,
	PSTYLE_SOLID,
	PSTYLE_PAT,
	PSTYLE_HATCH,
	PSTYLE_EMPTY
.sp .2
} Pint_style;
.fi
.IP
See \s-2SET INTERIOR STYLE\s+2 for a description of each style.
.bp
.IP
Pgcolr is defined as:
.ta .5i +1.5i   +1i  +2i
.nf
.sp .4
typedef struct {
.sp .2
	Pint	type;	/* indirect, RGB, CIE, HSV, HLS */
	union {
	     Pint	ind;	/* index in workstation colour bundle table */
	     struct {
	          Pfloat	x;	/* red, hue, etc. */
	          Pfloat	y;	/* green, saturation, lightness, etc. */
	          Pfloat	z;	/* blue, value, saturation, etc. */
	     } general;
	} val;
} Pgcolr;
.fi
.IP
Prefl_props is defined as:
.nf
.ta .5i +1i  +1.25i  +1.5i
.sp .4
typedef struct {
.sp .2
	Pfloat	ambient_coef;	/* ambient reflectance coefficient */
	Pfloat	diffuse_coef;	/* diffuse reflectance coefficient */
	Pfloat	specular_coef;	/* specular reflectance coefficient */
	Pgcolr	specular_colr;	/* specular colour */
	Pfloat	specular_exp;	/* specular exponent */
	Pfloat	transpar_coef;	/* transparency coefficient */
.sp .2
} Prefl_props;
.fi
.sp
The values for ambient, diffuse, specular,
and transparency coefficients must all be in the range [0,1].
The specular exponent must be greater than zero.
.sp
Constants defined for colour type are:
.sp
.nf
.ta .5i +\w'0     'u +\w'PMODEL_CIELUV      'u
0	PINDIRECT	\fIIndirect\fP
1	PMODEL_RGB	\fIRed, Green, Blue\fP
2	PMODEL_CIELUV	\fICIE\fP
3	PMODEL_HSV	\fIHue, Saturation, Value\fP
4	PMODEL_HLS	\fIHue, Lightness, Saturation\fP
.\" .IP
.fi
.sp
The index member of the val union is used for 
type \s-2PINDIRECT\s+2.
The general member is used for the other types.
.sp
Predefined reflectance equation values are:
.sp
.nf
.ta .5i +\w'0     'u +\w'PREFL_AMB_DIFF_SPEC     'u
1	PREFL_NONE	\fINo Reflectance Calculation Performed\fP
2	PREFL_AMBIENT	\fIUse Ambient Term\fP
3	PREFL_AMB_DIFF	\fIUse Ambient and Diffuse Terms\fP
4	PREFL_AMB_DIFF_SPEC	\fIUse Ambient, Diffuse, and Specular Terms\fP
.fi
.sp
Predefined constants for interior shading method are:
.sp
.nf
.ta .5i +\w'0     'u +\w'PSD_DOT_PRODUCT     'u
1	PSD_NONE	\fINo Shading\fP
2	PSD_COLOUR	\fIColour Interpolation Shading\fP
3	PSD_DOT_PRODUCT	\fIDot Product Interpolation Shading\fP
4	PSD_NORMAL	\fINormal Interpolation Shading\fP
.fi
.IP
Constants defined for surface approximation type are:
.sp
.nf
.ta .5i
1	PSURF_WS_DEP
2	PSURF_CONSTANT_PARAMETRIC_BETWEEN_KNOTS
3	PSURF_CHORDAL_SIZE_WC
4	PSURF_CHORDAL_SIZE_NPC
5	PSURF_CHORDAL_SIZE_DC
6	PSURF_PLANAR_DEVIATION_WC
7	PSURF_PLANAR_DEVIATION_NPC
8	PSURF_PLANAR_DEVIATION_DC
.fi
.sp
See \s-2SET SURFACE APPROXIMATION CRITERIA\s+2
for a description of these constants.
.SS Execution
.LP
The extended interior bundle table contains bundled entries of the
\s-2PHIGS\s+2 and \s-2PHIGS PLUS\s+2 
interior attributes.  
\s-2SET INTERIOR REPRESENTATION PLUS\s+2
sets the individual
entries of this table.  During traversal, the attribute values of these
bundles are used when the corresponding aspect source flag in the
workstation state list is set to \s-2BUNDLED\s+2.
.LP
The
\s-2PHIGS\s+2
interior bundle table is a portion of the extended
table.  The function
\s-2SET INTERIOR REPRESENTATION\s+2
sets the following
attributes in the extended table:
interior style, interior style index, and colour index
(colour type of \fIIndirect\fP is assumed).
.LP
During structure traversal the current interior index refers to an entry
in the workstation extended interior bundle table.  Depending on the
settings of the aspect source flags, the contents of that bundle table
entry are used to determine the attributes associated with output primitives
that use the extended interior bundle table.
.SH ERRORS
.IP 003
Ignoring function, function requires state (\s-2PHOP, WSOP, *, *\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 059
Ignoring function, the specified workstation does not have output capability
(that is, the workstation category is neither \s-2OUTPUT\s+2,
\s-2OUTIN\s+2, nor \s-2MO\s+2)
.IP 100
Ignoring function, the bundle index value is less than one
.IP 103
Ignoring function, setting this bundle table entry would exceed the 
maximum number of entries allowed in the workstation bundle table
.IP 108
Ignoring function, the specified interior style is not available on the
workstation
.IP 110
Ignoring function, the specified colour model is not available on the workstation
.IP 112
Ignoring function, the pattern index value is less than one
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET INDIVIDUAL ASF (3P)"
.SM "INQUIRE INTERIOR FACILITIES PLUS (3P+)"
.SM "INQUIRE INTERIOR REPRESENTATION PLUS (3P+)"
.SM "SET TRIMMING CURVE APPROXIMATION CRITERIA (3P+)"
.SM "SET INTERIOR STYLE INDEX (3P)"
.SM "SET INTERIOR REPRESENTATION (3P)"
.fi
