summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p395
blob: d30132a7a5b75f99727409d0f4f5a503f7422673 (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
96
.\"##
.\" $XConsortium: p395,v 5.1 91/02/16 09:44: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 "TRANSFORM POINT" 3P "29 February 1991"
.SH NAME
TRANSFORM POINT  \- apply a \s-2\&2D\s+2 transformation matrix to a specified \s-2\&2D\s+2 point
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.5i 3i
.nf
void
ptran_point ( p, m, error_ind, r)
Ppoint	*p;	\fIpoint\fP
Pmatrix	m;	\fItransformation matrix\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Ppoint	*r;	\fIOUT transformed point\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2TRANSFORM POINT\s+2 to calculate the transformed coordinates of a
\s-2\&2D\s+2 point.
.SS C Input Parameters
.IP \fIp\fP
A pointer to a Ppoint data structure containing the coordinates of the
point to be transformed.
Ppoint is defined in phigs.h as follows:
.sp .4
.ta .5i +\w'Pfloat     'u +\w'x;     'u
.nf
typedef struct  {
.sp .2
	Pfloat	x;	/* x coordinate */
	Pfloat	y;	/* y coordinate */
.sp .2
} Ppoint;
.fi
.IP \fIm\fP
The 3\ \(mu\ 3 homogeneous transformation matrix to apply to \fIp\fP.
Pmatrix is defined in phigs.h as follows:
.IP
typedef  Pfloat  Pmatrix[3][3];
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error detected
by this function.
.IP \fIr\fP
A pointer to a Ppoint structure in which to store the coordinates of the
transformed point.
.SS Execution
\s-2TRANSFORM POINT\s+2 applies the 3\ \(mu\ 3 homogeneous
\fItransformation matrix\fP
to the \s-2\&2D\s+2 \fIpoint\fP, and returns the coordinates of the resulting point:
.sp
	\fItransformed point\fP = \fImatrix\fP \s-2X\s+2 \fIpoint\fP
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET LOCAL TRANSFORMATION 3 (3P)"
.SM "ROTATE (3P)"
.SM "SCALE (3P)"
.SM "TRANSLATE (3P)"
.SM "BUILD TRANSFORMATION MATRIX (3P)"
.SM "COMPOSE TRANSFORMATION MATRIX (3P)"
.SM "COMPOSE MATRIX (3P)"
.SM "TRANSFORM POINT 3 (3P)"
.fi