Fix help issues (warnings + wrong format in files)
[scilab.git] / scilab / modules / graphics / help / ja_JP / graphics_entities.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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="graphics_entities">
14     <refnamediv>
15         <refname>graphics_entities</refname>
16         <refpurpose>グラフィックスエンティティデータ構造体の説明</refpurpose>
17     </refnamediv>
18     <refsection>
19         <title>説明</title>
20         <para> Scilabでは,
21             グラフィックウインドウおよびそのウインドウに描画されたもの
22             は階層的なエンティティにより表されます.
23             最上位の階層は Figure (図)です.
24             各 Figure は1個以上のAxes型の子を定義します.
25             各 Axes エンティティは
26             Polylines, Rectangles, Arcs, Segs,...のような
27             一連の葉(leaf)エンティティを有します.
28             エンティティの再帰的な集合のCompound型を有することも可能です.
29             グラフィックモードの主要な関心事は,プロパティの変更をより簡単に
30             することです.このグラフィックモードは,
31             データ,座標やスケーリング,色や外観のようなオブジェクトのプロパティを
32             最初のグラフィックコマンドを再度実行することなく制御するために
33             複数の高レベルグラフ作成ルーチン
34             を提供します (<link linkend="set">set</link>, <link linkend="get">get</link>参照)
35         </para>
36         <para>
37             グラフィックエンティティは<literal>handle</literal>型のScilab変数に
38             対応します.
39             このハンドルは,
40             作成されたグラフィックエンティティの各インスタンスを示すユニークなIDです.
41             このハンドルを用いて, "set" および "get"ルーチンによりエンティティの
42             プロパティにアクセスすることができるようになります.
43             ハンドルはグラフィックオブジェクトを操作したり,移動したり,
44             コピーまたは削除する際にも使用されます.
45         </para>
46         <para/>
47         <variablelist>
48             <varlistentry>
49                 <term>Figure: </term>
50                 <listitem>
51                     <para>
52                         figureエンティティは,グラフィックエンティティ階層の最上位です.
53                         このエンティティは図(figure)本体のパラメータを定義し,
54                         同時に子を作成する際のデフォルト値も定義します.
55                         figureの子はAxesエンティティです.
56                     </para>
57                     <para>カレントのfigure(描画指示が送信されるfigure)のハンドル
58                         は,<literal>get("current_figure")</literal>により取得でき,
59                         <literal>set("current_figure",h)</literal>により設定できます.
60                         ただし, <literal>h</literal> は figureのハンドルまたは
61                         <literal>figure_id</literal> のどちらかです.
62                         後者について,その図がまだ作成されていない場合には,作成されます.
63                     </para>
64                     <para>
65                         詳細は<link linkend="figure_properties">figure_properties</link> 
66                         を参照ください.
67                     </para>
68                 </listitem>
69             </varlistentry>
70             <varlistentry>
71                 <term>Axes: </term>
72                 <listitem>
73                     <para>
74                         Axesエンティティはグラフィックエンティティ階層の第二レベルです.
75                         このエンティティは座標系の変化に関するパラメータおよび
76                         軸に描画されるものを定義し,
77                         同時に,作成される子のデフォルトのパラメータを定義します.
78                         詳細は,<link linkend="axes_properties">axes_properties</link> for
79                         details. The handle on the current Axes may be got using
80                         <literal>get("current_axes")</literal>を参照ください.
81                     </para>
82                 </listitem>
83             </varlistentry>
84             <varlistentry>
85                 <term>Compound: </term>
86                 <listitem>
87                     <para>Compound エンティティは単なる子のベクトルで,
88                         プロパティを1つだけ(visibilityプロパティ)有しています.
89                         これは,一連のエンティティを集約するためのグルーとして
90                         使用されます.
91                     </para>
92                     <para>
93                         <link linkend="glue">glue</link>, <link linkend="unglue">unglue</link>および
94                         <link linkend="Compound_properties">Compound_properties</link> 関数を
95                         参照ください.
96                     </para>
97                 </listitem>
98             </varlistentry>
99             <varlistentry>
100                 <term>Axis: </term>
101                 <listitem>
102                     <para>Axisエンティティはグラフィックエンティティ階層の葉です.
103                         このエンティティは軸の目盛および外観に関するパラメータを定義します.
104                     </para>
105                     <para>
106                         詳細は<link linkend="axis_properties">axis_properties</link> を参照ください.
107                     </para>
108                 </listitem>
109             </varlistentry>
110             <varlistentry>
111                 <term>Polyline: </term>
112                 <listitem>
113                     <para>ポリラインエンティティはグラフィックエンティティ階層の葉です.
114                         このエンティティは,2次元および3次元ポリラインおよび
115                         ポリラインの拡張描画プロパティを定義します.
116                     </para>
117                     <para>
118                         詳細は <link linkend="polyline_properties">polyline_properties</link> を
119                         参照ください.
120                     </para>
121                 </listitem>
122             </varlistentry>
123             <varlistentry>
124                 <term>Arc: </term>
125                 <listitem>
126                     <para>Arcエンティティはグラフィックエンティティ階層の葉です.
127                         このエンティティは楕円および楕円の一部を定義します.
128                     </para>
129                     <para>
130                         詳細は<link linkend="arc_properties">arc_properties</link> を参照ください.
131                     </para>
132                 </listitem>
133             </varlistentry>
134             <varlistentry>
135                 <term>Rectangle: </term>
136                 <listitem>
137                     <para>Rectangleエンティティはグラフィックエンティティ階層の葉です.
138                         このエンティティは矩形および塗りつぶされた矩形のパラメータを
139                         定義します.
140                     </para>
141                     <para>
142                         詳細は<link linkend="rectangle_properties">rectangle_properties</link> 
143                         を参照ください.
144                     </para>
145                 </listitem>
146             </varlistentry>
147             <varlistentry>
148                 <term>Surface: </term>
149                 <listitem>
150                     <para>Surfaceエンティティはグラフィックエンティティ階層の葉です.
151                         このエンティティはサブタイプ <literal>Fac3d</literal> または
152                         <literal>Plot3d</literal>を有します. このエンティティは
153                         3次元プロットのパラメータを定義します.
154                     </para>
155                     <para>
156                         詳細は<link linkend="surface_properties">surface_properties</link> 
157                         を参照ください.
158                     </para>
159                 </listitem>
160             </varlistentry>
161             <varlistentry>
162                 <term>Fec: </term>
163                 <listitem>
164                     <para>Fec エンティティはグラフィックエンティティ階層の葉です.
165                         このエンティティは2次元有限要素プロットを表します.
166                     </para>
167                     <para>
168                         詳細は <link linkend="fec_properties">fec_properties</link> 
169                         を参照ください.
170                     </para>
171                 </listitem>
172             </varlistentry>
173             <varlistentry>
174                 <term>Grayplot: </term>
175                 <listitem>
176                     <para>Grayplot eエンティティはグラフィックエンティティ階層の葉です.
177                         このエンティティは色および画像による曲面の二次元プロット表します.
178                     </para>
179                     <para>
180                         詳細は <link linkend="grayplot_properties">grayplot_properties</link> を参照ください.
181                     </para>
182                 </listitem>
183             </varlistentry>
184             <varlistentry>
185                 <term>Matplot: </term>
186                 <listitem>
187                     <para>Matplot エンティティはグラフィックエンティティ階層の葉です.
188                         このエンティティは整数行列による二次元プロット表します.
189                     </para>
190                     <para>
191                         詳細は <link linkend="Matplot_properties">Matplot_properties</link> を参照ください.
192                     </para>
193                 </listitem>
194             </varlistentry>
195             <varlistentry>
196                 <term>Segs: </term>
197                 <listitem>
198                     <para>Segs エンティティはグラフィックエンティティ階層の葉です. 
199                         このエンティティは,一連の色付の線分または色付の矢印のパラメータを定義します.
200                     </para>
201                     <para>
202                         詳細は <link linkend="segs_properties">segs_properties</link> を参照ください.
203                     </para>
204                 </listitem>
205             </varlistentry>
206             <varlistentry>
207                 <term>Champ: </term>
208                 <listitem>
209                     <para>Champ エンティティはグラフィックエンティティ階層の葉です.
210                         このエンティティは2次元ベクトルフィールドに関するパラメータを定義します.
211                     </para>
212                     <para>
213                         詳細は <link linkend="champ_properties">champ_properties</link> を参照ください.
214                     </para>
215                 </listitem>
216             </varlistentry>
217             <varlistentry>
218                 <term>Text: </term>
219                 <listitem>
220                     <para>Text エンティティはグラフィックエンティティ階層の葉です. 
221                         このエンティティは文字列の描画に関するパラメータを定義します.
222                     </para>
223                     <para>
224                         詳細は <link linkend="text_properties">text_properties</link> を参照ください.
225                     </para>
226                 </listitem>
227             </varlistentry>
228             <varlistentry>
229                 <term>Label: </term>
230                 <listitem>
231                     <para>
232                         Labelエンティティは<literal>Axes</literal>グラフィックエンティティの
233                         子です.このエンティティはグラフィックウィンドウに描画される
234                         x, y, z 軸のラベルとタイトルを定義します.
235                     </para>
236                     <para>
237                         詳細は <link linkend="label_properties">label_properties</link> を参照ください.
238                     </para>
239                 </listitem>
240             </varlistentry>
241             <varlistentry>
242                 <term>Legend: </term>
243                 <listitem>
244                     <para>Legend エンティティはグラフィックエンティティ階層の葉です.
245                         このエンティティは,<literal>plot2dx</literal>グラフに描画される
246                         凡例に関するパラメータを定義します.
247                         このエンティティはまだ開発中です.
248                     </para>
249                     <para>
250                         詳細は <link linkend="legend_properties">legend_properties</link> を参照ください.
251                     </para>
252                 </listitem>
253             </varlistentry>
254         </variablelist>
255     </refsection>
256     <refsection>
257         <title>例</title>
258         <programlisting role="example"><![CDATA[ 
259 //この例を行単位で実行してください
260
261 scf() //エンティティモードで図を作成
262
263 // Figureエンティティのハンドルを取得し,そのプロパティを表示
264 f=get("current_figure") 
265 a=f.children //Axisの子のハンドル
266 x=(1:10)';  plot2d(x,[x.^2 x.^1.5])
267 e=a.children // 2つのポリラインからなるCompoun
268
269 p1=e.children(1) //直近に描画されたポリラインのプロパティ
270 p1.foreground=5;  // ポリラインの色を変更
271 e.children.thickness=5; // 2つのポリラインの幅を変更
272
273 delete(e.children(2))
274
275 move(e.children,[0,30]) //ポリラインを変換
276
277 a.axes_bounds=[0 0 0.5 0.5]; 
278
279 subplot(222) //新たにAxesエンティティを作成
280 plot(1:10);
281 a1=f.children(1); //ハンドルを取得
282 copy(e.children,a1); //最初のプロットのポリラインを新しい軸にコピー
283 a1.data_bounds=[1 0;10 100]; //軸の範囲を変更 
284
285 set("current_figure",10) //figure_id=10の新規図を作成
286 plot3d() //描画データは figure 10に送信される
287 set("current_figure",f) //前の図をカレントの図にする
288 plot2d(x,x^3)  //描画データは最初の図に送信される
289  ]]></programlisting>
290     </refsection>
291     <refsection role="see also">
292         <title>参照</title>
293         <simplelist type="inline">
294             <member>
295                 <link linkend="set">set</link>
296             </member>
297             <member>
298                 <link linkend="get">get</link>
299             </member>
300             <member>
301                 <link linkend="move">move</link>
302             </member>
303             <member>
304                 <link linkend="delete">delete</link>
305             </member>
306             <member>
307                 <link linkend="object_editor">object_editor</link>
308             </member>
309             <member>
310                 <link linkend="plot">plot</link>
311             </member>
312             <member>
313                 <link linkend="surf">surf</link>
314             </member>
315         </simplelist>
316     </refsection>
317 </refentry>