<?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="plot3d3">

    <refnamediv>

        <refname>plot3d3</refname>

        <refpurpose>矩形の小平面により定義される曲面のメッシュプロット</refpurpose>

    </refnamediv>

    <refsynopsisdiv>

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

        <synopsis>plot3d3(X,Y,Z [,vect,theta,alpha,leg,flag,ebox])

            plot3d3(X,Y,Z, &lt;opt_args&gt;)

        </synopsis>

    </refsynopsisdiv>

    <refsection>

        <title>引数</title>

        <variablelist>

            <varlistentry>

                <term>X, Y, Z:</term>

                <listitem>

                    <para>データ構造を定義する実数行列.</para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>vect</term>

                <listitem>

                    <para>実数ベクトル.</para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>&lt;opt_args&gt;</term>

                <listitem>

                    <para>

                        一連の命令<literal>key1=value1,

                            key2=value2

                        </literal>

                        ,...を表し, <literal>key1</literal>,

                        <literal>key2,...</literal> は以下のどれかとすることができます: theta,

                        alpha ,leg,flag,ebox (以下の定義を参照).

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>theta, alpha</term>

                <listitem>

                    <para>観測点の球座標を指定する実数値(単位:度).</para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>leg</term>

                <listitem>

                    <para>各軸のラベルを定義する文字列. @ をフィールドセパレータとし,

                        "X@Y@Z"のようになります.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>flag</term>

                <listitem>

                    <para>大きさ4の実数ベクトル.

                        <literal>flag=[vertical_color, horizontal_color,type,box]</literal>.

                    </para>

                    <variablelist>

                        <varlistentry>

                            <term>vertical_color</term>

                            <listitem>

                                <para>整数 (曲面の色), デフォルトは 3.</para>

                                <para>縦方向のエッジを描画する際に使用される色を定義するカラーマップのインデックス.</para>

                            </listitem>

                        </varlistentry>

                        <varlistentry>

                            <term>horizontal_color</term>

                            <listitem>

                                <para>整数 (曲面の色), デフォルトは 4.</para>

                                <para>水平方向のエッジを描画する際に使用される色を定義するカラーマップのインデックス.</para>

                            </listitem>

                        </varlistentry>

                        <varlistentry>

                            <term>type</term>

                            <listitem>

                                <para>整数 (スケール).</para>

                                <variablelist>

                                    <varlistentry>

                                        <term>type=0:</term>

                                        <listitem>

                                            <para>プロットは

                                                (前の<literal>param3d</literal>,

                                                <literal>plot3d</literal>, <literal>contour</literal> または

                                                <literal>plot3d1</literal>のコールで設定された)

                                                カレントの3次元スケールで行われます.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=1:</term>

                                        <listitem>

                                            <para>

                                                3次元ボックスのスケールがアスペクト比の最大値に基づき

                                                自動的に調整され,

                                                境界はオプションの引数<literal>ebox</literal>の値で

                                                指定されます.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=2:</term>

                                        <listitem>

                                            <para>

                                                3次元ボックスのスケールがアスペクト比の最大値に基づき

                                                自動的に調整され,境界は指令したデータにより計算されます.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=3:</term>

                                        <listitem>

                                            <para>

                                                オプション<literal>ebox</literal>で指定したボックス境界を有する

                                                3次元等軸プロットで,<literal>type=1</literal>に似ています.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=4:</term>

                                        <listitem>

                                            <para>データで定義された境界に基づく3次元等軸プロットで,

                                                <literal>type=2</literal>に似ています.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=5:</term>

                                        <listitem>

                                            <para>

                                                オプション<literal>ebox</literal>で指定されたボックス境界で

                                                定義された境界に基づく3次元拡張等軸プロットで,

                                                <literal>type=1</literal>に似ています.

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>type=6:</term>

                                        <listitem>

                                            <para>

                                                データで定義された境界に基づく3次元拡張等軸プロットで,

                                                <literal>type=2</literal>に似ています.

                                                軸の境界は axes エンティティプロパティによりカスタマイズできる

                                                ことに注意してください(<link linkend="axes_properties">axes_properties</link>参照).

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                </variablelist>

                            </listitem>

                        </varlistentry>

                        <varlistentry>

                            <term>box</term>

                            <listitem>

                                <para>整数 (プロットの周囲のフレーム).</para>

                                <variablelist>

                                    <varlistentry>

                                        <term>box=0:</term>

                                        <listitem>

                                            <para>プロットの周囲に何も描画されません.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>box=1:</term>

                                        <listitem>

                                            <para>実装されていません (box=0と同様).</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>box=2:</term>

                                        <listitem>

                                            <para>曲面の背後の軸のみが描画されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>box=3:</term>

                                        <listitem>

                                            <para>曲面を囲うボックスが描画され,キャプションが追加されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>box=4:</term>

                                        <listitem>

                                            <para>

                                                曲面を囲うボックスが描画され,キャプションと軸が追加されます.

                                            </para>

                                            <para>

                                                軸のアスペクトもaxesエンティティのプロパティによりカスタマイズ

                                                できることに注意してください (<link linkend="axes_properties">axes_properties</link>参照).

                                            </para>

                                        </listitem>

                                    </varlistentry>

                                </variablelist>

                            </listitem>

                        </varlistentry>

                    </variablelist>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>ebox</term>

                <listitem>

                    <para>

                        プロットの境界をベクトル

                        <literal>[xmin,xmax,ymin,ymax,zmin,zmax]</literal>で指定します.

                        この引数は,<literal>flag</literal>の<literal>type</literal>が<literal>1</literal>,

                        <literal>3</literal> または <literal>5</literal>に設定された場合,

                        使用されます (対応する動作については上記参照).

                        <literal>flag</literal> が指定されない場合

                        <literal>ebox</literal> は無視されます.

                    </para>

                    <para>

                        指定された場合, <literal>ebox</literal>引数は,

                        <literal>data_bounds</literal>に基づいて動作し,

                        axesエンティティのプロパティによりリセットすることも可能であることに

                        注意してください. ebox のデフォルト値は[0,1,0,1,0,1]です.(<link linkend="axes_properties">axes_properties</link>参照)

                    </para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            <literal>plot3d3</literal> は矩形の小平面で定義される曲面の

            メッシュ状のプロットを行ないます.

            (X,Y,Z) は曲面を記述する3つの行列です.

            曲面は4角形のポリゴンで構成されます.

        </para>

        <para>

            小平面のX座標は

            X(i,j), X(i+1,j), X(i+1,j+1) および X(i,j+1)で指定されます. 同様に行列 Y および Z

            はYおよびZ座標を有します.

        </para>

        <para>

            <literal>vect</literal>ベクトルは

            同じ(X,Y,Z)行列に複数の曲面がコード化される場合に使用されます.

            <literal>vect(j)</literal> はj番目の曲面が開始されるコードの場所の

            行番号です.詳細な説明は

            <literal>plot3d2</literal>を参照ください.

            mesh プロットと同様,編集可能な唯一利用可能なプロパティは

            <literal>visible</literal>オプションです

            (<link linkend="axes_properties">axes_properties</link>参照).

        </para>

    </refsection>

    <refsection>

        <title>例</title>

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

u = linspace(-%pi/2,%pi/2,40);

v = linspace(0,2*%pi,20);

X = cos(u)'*cos(v);

Y = cos(u)'*sin(v);

Z = sin(u)'*ones(v);

plot3d3(X,Y,Z);

e=gce(); // カレントのエンティティを取得

e.visible='off';

e.visible='on'; // メッシュビューに戻す

 ]]></programlisting>

        <scilab:image>u = linspace(-%pi/2,%pi/2,40);

            v = linspace(0,2*%pi,20);

            X = cos(u)'*cos(v);

            Y = cos(u)'*sin(v);

            Z = sin(u)'*ones(v);

            plot3d3(X,Y,Z);

        </scilab:image>

    </refsection>

    <refsection role="see also">

        <title>参照</title>

        <simplelist type="inline">

            <member>

                <link linkend="plot3d2">plot3d2</link>

            </member>

            <member>

                <link linkend="plot3d">plot3d</link>

            </member>

            <member>

                <link linkend="param3d">param3d</link>

            </member>

        </simplelist>

    </refsection>

</refentry>

