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

    <refnamediv>

        <refname>segs_properties</refname>

        <refpurpose>Segmentsエンティティプロパティの説明</refpurpose>

    </refnamediv>

    <refsection>

        <title>説明</title>

        <para>Segsエンティティはグラフィックエンティティ階層の葉です. この

            エンティティは色付の線分または色付の矢印の集合に関するパラメータを定義します.

        </para>

        <variablelist>

            <varlistentry>

                <term>parent: </term>

                <listitem>

                    <para>このフィールドには親のハンドルが含まれます.

                        polylineエンティティの親は<literal>"Axes"</literal> 型または

                        <literal>"Compound"</literal>型です.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>children: </term>

                <listitem>

                    <para>

                        このプロパティにはこのハンドルの<literal>children</literal>

                        のベクトルが含まれます.

                        しかし,現在,<literal>segs</literal>ハンドルには<literal>children</literal>がありません.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>visible: </term>

                <listitem>

                    <para>

                        このフィールドはこのエンティティの<literal>visible</literal>

                        プロパティの値を有します.

                        値は<literal>"on" </literal> または <literal>"off"</literal>となります.

                        デフォルトで線分は可視であり,プロパティの値は

                        <literal>"on" </literal>となります. <literal>"off"</literal> の場合,

                        このsegmentsは画面に描画されません.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>data: </term>

                <listitem>

                    <para>このフィールドは線分の端点の座標を指定する2列の行列

                        <literal>[x,y,[z]]</literal> です.

                        <literal>xv=matrix(x,2,-1)</literal> および <literal>yv=matrix(y,2,-1)</literal> の場合,

                        <literal>xv(:,k)</literal>および <literal>yv(:,k)</literal> は

                        <literal>k</literal>番目の線分の端点の座標です.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>line_mode: </term>

                <listitem>

                    <para>

                        このフィールドは線分の<literal>line_mode</literal>プロパティの

                        デフォルト値を有します. この値には <literal>"on" </literal>(線を描画

                        ) または <literal>"off"</literal> (線を描画しない)を指定します.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>line_style: </term>

                <listitem>

                    <para>

                        <literal>line_style</literal>プロパティの値は[1 8]の

                        範囲の整数となります.

                        <literal>1</literal>は実線を意味し,その他の値は破線の類

                        (破線,一点鎖線,長破線,長々破線,点線,二重点線)を意味します.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>thickness: </term>

                <listitem>

                    <para>このプロパティはピクセル単位で線幅を指定する正の実数です.

                        実際の表示幅は指定された幅を最も近い整数に丸めることで定義されます.

                        唯一の例外はベクトル単位のエキスポートで,この場合は全体の

                        <literal>thickness</literal>の値が考慮されます.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>arrow_size: </term>

                <listitem>

                    <para>矢じりの大きさを指定する係数.負の値を指定すると,

                        大きさが矢印の長さにも依存します.線分を描画するには,この値を

                        0 に設定する必要があります.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>segs_color: </term>

                <listitem>

                    <para>このフィールドは各線分を描画する際に使用される色のベクトルを

                        有します.各要素はカレントのカラーマップに基づく色インデックスです.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_mode: </term>

                <listitem>

                    <para>

                        このフィールドはポリラインの<literal>mark_mode</literal>

                        プロパティのデフォルト値を有します.

                        この値は<literal>"on"</literal> (マーカを描画

                        drawn) または <literal>"off"</literal> (マーカを描画しない)となります.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_style: </term>

                <listitem>

                    <para>

                        <literal>mark_style</literal>プロパティの値は

                        <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の場合に,

                        使用するマーカの種類を選択するために使用されます.

                        この値は[0 14]の範囲の整数で,それぞれ以下の意味があります :

                        ドット,プラス,十字,星,塗りつぶした菱形,

                        上向き三角形, 下向き三角形, 菱形プラス,円,アスタリスク,

                        正方形,右向き三角形,左向き三角形およびペンタグラム.

                        以下の図は,マーカのアスペクトが<literal>mark_style</literal>,

                        <literal>mark_foreground</literal> および

                        <literal>mark_background</literal>プロパティに依存する

                        ことを示します.

                    </para>

                    <para>

                        <inlinemediaobject>

                            <imageobject>

                              <imagedata fileref="../../images/marks.svg"/>

                            </imageobject>

                        </inlinemediaobject>

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_size_unit: </term>

                <listitem>

                    <para>

                        このフィールは<literal>mark_size_unit</literal>プロパティのデフォルト値

                        を有します.<literal>mark_size_unit</literal>が<literal>"point"</literal>

                        に設定された場合,<literal>mark_size</literal>の値はポイント単位で直接

                        指定されます.

                        <literal>mark_size_unit</literal> に<literal>"tabulated"</literal>が

                        指定された場合,<literal>mark_size</literal>はfont size配列に相対的に

                        計算されます: この場合,この値は,

                        8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する

                        [0 5]の範囲の整数とします.

                        <link linkend="xrect">xrect</link>および Scilabのネーティブ関数は

                        <literal>tabulated</literal>モードをデフォルトとします;

                        <link linkend="plot">plot</link>関数を使用する場合,

                        <literal>point</literal> モードが自動的に有効となります.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_size: </term>

                <listitem>

                    <para>

                        <literal>mark_size</literal>プロパティは,

                        <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の時,

                        マーカの大きさを選択するために使用されます.

                        この値は, 8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する

                        [0 5]の範囲の整数です.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_foreground: </term>

                <listitem>

                    <para>

                        このフィールドは,マーカの縁の色である<literal>mark_foreground</literal>

                        プロパティの値を有します.この値は(カレントのcolor_mapに関連する)色インデックス

                        または透過エッジを意味する 0 とします.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>mark_background: </term>

                <listitem>

                    <para>このフィールドは,マーカの前景色である

                        <literal>mark_background</literal>プロパティの値を有します.

                        この値は(カレントのcolor_mapに関連する)色インデックス

                        または透過面を意味する 0 とします.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>clip_state: </term>

                <listitem>

                    <para>

                        このフィールドは線分の<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>プロパティを定義します.

                        デフォルトで線分はクリップされず,

                        <literal>clip_state</literal> は <literal>"off"</literal> です.

                        このため,この値は空の行列となります.

                        その他の場合, ベクトル<literal>[x,y,w,h]</literal> (左上の点 幅 高さ)

                        は表示する線分の部分を定義し,

                        <literal>clip_state</literal>プロパティの値が変更されます.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>user_data: </term>

                <listitem>

                    <para>

                        このフィールドは <literal>segs</literal>

                        データ構造体に任意のScilab変数を

                        保存し,再度取得する際に使用できます.

                    </para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>例</title>

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

a=get("current_axes");//新規に作成された軸のハンドルを取得

a.data_bounds=[-10,-10;10,10];

x=2*%pi*(0:7)/8;

xv=[2*sin(x);9*sin(x)];

yv=[2*cos(x);9*cos(x)];

xsegs(xv,yv,1:8)



s=a.children

s.arrow_size=1;

s.segs_color=15:22;

for j=1:2

  for i=1:8

    h=s.data(i*2,j);

    s.data(i*2,j)=s.data(i*2-1,j);

    s.data(i*2-1,j)=  h;

  end

end



s.segs_color=5; //全ての線分の色を 5 に設定



s.clip_box=[-4,4,8,8];

a.thickness=4;

xrect(s.clip_box);

 ]]></programlisting>

    </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="xsegs">xsegs</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 を

                    使用してください (両者は共に実線で等価です).

                    値 0 は Scilab 5.4.1 でエラーとなります.

                </revremark>

            </revision>

        </revhistory>

    </refsection>

</refentry>



