.\"##
.\" $XConsortium: p293,v 5.2 94/04/17 20:57:51 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 CHARACTER HEIGHT" 3P "29 February 1991"
.SH NAME
SET CHARACTER HEIGHT \- create structure element to set the \fIcurrent character height\fP attribute
.IX "Text Attributes" "SET CHARACTER HEIGHT"
.IX "Attributes, Text Attributes" "SET CHARACTER HEIGHT"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_char_ht ( height )
Pfloat	height;	\fIcharacter height\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET CHARACTER HEIGHT\s+2 creates a structure element
containing a value for the current character height attribute,
which defines the height of a capital letter, in Text Local Coordinates.  
This attribute applies to the output primitives:  
.LP
.RS
\(bu
.SM TEXT
.LP
\(bu
.SM "TEXT 3"
.RE
.LP
If the current edit mode is \s-2INSERT\s+2, then 
a \s-2SET CHARACTER HEIGHT\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 CHARACTER HEIGHT\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 \fIheight\fP
A real value specifying the character height.
.SS Execution
When the \s-2SET CHARACTER HEIGHT\s+2 element is traversed, 
the current character height 
entry in the traversal state list is set to character height.  
Characters in text output primitives that follow in the structure network
are drawn with the current character height.  
.LP
The character height is specified in Text Local Coordinates (TLC) 
and determines the height of a capital letter,
measured from the character base line parallel to the character up vector.  
The character base line and character up vector are relative to the
Text Local Coordinate system created by the text position and text vectors
specified in the text output primitive.  
.LP
The default character height is 0.01.
.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)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET CHARACTER EXPANSION FACTOR (3P)"
.SM "SET CHARACTER SPACING (3P)"
.SM "SET TEXT REPRESENTATION (3P)"
.SM "SET ANNOTATION TEXT CHARACTER HEIGHT (3P)"
.fi
