* Bug 10353 fixed [doc]: axes_properties page fixed + improved 85/21185/3
Samuel GOUGEON [Sun, 22 Dec 2019 03:04:33 +0000 (04:04 +0100)]
  http://bugzilla.scilab.org/10353

  Help page updated (PDF): http://bugzilla.scilab.org/attachment.cgi?id=5037

Change-Id: I4c34877d58e49fee325ff23fac63f68fed50986c

14 files changed:
scilab/CHANGES.md
scilab/modules/graphics/help/en_US/axes_operations/axes_properties.xml
scilab/modules/graphics/help/ja_JP/axes_operations/axes_properties.xml
scilab/modules/graphics/help/pt_BR/axes_operations/axes_properties.xml
scilab/modules/helptools/etc/images_md5.txt
scilab/modules/helptools/images/axes_properties_1.png [new file with mode: 0644]
scilab/modules/helptools/images/axes_properties_2.png [new file with mode: 0644]
scilab/modules/helptools/images/axes_properties_3.png [new file with mode: 0644]
scilab/modules/helptools/images/axes_properties_4.png [new file with mode: 0644]
scilab/modules/helptools/images/axes_properties_en_US_5.png [moved from scilab/modules/helptools/images/axes_properties_en_US_1.png with 100% similarity]
scilab/modules/helptools/images/axes_properties_fr_FR_5.png [moved from scilab/modules/helptools/images/axes_properties_fr_FR_1.png with 100% similarity]
scilab/modules/helptools/images/axes_properties_ja_JP_5.png [moved from scilab/modules/helptools/images/axes_properties_ja_JP_1.png with 100% similarity]
scilab/modules/helptools/images/axes_properties_pt_BR_5.png [moved from scilab/modules/helptools/images/axes_properties_pt_BR_1.png with 100% similarity]
scilab/modules/helptools/images/axes_properties_ru_RU_5.png [moved from scilab/modules/helptools/images/axes_properties_ru_RU_1.png with 100% similarity]

index 2385508..19edb2c 100644 (file)
@@ -167,7 +167,7 @@ Bug Fixes
 * [#5512](http://bugzilla.scilab.org/show_bug.cgi?id=5512): `disp()` puzzlingly displayed arguments in reverse order.
 * [#9529](http://bugzilla.scilab.org/show_bug.cgi?id=9529): `assert_checkequal(list(1,,3), list(1,,3))` yielded an error.
 * [#9673](http://bugzilla.scilab.org/show_bug.cgi?id=9673): Priority of colon `:` operator was too low
-* [#10353](http://bugzilla.scilab.org/show_bug.cgi?id=10353): The referential for the uicontrol.position property was not provided.
+* [#10353](http://bugzilla.scilab.org/show_bug.cgi?id=10353): Documentation: The referential for the uicontrol.position property was not provided. Moreover, gca().axes_bounds refered to fig.figure_size instead of fig.axes_size.
 * [#12520](http://bugzilla.scilab.org/show_bug.cgi?id=12520): Vriable browser did not display the size of the variables.
 * [#12534](http://bugzilla.scilab.org/show_bug.cgi?id=12534): Variable browser did not display the size of the variables.
 * [#13766](http://bugzilla.scilab.org/show_bug.cgi?id=13766): Minimal values for `.figure_size` were not documented.
index 5754cf5..e85432d 100644 (file)
                                     <literal>"back_half"</literal>, the X, Y and Z axis are also drawn. If
                                     the property is <literal>"on"</literal> the whole box is drawn.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    box = ["on" "back_half" "hidden_axes" "off"];
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot3d([0 1],[0 1],[0 1])
+                                        a = gca();
+                                        a.box = box(i);
+                                        a.rotation_angles = [235 326];
+                                        title(msprintf("%s", box(i)), "fontsize",3)
+                                    end
+                                    gcf().axes_size = [840 222];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>rotation_angles: </term>
                             <listitem>
                                 <para>
-                                    This field is the vector <literal>[alpha,theta]</literal>. These two
-                                    values give the spherical coordinates of the observation points
-                                    (in degree).
+                                    Spherical coordinates <literal>[alpha, theta]</literal> =
+                                    <literal>[polAngle, azimuth]</literal> of the observation point,
+                                    in degrees:
+                                    <itemizedlist>
+                                        <listitem>
+                                            <emphasis role="bold">theta</emphasis>: azimuth angle
+                                            in the (x,y) plane. Particular angles, for (x,y) seen
+                                            from (O,z):
+                                            <table>
+                                                <tr><td>270 </td><td>: (O,x) to right</td></tr>
+                                                <tr><td>0 </td><td>: (O,x) to bottom</td></tr>
+                                                <tr><td>90 </td><td>: (O,x) to left</td></tr>
+                                                <tr><td>180 </td><td>: (O,x) to top</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // Azimuth:
+                                            // --------
+                                            x = linspace(0,30,100);
+                                            y = exp(-x/7).*sin(x);
+                                            scf(1);
+                                            clf
+                                            i = 1;
+                                            for a = [270 315 0 90 180]
+                                                subplot(1,5,i)
+                                                plot(x, y, "b")
+                                                gca().rotation_angles(2) = a;
+                                                gca().margins = [0.17 0.17 0.25 0.15];
+                                                gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("theta = %d\n\r", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 200];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                        <listitem>
+                                            <emphasis role="bold">alpha</emphasis>: polar angle from
+                                            (Oz), in planes orthogonal to (x,y). Particular values:
+                                            <table>
+                                                <tr><td>0</td><td>= North pole (O,z)</td><td> view from above</td></tr>
+                                                <tr><td>90</td><td>= Equator (x,y)</td><td> view from side</td></tr>
+                                                <tr><td>180</td><td>= South pole (O,-z)</td><td> view from below</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // polar angle
+                                            // -----------
+                                            scf(2);
+                                            clf
+                                            i = 1
+                                            for a = [0 30 60 90 120]
+                                                subplot(1,5,i)
+                                                plot3d()
+                                                gce().color_mode = -2;
+                                                gca().rotation_angles = [a 300];
+                                            //    gca().margins = [0.17 0.17 0.25 0.15];
+                                            //    gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("alpha = %d\n", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 220];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                    </itemizedlist>
                                 </para>
                             </listitem>
                         </varlistentry>
                                     They should take a value between <literal>'n'</literal> for linear scale or
                                     <literal>'l'</literal> for logarithmic scale.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    x = linspace(0,10,100)(2:$);
+                                    m = ["nn" "ln" "nl" "ll"];
+                                    clf
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot2d(m(i), x, x.^2)
+                                        xgrid(color("grey75"),1,7)
+                                        title(msprintf("""%s""",m(i)),"fontsize",3)
+                                        select i
+                                        case 1, gca().sub_ticks = [3 3];
+                                        case 2, gca().sub_ticks = [8 3];
+                                        case 3, gca().sub_ticks = [3 8];
+                                        case 4, gca().sub_ticks = [8 8];
+                                        end
+                                    end
+                                    gcf().axes_size = [800 220];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </para>
                                 <para>
                                     These numbers are relative to the
-                                    <literal>gca().parent.figure_size(3:4)</literal>
-                                    or to the <literal>gca().parent.position(3:4)</literal>
+                                    <literal>gca().parent.position(3:4)</literal> [width, height]
                                     dimensions of the figure or of the Uicontrol frame
                                     embedding the axes.
                                 </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example">
-            <![CDATA[
+        <programlisting role="example"><![CDATA[
 lines(0) // disables vertical paging
 a=get("current_axes")//get the handle of the newly created axes
 a.axes_visible="on"; // makes the axes visible
index e055156..b29b220 100644 (file)
                                     X, Y および Z 軸も描画されます.
                                     プロパティが<literal>"on"</literal>の場合,箱全体が描画されます.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    box = ["on" "back_half" "hidden_axes" "off"];
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot3d([0 1],[0 1],[0 1])
+                                        a = gca();
+                                        a.box = box(i);
+                                        a.rotation_angles = [235 326];
+                                        title(msprintf("%s", box(i)), "fontsize",3)
+                                    end
+                                    gcf().axes_size = [840 222];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>rotation_angles: </term>
                             <listitem>
                                 <para>
-                                    このフィールドはベクトル <literal>[alpha,theta]</literal>です.
-                                    この2つの値は視点の球座標(単位:度)を指定します.
+                                    Spherical coordinates <literal>[alpha, theta]</literal> =
+                                    <literal>[polAngle, azimuth]</literal> of the observation point,
+                                    in degrees:
+                                    <itemizedlist>
+                                        <listitem>
+                                            <emphasis role="bold">theta</emphasis>: azimuth angle
+                                            in the (x,y) plane. Particular angles, for (x,y) seen
+                                            from (O,z):
+                                            <table>
+                                                <tr><td>270 </td><td>: (O,x) to right</td></tr>
+                                                <tr><td>0 </td><td>: (O,x) to bottom</td></tr>
+                                                <tr><td>90 </td><td>: (O,x) to left</td></tr>
+                                                <tr><td>180 </td><td>: (O,x) to top</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // Azimuth:
+                                            // --------
+                                            x = linspace(0,30,100);
+                                            y = exp(-x/7).*sin(x);
+                                            scf(1);
+                                            clf
+                                            i = 1;
+                                            for a = [270 315 0 90 180]
+                                                subplot(1,5,i)
+                                                plot(x, y, "b")
+                                                gca().rotation_angles(2) = a;
+                                                gca().margins = [0.17 0.17 0.25 0.15];
+                                                gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("theta = %d\n\r", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 200];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                        <listitem>
+                                            <emphasis role="bold">alpha</emphasis>: polar angle from
+                                            (Oz), in planes orthogonal to (x,y). Particular values:
+                                            <table>
+                                                <tr><td>0</td><td>= North pole (O,z)</td><td> view from above</td></tr>
+                                                <tr><td>90</td><td>= Equator (x,y)</td><td> view from side</td></tr>
+                                                <tr><td>180</td><td>= South pole (O,-z)</td><td> view from below</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // polar angle
+                                            // -----------
+                                            scf(2);
+                                            clf
+                                            i = 1
+                                            for a = [0 30 60 90 120]
+                                                subplot(1,5,i)
+                                                plot3d()
+                                                gce().color_mode = -2;
+                                                gca().rotation_angles = [a 300];
+                                            //    gca().margins = [0.17 0.17 0.25 0.15];
+                                            //    gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("alpha = %d\n", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 220];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                    </itemizedlist>
                                 </para>
                             </listitem>
                         </varlistentry>
                                     値には,線形スケールの場合に<literal>'n'</literal>,
                                     対数スケールの場合に <literal>'l'</literal>を指定します.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    x = linspace(0,10,100)(2:$);
+                                    m = ["nn" "ln" "nl" "ll"];
+                                    clf
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot2d(m(i), x, x.^2)
+                                        xgrid(color("grey75"),1,7)
+                                        title(msprintf("""%s""",m(i)),"fontsize",3)
+                                        select i
+                                        case 1, gca().sub_ticks = [3 3];
+                                        case 2, gca().sub_ticks = [8 3];
+                                        case 3, gca().sub_ticks = [3 8];
+                                        case 4, gca().sub_ticks = [8 8];
+                                        end
+                                    end
+                                    gcf().axes_size = [800 220];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </para>
                                 <para>
                                     These numbers are relative to the
-                                    <literal>gca().parent.figure_size(3:4)</literal>
-                                    or to the <literal>gca().parent.position(3:4)</literal>
+                                    <literal>gca().parent.position(3:4)</literal> [width, height]
                                     dimensions of the figure or of the Uicontrol frame
                                     embedding the axes.
                                 </para>
index 9341623..3a0a000 100644 (file)
                                     desenhados também. Se a propriedade for
                                     <literal>"on"</literal> , a caixa toda é desenhada.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    box = ["on" "back_half" "hidden_axes" "off"];
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot3d([0 1],[0 1],[0 1])
+                                        a = gca();
+                                        a.box = box(i);
+                                        a.rotation_angles = [235 326];
+                                        title(msprintf("%s", box(i)), "fontsize",3)
+                                    end
+                                    gcf().axes_size = [840 222];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
-                            <term>rotation_angles:</term>
+                            <term>rotation_angles: </term>
                             <listitem>
                                 <para>
-                                    este campo é o vetor <literal>[alpha,theta]</literal>.
-                                    Estes dois valores fornecem as coordenadas esféricas de
-                                    obsevação (em graus).
+                                    Coordenadas esféricas <literal>[alpha, theta]</literal> =
+                                    <literal>[polAngle, azimuth]</literal> de obsevação (em graus):
+                                    <itemizedlist>
+                                        <listitem>
+                                            <emphasis role="bold">theta</emphasis>: azimuth angle
+                                            in the (x,y) plane. Particular angles, for (x,y) seen
+                                            from (O,z):
+                                            <table>
+                                                <tr><td>270 </td><td>: (O,x) to right</td></tr>
+                                                <tr><td>0 </td><td>: (O,x) to bottom</td></tr>
+                                                <tr><td>90 </td><td>: (O,x) to left</td></tr>
+                                                <tr><td>180 </td><td>: (O,x) to top</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // Azimuth:
+                                            // --------
+                                            x = linspace(0,30,100);
+                                            y = exp(-x/7).*sin(x);
+                                            scf(1);
+                                            clf
+                                            i = 1;
+                                            for a = [270 315 0 90 180]
+                                                subplot(1,5,i)
+                                                plot(x, y, "b")
+                                                gca().rotation_angles(2) = a;
+                                                gca().margins = [0.17 0.17 0.25 0.15];
+                                                gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("theta = %d\n\r", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 200];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                        <listitem>
+                                            <emphasis role="bold">alpha</emphasis>: polar angle from
+                                            (Oz), in planes orthogonal to (x,y). Particular values:
+                                            <table>
+                                                <tr><td>0</td><td>= North pole (O,z)</td><td> view from above</td></tr>
+                                                <tr><td>90</td><td>= Equator (x,y)</td><td> view from side</td></tr>
+                                                <tr><td>180</td><td>= South pole (O,-z)</td><td> view from below</td></tr>
+                                            </table>
+                                            <scilab:image><![CDATA[
+                                            // gca().rotation_angles:
+                                            // polar angle
+                                            // -----------
+                                            scf(2);
+                                            clf
+                                            i = 1
+                                            for a = [0 30 60 90 120]
+                                                subplot(1,5,i)
+                                                plot3d()
+                                                gce().color_mode = -2;
+                                                gca().rotation_angles = [a 300];
+                                            //    gca().margins = [0.17 0.17 0.25 0.15];
+                                            //    gca().box = "on";
+                                                gca().cube_scaling = "on";
+                                                title(msprintf("alpha = %d\n", a), "fontsize",3, "color",color("magenta3"))
+                                                i = i + 1;
+                                            end
+                                            gcf().axes_size = [810 220];
+                                            ]]></scilab:image>
+                                        </listitem>
+                                    </itemizedlist>
                                 </para>
                             </listitem>
                         </varlistentry>
                                     podem ser <literal>'n'</literal> para escala linear ou
                                     <literal>'l'</literal> para escala logarítmica.
                                 </para>
+                                <scilab:image><![CDATA[
+                                    x = linspace(0,10,100)(2:$);
+                                    m = ["nn" "ln" "nl" "ll"];
+                                    clf
+                                    for i = 1:4
+                                        subplot(1,4,i)
+                                        plot2d(m(i), x, x.^2)
+                                        xgrid(color("grey75"),1,7)
+                                        title(msprintf("""%s""",m(i)),"fontsize",3)
+                                        select i
+                                        case 1, gca().sub_ticks = [3 3];
+                                        case 2, gca().sub_ticks = [8 3];
+                                        case 3, gca().sub_ticks = [3 8];
+                                        case 4, gca().sub_ticks = [8 8];
+                                        end
+                                    end
+                                    gcf().axes_size = [800 220];
+                                ]]></scilab:image>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </para>
                                 <para>
                                     These numbers are relative to the
-                                    <literal>gca().parent.figure_size(3:4)</literal>
-                                    or to the <literal>gca().parent.position(3:4)</literal>
+                                    <literal>gca().parent.position(3:4)</literal> [width, height]
                                     dimensions of the figure or of the Uicontrol frame
                                     embedding the axes.
                                 </para>
index ecf35ce..a410f8e 100644 (file)
@@ -468,11 +468,15 @@ asind_1.png=228e297136b7b30666241d462f5c58c8
 asinh_1.png=487c5932acafb700ce3ff3da7dc485a3\r
 atand_1.png=8c5dae12354712ac3fab90999228771c\r
 autumncolormap_1.png=00826c2a0572e5c987444f8bb7d9e66b\r
-axes_properties_en_US_1.png=4969e3dd46c4d3d557cae0944088f2c3\r
-axes_properties_fr_FR_1.png=4969e3dd46c4d3d557cae0944088f2c3\r
-axes_properties_ja_JP_1.png=4969e3dd46c4d3d557cae0944088f2c3\r
-axes_properties_pt_BR_1.png=4969e3dd46c4d3d557cae0944088f2c3\r
-axes_properties_ru_RU_1.png=4969e3dd46c4d3d557cae0944088f2c3\r
+axes_properties_1.png=7be98709869bc90641f5f5224793b44b\r
+axes_properties_2.png=39b7ef77b59dee8544c01142e8a6f4e1\r
+axes_properties_3.png=9f69d8bb42f7272cdae59d196cc6a5e7\r
+axes_properties_4.png=91c4089412926c6fc2e55f37b9f93f3d\r
+axes_properties_en_US_5.png=4969e3dd46c4d3d557cae0944088f2c3\r
+axes_properties_fr_FR_5.png=4969e3dd46c4d3d557cae0944088f2c3\r
+axes_properties_ja_JP_5.png=4969e3dd46c4d3d557cae0944088f2c3\r
+axes_properties_pt_BR_5.png=4969e3dd46c4d3d557cae0944088f2c3\r
+axes_properties_ru_RU_5.png=4969e3dd46c4d3d557cae0944088f2c3\r
 bar_1.png=968aa7a4f076bc4bd450f5ad25845434\r
 bar_2.png=f4c4662565d146bc03ba40b0344897aa\r
 bar_3.png=e658d6bd8080ca95d71ef70c5431f7c8\r
diff --git a/scilab/modules/helptools/images/axes_properties_1.png b/scilab/modules/helptools/images/axes_properties_1.png
new file mode 100644 (file)
index 0000000..f1426d3
Binary files /dev/null and b/scilab/modules/helptools/images/axes_properties_1.png differ
diff --git a/scilab/modules/helptools/images/axes_properties_2.png b/scilab/modules/helptools/images/axes_properties_2.png
new file mode 100644 (file)
index 0000000..2771f03
Binary files /dev/null and b/scilab/modules/helptools/images/axes_properties_2.png differ
diff --git a/scilab/modules/helptools/images/axes_properties_3.png b/scilab/modules/helptools/images/axes_properties_3.png
new file mode 100644 (file)
index 0000000..ae289b7
Binary files /dev/null and b/scilab/modules/helptools/images/axes_properties_3.png differ
diff --git a/scilab/modules/helptools/images/axes_properties_4.png b/scilab/modules/helptools/images/axes_properties_4.png
new file mode 100644 (file)
index 0000000..bd01702
Binary files /dev/null and b/scilab/modules/helptools/images/axes_properties_4.png differ