.\" @(#)PEXRotateGeneral.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXRotateGeneral 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXRotateGeneral - utility function
.SH SYNTAX
.HP
int PEXRotateGeneral\^(\^PEXCoord *\fIpoint1\fP, PEXCoord *\fIpoint2\fP, double
\fIangle\fP, PEXMatrix \fImatrix_return\fP\^)
.SH PARAMETERS
.IP \fIpoint1\fP 1i
Endpoint of line segment defining rotation axis.
.IP \fIpoint2\fP 1i
Endpoint of line segment defining rotation axis.
.IP \fIangle\fP 1i
Angle of the rotation in radians.
.IP \fImatrix_return\fP 1i
Matrix into which rotation matrix is stored.
.SH RETURNS
.LP
Zero if successful; otherwise, one of the following:
.TP
.B PEXBadAxis
The endpoints are coincident.
.SH DESCRIPTION
.\" indexing
.IX PEXRotateGeneral
.IX "Utility Functions" PEXRotateGeneral
.LP
This routine formats a matrix for a right-handed rotation about an
arbitrary axis.  The rotation axis is defined by the line segment
joining the two points.  The
.I angle
is in radians and is measured
counter-clockwise when looking from the first point to second point along the
specified axis.
.LP
Returns unsuccessfully if the points are coincident.
.SH ERRORS
None
.SH SEE ALSO
.LP
.nf
.BR PEXRotate (3)
.BR PEXRotate2D (3)
.fi