* Bug #12774 fixed - Fix various typos.
[scilab.git] / scilab / modules / graphics / help / en_US / axes_operations / rotate_axes.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - 2008 - Jean-Baptiste Silvy
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="rotate_axes">
14     <refnamediv>
15         <refname>rotate_axes</refname>
16         <refpurpose>Interactive rotation of an Axes handle.</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>rotate_axes()
21             rotate_axes(h)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>h</term>
29                 <listitem>
30                     <para>Figure or Axes handle. Specify on which Axes the rotation will apply.</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>
38             <literal>rotate_axes</literal> function is used to perform an interactive rotation of an Axes object.
39             When the function is called, the user is requested to click twice on the graphic window. The first click
40             initializes the rotation and the second ends it.
41             
42         </para>
43         <para>
44             If an Axes handle is specified as input argument, the rotation will apply on it.
45             If a figure handle is specified, the first click determines the Axes objet to rotate.
46             If the function is called with no argument, the rotation apply on the current figure.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[ 
52 clf();
53 // create two axes in the figure
54 subplot(2, 1, 1);
55 plot2d;
56 subplot(2, 1, 2);
57 plot3d;
58
59 // rotate only the second axes
60 axes2 = gca();
61 rotate_axes(axes2);
62
63 // rotate the selected one
64 rotate_axes();
65 // or
66 rotate_axes(gcf());
67  ]]></programlisting>
68     </refsection>
69     <refsection role="see also">
70         <title>See Also</title>
71         <simplelist type="inline">
72             <member>
73                 <link linkend="zoom_rect">zoom_rect</link>
74             </member>
75             <member>
76                 <link linkend="axes_properties">axes_properties</link>
77             </member>
78         </simplelist>
79     </refsection>
80 </refentry>