.\" This page was automatically generated.  Do not edit!
.\" 
.TH PLVECT 3plplot  "February, 2014" "" "PLplot API"
.SH NAME
\fBplvect\fP - Vector plot 
.SH SYNOPSIS
\fBplvect\fP(\fIu\fP, \fIv\fP, \fInx\fP, \fIny\fP, \fIscale\fP, \fIpltr\fP, \fIpltr_data\fP)
.SH DESCRIPTION

.P
Draws a vector plot of the vector (\fIu\fP[\fInx\fP][\fIny\fP],\fIv\fP[\fInx\fP][\fIny\fP]). The scaling factor for the vectors is given by \fIscale\fP. A transformation routine pointed to by \fIpltr\fP with a pointer \fIpltr_data\fP for additional data required by the transformation routine is used to map indices within the array to the world coordinates. The style of the vector arrow may be set using \fBplsvect\fP(3plplot). 
.P
Redacted form: \fBplvect(u, v, scale, pltr, pltr_data)\fP
.P
This function is used in example 22. 
.SH ARGUMENTS
.TP
\fIu, v\fP (const PLFLT * const *, input) 
Pointers to a pair of vectored two-dimensional arrays containing the x and y components of the vector data to be plotted. 
.TP
\fInx, ny\fP (PLINT, input) 
Physical dimensions of the arrays \fIu\fP and \fIv\fP. 
.TP
\fIscale\fP (PLFLT, input) 
Parameter to control the scaling factor of the vectors for plotting. If \fIscale\fP = 0 then the scaling factor is automatically calculated for the data. If \fIscale\fP < 0 then the scaling factor is automatically calculated for the data and then multiplied by -\fIscale\fP. If \fIscale\fP > 0 then the scaling factor is set to \fIscale\fP. 
.TP
\fIpltr\fP (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) 
Pointer to function that defines transformation between indices in array \fIz\fP and the world coordinates (C only).  Transformation functions are provided in the PLplot library: \fBpltr0\fP(3plplot) for identity mapping, and \fBpltr1\fP(3plplot) and \fBpltr2\fP(3plplot) for arbitrary mappings respectively defined by one- and two-dimensional arrays.  In addition, user-supplied routines for the transformation can be used as well.  Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of \fBpltr0\fP(3plplot), \fBpltr1\fP(3plplot), or \fBpltr2\fP(3plplot). 
.TP
\fIpltr_data\fP (PLPointer, input) 
Extra parameter to help pass information to \fBpltr0\fP(3plplot), \fBpltr1\fP(3plplot), \fBpltr2\fP(3plplot), or whatever routine that is externally supplied. 

.SH AUTHORS
Many developers (who are credited at http://plplot.sourceforge.net/credits.php)
have contributed to PLplot over its long history.
.SH SEE ALSO
PLplot documentation at http://plplot.sourceforge.net/documentation.php.
