<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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="ru" xml:id="rubberbox">
    <refnamediv>
        <refname>rubberbox</refname>
        <refpurpose>
            растягиваемая рамка для прямоугольного выделения
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            [final_rect, btn] = rubberbox()
            [final_rect, btn] = rubberbox(initial_rect)
            [final_rect, btn] = rubberbox(edition_mode)
            [final_rect, btn] = rubberbox(initial_rect, edition_mode)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>initial_rect</term>
                <listitem>
                    <para>
                        вектор с двумя или четырьмя элементами. С четырьмя
                        элементами он даёт исходный прямоугольник, определяемый
                        в виде <literal>[x_min, y_max, width, height]</literal>,
                        где <literal>x_min</literal> и <literal>y_max</literal>
                        - координаты начального угла, <literal>width</literal> -
                        ширина и <literal>height</literal> - высота; если элементов два, то
                        ширина и высота предполагаются нулевыми.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>edition_mode</term>
                <listitem>
                    <para>
                        логическое значение, режим редактирования. Если
                        <varname>edition_mode</varname> равно
                        <constant>%t</constant>, то нажатие на кнопку выбирает
                        первый угол, отпуск кнопки выбирает противоположный
                        угол. Если <varname>edition_mode</varname>
                        равен <constant>%f</constant>, то нажатие на кнопку или
                        щелчок выбирает первый угол, для выбора противоположного
                        угла необходимо щёлкнуть ещё раз. Значение по умолчанию
                        равно <constant>%f</constant>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>final_rect</term>
                <listitem>
                    <para>
                        прямоугольник, определяемый как <literal>[x_min, y_max,
                            width, height]
                        </literal>
                        ,где <literal>x_min</literal> и
                        <literal>y_max</literal> - координаты начального угла,
                        <literal>width</literal> - ширина и
                        <literal>height</literal> - высота.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>btn</term>
                <listitem>
                    <para>
                        целое число, количество щелчков кнопкой мыши.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            <code>rubberbox(initial_rect)</code> тянет растягиваемую рамку в
            текущем графическом окне, следуя за мышью. При щелчке мышью
            <function>rubberbox</function> возвращает определение конечного
            прямоугольника в <varname>final_Rect</varname>. Если аргумент
            <varname>initial_rect</varname> не определён, то для фиксации
            положения начального угла необходим щелчок мыши.
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
clf
plot2d()
a = gca();
db = a.data_bounds;
x0 = (db(1)*2+db(2))/3;
dx = (db(2)-db(1))/3;
y0 = (db(3)+db(4)*2)/3;
dy = (db(4)-db(3))/3;
xtitle(msprintf("С исходным начальным углом: x0 = %0.2f, y0 = %0.2f",x0,y0))
r = rubberbox([x0 y0])
]]></programlisting>
        <programlisting role="example"><![CDATA[
clf
plot2d()
a = gca();
db = a.data_bounds;
x0 = (db(1)*2+db(2))/3;
dx = (db(2)-db(1))/3;
y0 = (db(3)+db(4)*2)/3;
dy = (db(4)-db(3))/3;
xtitle(msprintf("С исходной рамкой: x0 = %0.2f, y0 = %0.2f, ширина = %0.2f, высота = %0.2f,",x0-dx/4,y0+dy/5,2*dx,dy))
r = rubberbox([x0-dx/4 y0+dy/5 2*dx dy])
]]></programlisting>
        <programlisting role="example"><![CDATA[
clf
plot2d()
a = gca();
db = a.data_bounds;
x0 = (db(1)*2+db(2))/3;
dx = (db(2)-db(1))/3;
y0 = (db(3)+db(4)*2)/3;
dy = (db(4)-db(3))/3;
xtitle("Режим выбора: нажать -- тащить -- отпустить")
r = rubberbox(%t)
]]></programlisting>
        <programlisting role="example"><![CDATA[
clf
plot2d()
a = gca();
db = a.data_bounds;
x0 = (db(1)*2+db(2))/3;
dx = (db(2)-db(1))/3;
y0 = (db(3)+db(4)*2)/3;
dy = (db(4)-db(3))/3;
xtitle("Режим выбора: щёлкнуть -- тащить -- щёлкнуть")
r = rubberbox()
]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="xrect">xrect</link>
            </member>
            <member>
                <link linkend="xrects">xrects</link>
            </member>
            <member>
                <link linkend="xclick">xclick</link>
            </member>
            <member>
                <link linkend="xgetmouse">xgetmouse</link>
            </member>
            <member>
                <link linkend="dragrect">dragrect</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
