0c0fae27381ee5753c87eef0a46b2c652a15b398
[scilab.git] / scilab / modules / graphics / help / ja_JP / object_editor.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4
5  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
6
7  * Copyright (C) INRIA - Fabrice Leray
8
9  *
10
11
12  * Copyright (C) 2012 - 2016 - Scilab Enterprises
13  *
14  * This file is hereby licensed under the terms of the GNU GPL v2.0,
15  * pursuant to article 5.3.4 of the CeCILL v.2.1.
16  * This file was originally licensed under the terms of the CeCILL v2.1,
17  * and continues to be available under such terms.
18  * For more information, see the COPYING file which you should have received
19  * along with this program.
20
21  *
22
23  -->
24
25 <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="object_editor">
26
27     <refnamediv>
28
29         <refname>object_editor </refname>
30
31         <refpurpose>グラフィックオブジェクトエディタの機能に関する説明</refpurpose>
32
33     </refnamediv>
34
35     <refnamediv xml:id="graphic">
36
37         <refname>graphic </refname>
38
39         <refpurpose>グラフィックオブジェクトエディタの機能に関する説明</refpurpose>
40
41     </refnamediv>
42
43     <refnamediv xml:id="menus">
44
45         <refname>menus</refname>
46
47         <refpurpose>グラフィックオブジェクトエディタの機能に関する説明</refpurpose>
48
49     </refnamediv>
50
51     <refsection>
52
53         <title>説明</title>
54
55         <para>Scilab graphics allow the
56
57             user to have interaction with graphics before and after having them
58
59             drawn. Each graphics window and the
60
61             drawing it contains are represented by hierarchical entities. The hierachy
62
63             top level is the Figure. Each Figure defines at least one child of type
64
65             Axes. Each Axes entity contains a set of leaf entities which are the basic
66
67             graphics objects like Polylines, Rectangles, Arcs, Segs,... It can also
68
69             contain a Compound type which are recursive sets of entities.
70
71         </para>
72
73         <para>The main interest of the graphic mode is to make property changes
74
75             easier. This graphics'mode provides a set of high-level graphing
76
77             routines (see <link linkend="set">set</link>, <link linkend="get">get</link>) used to control objects'
78
79             properties such as data, coordinates and scaling, color and appearences
80
81             without requiring to replay the initial graphics commands.
82
83         </para>
84
85         <para>Graphics entities are associated to Scilab variables of type
86
87             <literal>handle</literal>. The handle is a unique identifier which is associated
88
89             to each instance of a created graphical entity. Using this handle, it will
90
91             be possible to reach entities' properties through "set" and "get"
92
93             routines. The handles are also used to manipulate graphics objects, to
94
95             move them, to make copies or delete them.
96
97         </para>
98
99         <para>To complete and use the graphics handle capacity at its maximum, a
100
101             graphic object editor has been created too. It is a set of Tcl/Tk
102
103             interfaces available for each kind of graphics objects (see
104
105             <link linkend="graphics_entities">graphics_entities</link> for more details) that can be enabled for
106
107             each graphic window. To make it work, select the <literal>Edit</literal> menu in
108
109             the graphic window. Seven graphics editing operations are available :
110
111         </para>
112
113         <para/>
114
115         <variablelist>
116
117             <varlistentry>
118
119                 <term>Select figure as current: </term>
120
121                 <listitem>
122
123                     <para>Let this</para>
124
125                     <para>figure be the current one.</para>
126
127                     <para/>
128
129                 </listitem>
130
131             </varlistentry>
132
133             <varlistentry>
134
135                 <term>Redraw figure: </term>
136
137                 <listitem>
138
139                     <para>Redraw the content of the graphics window.</para>
140
141                     <para/>
142
143                 </listitem>
144
145             </varlistentry>
146
147             <varlistentry>
148
149                 <term>Erase figure: </term>
150
151                 <listitem>
152
153                     <para>Erase the content of the graphics window. Its action corresponds
154
155                         to <literal>clf</literal> routine.
156
157                     </para>
158
159                     <para/>
160
161                 </listitem>
162
163             </varlistentry>
164
165             <varlistentry>
166
167                 <term>Copy object: </term>
168
169                 <listitem>
170
171                     <para>Using the mouse, it allows the user to select a 2D object (like a
172
173                         curve, a rectangle...) and put it in the clipboard. Thus, by a next
174
175                         call to <literal>Paste object</literal>, the object is copied in the
176
177                         selected current axes.
178
179                     </para>
180
181                     <para/>
182
183                 </listitem>
184
185             </varlistentry>
186
187             <varlistentry>
188
189                 <term>Paste object: </term>
190
191                 <listitem>
192
193                     <para>Allow the user to paste a previous object put into in the
194
195                         clipboard inside the selected current axes.
196
197                     </para>
198
199                     <para/>
200
201                 </listitem>
202
203             </varlistentry>
204
205             <varlistentry>
206
207                 <term>Move object: </term>
208
209                 <listitem>
210
211                     <para>Using the mouse, it allows the user to move a 2D object (like a
212
213                         curve, a rectangle...) inside the selected current axes.
214
215                     </para>
216
217                     <para/>
218
219                 </listitem>
220
221             </varlistentry>
222
223             <varlistentry>
224
225                 <term>Delete object: </term>
226
227                 <listitem>
228
229                     <para>Using the mouse, it allows the user to pick up a 2D object (like a
230
231                         curve, a rectangle...) inside the selected current axes and to delete
232
233                         it instantly.
234
235                     </para>
236
237                     <para/>
238
239                 </listitem>
240
241             </varlistentry>
242
243             <varlistentry>
244
245                 <term>Figure Properties: </term>
246
247                 <listitem>
248
249                     <para>Launch the Tcl/Tk interface for the Figure object applied to the
250
251                         figure handle of the graphics window.
252
253                     </para>
254
255                     <para/>
256
257                 </listitem>
258
259             </varlistentry>
260
261             <varlistentry>
262
263                 <term>Current Axes Properties: </term>
264
265                 <listitem>
266
267                     <para>Launch the Tcl/Tk interface for the Axes object applied to the
268
269                         current axes handle of the graphics window.
270
271                     </para>
272
273                     <para/>
274
275                 </listitem>
276
277             </varlistentry>
278
279             <varlistentry>
280
281                 <term>Start Entity Picker: </term>
282
283                 <listitem>
284
285                     <para>Start an event handler on the graphics window to catch the mouse
286
287                         clicks on graphics objects and launch the corresponding Tcl/Tk
288
289                         interface. The left mouse-click allows object edition and the right
290
291                         click performs a move of the selected object. Note that, for now, this
292
293                         feature is applied to 2D objects only.
294
295                     </para>
296
297                     <para/>
298
299                 </listitem>
300
301             </varlistentry>
302
303             <varlistentry>
304
305                 <term>Stop Entity Picker: </term>
306
307                 <listitem>
308
309                     <para>Stop the action of the Entity Picker by terminating the event
310
311                         handler on the graphics window.
312
313                     </para>
314
315                     <para/>
316
317                 </listitem>
318
319             </varlistentry>
320
321         </variablelist>
322
323         <para>
324
325             Once the graphic interface is enabled (using the <literal>Figure
326
327                 Properties
328
329             </literal>
330
331             or <literal>Current Axes Properties</literal> options), two
332
333             main areas appear :
334
335         </para>
336
337         <para/>
338
339         <para/>
340
341         <variablelist>
342
343             <varlistentry>
344
345                 <term>A tree selector: </term>
346
347                 <listitem>
348
349                     <para>Placed on the left side of the graphical editor, a hierarchical
350
351                         tree selector specifies which object is currently edited. It can be
352
353                         used to switch from a graphic object to another provided that they are
354
355                         in the same graphic window.
356
357                     </para>
358
359                 </listitem>
360
361             </varlistentry>
362
363         </variablelist>
364
365         <para>
366
367             <inlinemediaobject>
368
369                 <imageobject>
370
371                     <imagedata fileref="../images/tree.gif"/>
372
373                 </imageobject>
374
375             </inlinemediaobject>
376
377         </para>
378
379         <para/>
380
381         <variablelist>
382
383             <varlistentry>
384
385                 <term>A notebook: </term>
386
387                 <listitem>
388
389                     <para>The second area represents a notebook composed with different
390
391                         properties pages (like <literal>Style</literal>, <literal>Data</literal>,
392
393                         <literal>Clipping</literal>...) depending on the selected graphic object.
394
395                         Using this editor, man can edit more easily the whole properties set
396
397                         of each graphic object (like through the <literal>"set"</literal> and
398
399                         <literal>"get"</literal> commands). Here is an example of the axes' notebook
400
401                         displaying axes properties:
402
403                     </para>
404
405                 </listitem>
406
407             </varlistentry>
408
409         </variablelist>
410
411         <para>
412
413             <inlinemediaobject>
414
415                 <imageobject>
416
417                     <imagedata fileref="../images/notebook.gif"/>
418
419                 </imageobject>
420
421             </inlinemediaobject>
422
423         </para>
424
425         <para/>
426
427         <para>Furthermore, you can legend/annotate your figure using sample
428
429             primitives given inside the <literal>Insert</literal> menu in the graphic
430
431             window. Using the mouse and following the instruction in the message
432
433             subwindow, you can add a:
434
435         </para>
436
437         <para/>
438
439         <variablelist>
440
441             <varlistentry>
442
443                 <term>Line: </term>
444
445                 <listitem>
446
447                     <para>Draw a line between 2 left mouse clicks. The line lives in the
448
449                         axes where the first point was selected.
450
451                     </para>
452
453                 </listitem>
454
455             </varlistentry>
456
457         </variablelist>
458
459         <para/>
460
461         <variablelist>
462
463             <varlistentry>
464
465                 <term>Polyline: </term>
466
467                 <listitem>
468
469                     <para>Draw a polyline by clicking on the left button to define the line
470
471                         path and right click at last to complete the drawing. The polyline
472
473                         lives in the axes where the first point was selected.
474
475                     </para>
476
477                 </listitem>
478
479             </varlistentry>
480
481         </variablelist>
482
483         <para/>
484
485         <variablelist>
486
487             <varlistentry>
488
489                 <term>Arrow: </term>
490
491                 <listitem>
492
493                     <para>Draw an arrow between 2 left mouse clicks. The arrow lives in the
494
495                         axes where the first point was selected.
496
497                     </para>
498
499                 </listitem>
500
501             </varlistentry>
502
503         </variablelist>
504
505         <para/>
506
507         <variablelist>
508
509             <varlistentry>
510
511                 <term>Double arrow: </term>
512
513                 <listitem>
514
515                     <para>Draw a double-sided arrow between 2 left mouse clicks. The double
516
517                         arrow lives in the axes where the first point was selected.
518
519                     </para>
520
521                 </listitem>
522
523             </varlistentry>
524
525         </variablelist>
526
527         <para/>
528
529         <variablelist>
530
531             <varlistentry>
532
533                 <term>Text: </term>
534
535                 <listitem>
536
537                     <para>Open a dialog box to enter the text, then click on the figure
538
539                         window to place it. The text lives in the axes where the point was
540
541                         selected.
542
543                     </para>
544
545                 </listitem>
546
547             </varlistentry>
548
549         </variablelist>
550
551         <para/>
552
553         <variablelist>
554
555             <varlistentry>
556
557                 <term>Rectangle: </term>
558
559                 <listitem>
560
561                     <para>Draw a rectangle : 2 left mouse clicks define respectively the
562
563                         upper left corner and the lower-right corner of the rectangle. The
564
565                         rectangle lives in the axes where the first point was selected.
566
567                     </para>
568
569                 </listitem>
570
571             </varlistentry>
572
573         </variablelist>
574
575         <para/>
576
577         <variablelist>
578
579             <varlistentry>
580
581                 <term>Circle: </term>
582
583                 <listitem>
584
585                     <para>Draw a circle : 2 left mouse clicks define respectively the upper
586
587                         left corner and the lower-right corner of the bounding-box where the
588
589                         circle lives. The rectangle lives in the axes where the first point
590
591                         was selected.
592
593                     </para>
594
595                 </listitem>
596
597             </varlistentry>
598
599         </variablelist>
600
601     </refsection>
602
603     <refsection>
604
605         <title>参照o</title>
606
607         <simplelist type="inline">
608
609             <member>
610
611                 <link linkend="graphics_entities">graphics_entities</link>
612
613             </member>
614
615             <member>
616
617                 <link linkend="set">set</link>
618
619             </member>
620
621             <member>
622
623                 <link linkend="get">get</link>
624
625             </member>
626
627             <member>
628
629                 <link linkend="clf">clf</link>
630
631             </member>
632
633             <member>
634
635                 <link linkend="plot">plot</link>
636
637             </member>
638
639         </simplelist>
640
641     </refsection>
642
643 </refentry>
644