summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p283
blob: 89d1abe2bc2f351e84eb9030cdc55b43dadaa829 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
.\"##
.\" $XConsortium: p283,v 5.2 94/04/17 20:57:42 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 ANNOTATION TEXT CHARACTER HEIGHT" 3P "29 February 1991"
.SH NAME
SET ANNOTATION TEXT CHARACTER HEIGHT \- create structure element to set the 
\fIcurrent annotation text character height\fP attribute
.IX "Text Attributes" "SET ANNOTATION TEXT CHARACTER HEIGHT"
.IX "Attributes, Text Attributes" "SET ANNOTATION TEXT CHARACTER HEIGHT"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_anno_char_ht ( height )
Pfloat	height;	\fIcharacter height\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET ANNOTATION TEXT CHARACTER HEIGHT\s+2 creates a structure element
containing a value for the current annotation text character height 
attribute, which defines the height of a capital letter, in Text Local 
Coordinates.  
This attribute applies to the output primitives:
.RS
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE 3"
.RE
.LP
If the current edit mode is \s-2INSERT\s+2,
a \s-2SET ANNOTATION TEXT CHARACTER HEIGHT\s+2 element is inserted in 
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 ANNOTATION TEXT 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 annotation text character height.
.SS Execution
When the \s-2SET ANNOTATION TEXT CHARACTER HEIGHT\s+2 element is traversed,
the current annotation text character height entry in the traversal state list 
is set to \s-2SET ANNOTATION TEXT CHARACTER HEIGHT\s+2.  
Characters in text output primitives that follow in the structure network
are drawn with the current annotation text character height.  
.LP
The annotation text 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 \fIcharacter up vector\fP.  
The character base line and character up vector are relative to the
TLC system created by the reference point and annotation offset
specified in the annotation text relative output primitive.  
.LP
The default annotation text 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 "ANNOTATION TEXT RELATIVE 3 (3P)"
.SM "SET CHARACTER HEIGHT (3P)"
.fi