.\"##
.\" $XConsortium: p309,v 5.2 94/04/17 20:58:01 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 "SET EDGE INDEX" 3P "29 February 1991"
.SH NAME
SET EDGE INDEX \- create a structure element containing an edge representation index attribute
.IX "Attributes, Edge Attributes" "SET EDGE INDEX"
.IX "Edge Attributes" "SET EDGE INDEX"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_edge_ind ( index )
Pint	index;	\fIedge index\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET EDGE INDEX\s+2 creates a structure element
containing an edge index number that selects an entry
from the workstation's edge bundle table.  
This attribute applies to the output primitives
.sp .2
.RS
.LP
\(bu
.SM "FILL AREA SET"
.LP
\(bu
.SM "FILL AREA SET 3"
.LP
\(bu
.SM "GENERALIZED DRAWING PRIMITIVE (\fIFill Area Set Primitives\fP)"
.LP
\(bu
.SM "GENERALIZED DRAWING PRIMITIVE 3 (\fIFill Area Set Primitives\fP)" 
.LP
\(bu
.SM "NON-UNIFORM B-SPLINE SURFACE"
.LP
\(bu
.SM "QUADRILATERAL MESH 3 WITH DATA"
.LP
\(bu
.SM "TRIANGLE STRIP 3 WITH DATA"
.sp .2
.fi
.RE
.LP
If the current edit mode is \s-2INSERT\s+2,
a \s-2SET EDGE INDEX\s+2 element is inserted into the currently open
structure after the element pointed to by the current element pointer.  
If the edit mode is \s-2REPLACE\s+2,
then the new \s-2SET EDGE INDEX\s+2 element
replaces the element pointed to by the element pointer.  
In either case, the element pointer is updated to point to the new element.
.SS C Input Parameter
.IP \fIindex\fP
An edge index for edge representation on the workstation.
.SS Execution
When the \s-2SET EDGE INDEX\s+2 element is traversed,
the current edge index value is set to the edge index that specifies 
an entry from the workstation's edge bundle table.  
The default edge index is 1, and
if the edge index specified is not available on the workstation,
then 1 is used.  
.LP
An edge representation contains values for the following attributes:
.sp .2
.nf
.RS
.LP
\(bu edge flag
.LP
\(bu edgetype
.LP
\(bu edgewidth scale factor
.LP
\(bu edge colour index
.fi
.sp .2
.RE
\s-2FILL AREA\s+2 output primitives, which follow in the structure network, 
use the values from the specified representation
for those edge attributes whose Aspect Source Flag (\s-2ASF\s+2) is set to
\s-2BUNDLED\s+2.  
When the \s-2ASF\s+2s are
\s-2INDIVIDUAL\s+2,
the attributes come from the appropriate
\s-2SET\s+2
.I attribute
elements.
.LP
Edge representations are defined with
\s-2SET EDGE REPRESENTATION\s+2.
.SH ERRORS
.IP 005
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2*\s+2, \s-2STOP\s+2, \s-2*\s+2)
.IP 100
Ignoring function, the bundle index value is less than one
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET EDGE FLAG (3P)"
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET EDGE REPRESENTATION (3P)"
.SM "SET EDGE REPRESENTATION PLUS (3P+)"
.fi
