.\"##
.\" $XConsortium: p360,v 5.2 94/04/17 20:58:38 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 POLYLINE INDEX" 3P "29 February 1991"
.SH NAME
SET POLYLINE INDEX \- create structure element containing polyline index attribute
.IX "Line Attributes" "SET POLYLINE INDEX"
.IX "Attributes, Line Attributes" "SET POLYLINE INDEX"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_line_ind ( index )
Pint	index;	\fIpolyline index\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET POLYLINE INDEX\s+2 creates a structure element
containing a polyline index number, which selects an entry
from the workstation's polyline bundle table.
This attribute applies to the output primitives:
.RS
.ta 0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i
.LP
\(bu
.SM "POLYLINE"
.LP
\(bu 
.SM "POLYLINE 3"
.LP
\(bu
.SM "POLYLINE SET 3 WITH DATA"
.LP
\(bu
.SM "NON-UNIFORM B-SPLINE CURVE"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE (when ``connected'' style is in use)"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE 3 (when ``connected'' style is in use)"
.LP
\(bu
.SM "CELL ARRAY (when minimal simulation is performed)"
.LP
\(bu
.SM "CELL ARRAY 3 (when minimal simulation is performed)"
.ta
.RE
.SS C Input Parameter
.IP \fIindex\fP
A \fIpolyline index\fP for a polyline representation on the workstation.
.SS Execution
.LP
If the current edit mode is \s-2INSERT\s+2,
a \s-2SET POLYLINE 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,
the new \s-2SET POLYLINE 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.
.LP
When the \s-2SET POLYLINE INDEX\s+2 element is traversed,
the current polyline index value is set to the \fIpolyline index\fP,
which specifies an entry from the workstation's polyline bundle table.
The default \fIpolyline index\fP is 1, and
if the \fIpolyline index\fP specified is not available on the workstation,
1 will be used.
.LP
A polyline representation contains values for the following attributes:
.sp
.nf
.RS
\(bu  linetype
\(bu  linewidth scale factor
\(bu  polyline colour
.\"PHIGS+	and polyline shading method attributes
.fi
.sp
.RE
Line output primitives which follow in the structure network
will be drawn using the values from the specified representation
for those 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
Polyline representations are defined with \s-2SET POLYLINE REPRESENTATION\s+2.
.\"PHIGS+	and \s-2SET POLYLINE REPRESENTATION PLUS\s+2.
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.IP 100
Ignoring function, the bundle index value is less than one
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET POLYLINE REPRESENTATION (3P)"
.SM "SET POLYLINE REPRESENTATION PLUS (3P+)"
.fi
