<?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="ja" xml:id="addcolor">

    <refnamediv>

        <refname>addcolor</refname>

        <refpurpose>カレントのカラーマップに新色を追加する</refpurpose>

    </refnamediv>

    <refsynopsisdiv>

        <title>呼び出し手順</title>

        <synopsis>new=addcolor(c)</synopsis>

    </refsynopsisdiv>

    <refsection>

        <title>引数</title>

        <variablelist>

            <varlistentry>

                <term>new</term>

                <listitem>

                    <para>新しい色テーブルで c で定義された色のID.</para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>c</term>

                <listitem>

                    <para>3列の行列, RGBカラー定義.</para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            <literal>addcolor</literal> は引数<literal>c</literal>で指定された新色を

            カレントのカラーマップに追加します.

            <literal>c</literal>は3つの列<literal>[R G B]</literal>

            (<literal>R</literal> は赤要素, <literal>G</literal> は緑要素,

            <literal>B</literal> は青要素)

            を有する行列である必要があります.

            <literal>c</literal>の各エントリは1以下の非負の数です.

        </para>

        <para>

            新色のIDが<literal>new</literal>に返されます.

        </para>

        <para>

            <literal>c</literal>で定義した色が既にカレントの色マップに存在する場合,

            その色は追加されません.

        </para>

    </refsection>

    <refsection>

        <title>例</title>

        <programlisting role="example"><![CDATA[

plot3d();

h = gcf();

h.color_map = jet(16);

addcolor(name2rgb('grey')/255);

 ]]></programlisting>

        <scilab:image>

            plot3d();

            h = gcf();

            h.color_map = jet(16);

            addcolor(name2rgb('grey')/255);

        </scilab:image>

    </refsection>

    <refsection role="see also">

        <title>参照</title>

        <simplelist type="inline">

            <member>

                <link linkend="colormap">colormap</link>

            </member>

            <member>

                <link linkend="name2rgb">name2rgb</link>

            </member>

        </simplelist>

    </refsection>

</refentry>

