<?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:db="http://docbook.org/ns/docbook"
          xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="champ_properties">
    <refnamediv>
        <refname>champ_properties</refname>
        <refpurpose>2次元ベクトルフィールドエンティティプロパティの説明</refpurpose>
    </refnamediv>
    <refsection>
        <title>説明</title>
        <para>Champエンティティはグラフィックエンティティ階層の葉です.
            このエンティティは2次元ベクトルフィールドのパラメータを定義します.
        </para>
        <variablelist>
            <varlistentry>
                <term>visible: </term>
                <listitem>
                    <para>
                        このプロパティにはエンティティの<literal>visible</literal>
                        プロパティの値が含まれます.この値には,
                        <literal>"on" </literal> または <literal>"off"</literal>を指定します.
                        <literal>"on" </literal>の場合,ベクトルフィールドが描画され,
                        <literal>"off"</literal>の場合,ベクトルフィールドは画面上に
                        表示されません.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>data: </term>
                <listitem>
                    <para>このフィールドは,
                        各要素の行および列のインデックスからなる<literal>"champdata"</literal>
                        型の<literal>tlist</literal>データ構造体を定義します:
                        x および y グリッド座標はそれぞれ
                        <literal>data.x</literal>および <literal>data.y</literal>に
                        含まれます.
                        <literal>data.fx</literal> および <literal>data.fy</literal>という名前の
                        相補フィールドは,それぞれ,点<literal>(x(i),y(j))</literal>における
                        ベクトルフィールドの<literal>x</literal> および <literal>y</literal>要素
                        を定義する行列です.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>user_data: </term>
                <listitem>
                    <para>このフィールドはchampデータ構造体に任意のScilab変数を
                        保存し,再度取得するために使用することができます.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>line_style: </term>
                <listitem>
                    <para>
                        <literal>line_style</literal> プロパティの値は
                        [1 10]の範囲の整数とする必要があります.
                        1は実線,その他の値は破線の選択を意味します
                        (<link linkend="axes_properties">getlinestyle</link>参照).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>thickness: </term>
                <listitem>
                    <para>このプロパティは矢印の幅を指定する正の実数です.
                        表示される幅は,指定された幅を最も近い整数に丸めることにより定義されます.
                        唯一の例外はベクトルのエキスポートで,この場合
                        全体の<literal>thickness</literal>の値が考慮されます.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>colored: </term>
                <listitem>
                    <para>
                        このプロパティの値が<literal>"on"</literal>の場合, フィールドの
                        ベクトルがフィールドのインテンシティに比例した色により描画されます.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>arrow_size: </term>
                <listitem>
                    <para>
                        このプロパティは矢印の大きさを二重に指定します.
                        値は正または負とします.
                        <itemizedlist>
                            <listitem>
                                <para>
                                    <literal>arrow_size &lt; 0</literal>: arrows size は
                                    ベクトルの平均ノルムに比例します.
                                </para>
                            </listitem>
                            <listitem>
                                <para>
                                    <literal>arrow_size &gt; 0</literal>: arrows size は
                                    windowsの次元に比例します.
                                </para>
                            </listitem>
                        </itemizedlist>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>clip_state: </term>
                <listitem>
                    <para>
                        このフィールドには champ の<literal>clip_state</literal>
                        プロパティの値が含まれます.
                        値は以下となります:
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                <literal>"off"</literal>
                                この場合,ベクトルフィールドはクリップされません.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"clipgrf"</literal>
                                この場合,ベクトルフィールドはaxesボックスの外でクリップされます.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"on"</literal>
                                この場合,ベクトルフィールドはclip_boxプロパティで指定された矩形の外で
                                クリップされます.
                            </para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>clip_box: </term>
                <listitem>
                    <para>
                        このプロパティには <literal>clip_box</literal> プロパティが含まれます.
                        この値はclip_state が "off"の場合には空の行列となります.
                        その他の場合,ベクトル <literal>[x,y,w,h]</literal>(左上の点 幅 高さ)
                        は表示するベクトルフィールドの領域を定義しますが,
                        <literal>clip_state</literal>プロパティの値は変更されます.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>parent: </term>
                <listitem>
                    <para>このプロパティには親(parent)のハンドルが含まれます.
                        2次元ベクトルフィールドエンティティの親は
                        <literal>"Axes"</literal> または
                        <literal>"Compound"</literal>型のどちらかです.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
a = get("current_axes");  // 新規に作成された軸のハンドルを取得
a.data_bounds = [-10,-10 ; 10,10];
champ(-5:5, -5:5, rand(11,11), rand(11,11))

c = a.children
set(c, "colored","on", "thickness",2, "arrow_size",-1);
c.data       // "champdata"型のtlistを表示
a.data_bounds = [-5,-5 ; 5,5];
 ]]></programlisting>
        <scilab:image><![CDATA[
        a=get("current_axes");
        a.data_bounds=[-10,-10;10,10];
        champ(-5:5,-5:5,rand(11,11),rand(11,11));
        c=a.children;
        c.colored="on";
        c.thickness=2;
        c.arrow_size=-1;
        a.data_bounds=[-5,-5;5,5];
        ]]></scilab:image>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="set">set</link>
            </member>
            <member>
                <link linkend="get">get</link>
            </member>
            <member>
                <link linkend="delete">delete</link>
            </member>
            <member>
                <link linkend="champ">champ</link>
            </member>
            <member>
                <link linkend="graphics_entities">graphics_entities</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>履歴</title>
        <revhistory>
            <revision>
                <revnumber>5.4.0</revnumber>
                <revremark>line_style 値 0 は廃止されています. 代わりに 1 を使用してください
                    (両者は共に SOLIDを意味します).
                    Scilab 5.4.1 以降, 値0を使用するとエラーとなります.
                </revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>