.\"##
.\" $XConsortium: p311,v 5.2 94/04/17 20:58:03 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.
.\" 1. Substitute PHIGS Extension function name (in CAPS) for "PNAME" in line .\"below:
.ds pN SET EDGE REPRESENTATION PLUS
.TH "\*(pN" 3P+ "29 February 1991"
.SH NAME
\*(pN \-
set an extended edge attribute bundle on a workstation
.IX "PHIGS Extension Functions" "\*(pN"
.IX "Attribute Representations" "SET EDGE REPRESENTATION PLUS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
.\" 6. Insert C syntax below
void
pset_edge_rep_plus ( ws, index, rep )
Pint	ws;	\fIworkstation identifier\fP
Pint	index;	\fIedge bundle index number\fP
Pedge_bundle_plus	*rep;	\fIedge representation pointer\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET EDGE REPRESENTATION PLUS\s+2 sets an extended edge 
attribute bundle on a workstation.
.SS C Input Parameters
.IP \fIws\fP
The identifier of the workstation.
.IP \fIindex\fP
This is an index to the workstation edge bundle table.
.IP \fIrep\fP
A pointer to a Pedge_bundle_plus structure. Pedge_bundle_plus is defined as:
.sp .2
.nf
.ta .5i +1.25i  +1i  +1.25i
.sp .2
typedef struct {
.sp .2
	Pedge_flag	flag;	/* edge flag */
	Pint	type;	/* edgetype */
	Pfloat	width;	/* edgewidth scale factor */
	Pgcolr	colr;	/* edge colour */
.sp .2
} Pedge_bundle_plus;
.fi
.IP
Pedge_flag is defined as:
.nf
.ta .5i 
.sp .2
typedef enum {
.sp .2
	PEDGE_OFF,
	PEDGE_ON
.sp .2
} Pedge_flag;
.nf
.sp
The edge type values are:
.ta .5i +\w'-1     'u +\w'PLINE_DOT_DASHDOT     'u
.nf
.sp .2
1	PLINE_SOLID	\fISolid\fP
2	PLINE_DASH	\fIDashed\fP
3	PLINE_DOT 	\fIDotted\fP
4	PLINE_DOT_DASH	\fIDot-dashed\fP
.fi
.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
.SS Execution
In the edge bundle table of the workstation state list, the given
index is associated with the specified parameters.
.LP
The edgewidth scale factor is a scale factor applied to nominal edgewidth.
During structure traversal, the edgewidth scale factor is multiplied
by the nominal edgewidth on a workstation. The result is mapped by the
workstation to the nearest available edgewidth.
.LP
Edge colour is a general colour, either an indirect or a
direct colour in a specified colour model. If an indirect colour is
specified and the specified colour index is not available during
structure traversal, then colour index one is used.
.LP
The extended edge bundle table in the workstation state list has
predefined entries taken from the workstation description table. A
number of these entries are predefined for every workstation of category
\s-2OUTPUT\s+2 or \s-2OUTIN\s+2. Any table entry, including the predefined
entries, may be redefined with this function.
.LP
When area defining primitives are displayed during structure traversal,
the current edge index in the \s-2PHIGS\s+2 traversal state list
refers to an entry in the extended edge bundle table. If the
current edge index is not present in the extended edge
bundle table, then edge index one is used. The setting of the 
corresponding Aspect Source Flags(\s-2ASF\s+2s) determines which 
aspects in the entry are used.
.RE
.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 107
Ignoring function, the specified edgetype is not available on the
specified workstation
.IP 110
Ignoring function, the specified colour model is not available on the 
workstation
.IP 113
Ignoring function, the colour index value is less than zero
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET INDIVIDUAL ASF (3P)"
.SM "INQUIRE EDGE REPRESENTATION PLUS (3P+)"
.SM "SET EDGE REPRESENTATION (3P)"
.fi
