~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/graphics/locate.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
ImportĀ upstreamĀ versionĀ 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH locate 2 "April 1993" "Scilab Group" "Scilab Function" 
 
2
.so ../sci.an
 
3
.SH NAME
 
4
locate - mouse selection of a set of points 
 
5
.SH CALLING SEQUENCE
 
6
.nf
 
7
x=locate([n,flag])
 
8
.fi
 
9
.SH PARAMETERS 
 
10
.TP 8
 
11
x
 
12
: matrix of size (2,n1). n1=n if the parameter n is given.
 
13
.TP
 
14
n,flag 
 
15
: integer values.
 
16
.LP
 
17
.SH DESCRIPTION
 
18
\fVlocate\fR is used to get the coordinates of one or more 
 
19
points selected with the mouse in a graphics window. The coordinates 
 
20
are given using the current graphics scale. 
 
21
 
 
22
If n>0, n points are selected and their coordinates are returned in 
 
23
the matrix \fVx\fR.
 
24
 
 
25
If n<=0, points are selected until the user clicks with the left button 
 
26
of the mouse which stands for stop. The last point (clicked with the left 
 
27
button) is not returned.
 
28
 
 
29
x=locate() is the same as \fVx=locate(-1)\fR.
 
30
.LP
 
31
If \fVflag=1\fR a cross is drawn at the points where the mouse is clicked.
 
32
.SH SEE ALSO
 
33
xclick, xgetmouse
 
34
.SH AUTHOR
 
35
S.S. & J.Ph.C