<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Djalel Abdemouche
 *
 * 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="en" xml:id="move">
    <refnamediv>
        <refname>move</refname>
        <refpurpose>
            move, translate, a graphic entity and its children.
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>move(h,t)
            move(h,t,"alone")
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>a handle, the handle of the entity to move.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>
                        an array, either <literal>[dx,dy]</literal> or [dx,dy,dz], which gives the translation
                        vector to apply.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>"alone" </term>
                <listitem>
                    <para>string keyword (optional).</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            This routine can be used to apply a translation to a graphics entity.
            If the entity has children, they will be also translated.
        </para>
        <para>
            Given the keyword <literal>"alone"</literal>, only the specified entity needs to be redrawn.
            It must specially be used with the <literal>pixel_drawing_mode</literal>
            property of the figure entity (see draw objects under
            <literal>"xor"</literal> drawing mode).
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
plot3d();
a=gca();
p=a.children(1);
t=[1,0,-1.25];
move(p,t);
 ]]></programlisting>
        <scilab:image>
            plot3d();
            a=gca();
            p=a.children(1);
            t=[1,0,-1.25];
            move(p,t);
        </scilab:image>

    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="get">get</link>
            </member>
            <member>
                <link linkend="set">set</link>
            </member>
            <member>
                <link linkend="figure_properties">figure_properties</link>
            </member>
            <member>
                <link linkend="graphics_entities">graphics_entities</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
