← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/transform/rotate.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/graphics/help/en_US/transform/rotate.xml
11
11
 *
12
12
 -->
13
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" version="5.0-subset Scilab" xml:lang="en" xml:id="rotate">
14
 
  <refnamediv>
15
 
    <refname>rotate</refname>
16
 
    <refpurpose> rotation of a set of points</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>xy1=rotate(xy,[theta,orig])</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>xy</term>
27
 
        <listitem>
28
 
          <para>matrix of size (2,.).</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>xy1</term>
33
 
        <listitem>
34
 
          <para>matrix of size (2,.).</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>theta</term>
39
 
        <listitem>
40
 
          <para>real, angle in radians; default value is 0.</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>orig</term>
45
 
        <listitem>
46
 
          <para>center of the rotation [xc;yc]; default value is [0;0].</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      <literal>rotate</literal> performs a rotation with angle <literal>theta</literal>:
55
 
    </para>
56
 
    <para>
57
 
      <literal>xy1(:,i) = M(theta) *(xy(:,i) - orig) + orig</literal>
58
 
    </para>
59
 
    <para>
60
 
      where <literal>M</literal> stands for the corresponding rotation matrix.
61
 
    </para>
62
 
  </refsection>
63
 
  <refsection>
64
 
    <title>Sample</title>
65
 
    <scilab:image>
66
 
      xsetech([0,0,1,1],[-1,-1,1,1])
67
 
      xy=[(0:0.1:10);sin(0:0.1:10)]/10;
68
 
      for i=2*%pi*(0:10)/10,
69
 
      [xy1]=rotate(xy,i);
70
 
      xpoly(xy1(1,:),xy1(2,:),"lines")
71
 
      end
72
 
    </scilab:image>
73
 
  </refsection>
74
 
  <refsection>
75
 
    <title>Examples</title>
76
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>rotate</refname>
 
16
        <refpurpose> rotation of a set of points</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>xy1=rotate(xy,[theta,orig])</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>xy</term>
 
27
                <listitem>
 
28
                    <para>matrix of size (2,.).</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>xy1</term>
 
33
                <listitem>
 
34
                    <para>matrix of size (2,.).</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>theta</term>
 
39
                <listitem>
 
40
                    <para>real, angle in radians; default value is 0.</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>orig</term>
 
45
                <listitem>
 
46
                    <para>center of the rotation [xc;yc]; default value is [0;0].</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            <literal>rotate</literal> performs a rotation with angle <literal>theta</literal>:
 
55
        </para>
 
56
        <para>
 
57
            <literal>xy1(:,i) = M(theta) *(xy(:,i) - orig) + orig</literal>
 
58
        </para>
 
59
        <para>
 
60
            where <literal>M</literal> stands for the corresponding rotation matrix.
 
61
        </para>
 
62
    </refsection>
 
63
    <refsection>
 
64
        <title>Sample</title>
 
65
        <scilab:image>
 
66
            xsetech([0,0,1,1],[-1,-1,1,1])
 
67
            xy=[(0:0.1:10);sin(0:0.1:10)]/10;
 
68
            for i=2*%pi*(0:10)/10,
 
69
            [xy1]=rotate(xy,i);
 
70
            xpoly(xy1(1,:),xy1(2,:),"lines")
 
71
            end
 
72
        </scilab:image>
 
73
    </refsection>
 
74
    <refsection>
 
75
        <title>Examples</title>
 
76
        <programlisting role="example"><![CDATA[ 
77
77
xsetech([0,0,1,1],[-1,-1,1,1])
78
78
xy=[(0:0.1:10);sin(0:0.1:10)]/10;
79
79
for i=2*%pi*(0:10)/10,
81
81
  xpoly(xy1(1,:),xy1(2,:),"lines")
82
82
end
83
83
 ]]></programlisting>
84
 
  </refsection>
 
84
    </refsection>
85
85
</refentry>