.\"##
.\" $XConsortium: p339,v 5.2 94/04/17 20:58:23 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 LINEWIDTH SCALE FACTOR" 3P "29 February 1991"
.SH NAME
SET LINEWIDTH SCALE FACTOR \- create structure element to set the current linewidth scale factor attribute
.IX "Aspect Source Flags" "SET LINEWIDTH SCALE FACTOR"
.IX "Line Attributes" "SET LINEWIDTH SCALE FACTOR"
.IX "Attributes, Line Attributes" "SET LINEWIDTH SCALE FACTOR"
.IX "Wide Lines" "SET LINEWIDTH SCALE FACTOR"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_linewidth ( width )
Pfloat	width;	\fIlinewidth scale factor\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET LINEWIDTH SCALE FACTOR \s+2 creates a structure element
containing a value for the \fIcurrent linewidth scale factor\fP attribute.
When the \fIlinewidth scale factor ASF\fP is set to \s-2INDIVIDUAL\s+2,
this attribute defines the current linewidth to be applied to the
output primitives:
.RS
.ta 0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i
.LP
\(bu	\s-2POLYLINE\s+2
.LP
\(bu	\s-2POLYLINE 3\s+2
.ta
.RE
.LP
If the current edit mode is \s-2INSERT\s+2,
a \s-2SET LINEWIDTH SCALE FACTOR\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
LINEWIDTH SCALE FACTOR\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 \fIwidth\fP
A real value specifying the \fIlinewidth scale factor\fP.
.SS Execution
.LP
When the \s-2SET LINEWIDTH SCALE FACTOR\s+2 element is traversed, the \fIcurrent linewidth scale factor\fP
entry in the traversal state list is set to \fIlinewidth scale factor\fP.
When the \fIcurrent linewidth scale factor \s-2ASF\s+2\fP (Aspect Source Flag) is set to
\s-2INDIVIDUAL\s+2, line output primitives that follow in
the structure network are drawn using the \fIlinewidth scale factor\fP
specified.
.LP
The width of the line drawn is determined by applying the current linewidth
scale factor to the \fInominal linewidth\fP
as defined in the workstation description table,
and this result is then mapped to the nearest linewidth
supported on the workstation.
.LP
When the \fIcurrent linewidth scale factor ASF\fP
is set to \s-2BUNDLED\s+2, the effective
linewidth scale factor is
the linewidth attribute in the polyline representation selected by
the \fIcurrent polyline index\fP.
In this case, the \fIlinewidth scale factor\fP value set with \s-2SET
LINEWIDTH SCALE FACTOR\s+2 will have no effect.
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET EDGEWIDTH SCALE FACTOR (3P)"
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET POLYLINE REPRESENTATION (3P)"
.fi
