bug 4852
[scilab.git] / scilab / modules / graphics / help / en_US / xclip.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) ENPC - Jean-Philippe Chancelier
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-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" version="5.0-subset Scilab" xml:lang="en" xml:id="xclip">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>xclip</refname>
19     <refpurpose> (obsolete) set a clipping zone</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>xclip([x,y,w,h])
24 xclip(rect)
25 xclip("clipgrf")</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>x,y,w,h</term>
32         <listitem>
33           <para>real values.</para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>rect</term>
38         <listitem>
39           <para>row vector of size 4.</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para><literal>xclip</literal> set a clipping zone given by the coordinates, in the current
47     graphics scale, of the rectangle <literal>x,y,w,h</literal> 
48     (upper-left point, width, height). If only one argument is given, it stands
49     for a rectangle specification <literal>rect=[x,y,w,h]</literal>.</para>
50     <para><literal>xclip("clipgrf")</literal> is used to clip the usual rectangle boundaries.</para>
51     <para>
52     To unclip a region use the command <literal>xclip()</literal>.</para>
53         <para>
54                 Function <literal>xclip</literal> is obsolete and will be permanently removed in Scilab 5.2.
55                 To set a clipping zone, please use instead the <literal>clip_state</literal> and <literal>clip_box</literal>
56                 properties of graphic entities.
57         </para>
58   </refsection>
59   <refsection>
60     <title>Examples</title>
61     <programlisting role="example"><![CDATA[ 
62 x=0:0.2:2*%pi;
63 x1=[sin(x);100*sin(x)];
64 y1=[cos(x);100*cos(x)];
65 y1=y1+20*ones(y1);
66
67 // set the frame
68 clf();a=gca();a.data_bounds=[-100 -100;500 600];
69     
70 // No clipping
71 xsegs(10*x1+200*ones(x1),10*y1+200*ones(y1))
72 e=gce(); //handle on the Segs entity
73
74 // draw rectangle clipping zone 
75 xrect(150,460,100,150)
76 // set clip_box for  Segs entity
77 e.clip_box=[150,460,100,150];
78
79 // Set usual rectangle boundaries clipping zone 
80 e.clip_state='clipgrf';
81 xclip("clipgrf")
82 // remove clipping
83 e.clip_state='off';
84  ]]></programlisting>
85   </refsection>
86   <refsection>
87     <title>See Also</title>
88     <simplelist type="inline">
89       <member>
90         <link linkend="axes_properties">axes_properties</link>
91       </member>
92     </simplelist>
93   </refsection>
94   <refsection>
95     <title>Authors</title>
96     <para>J.Ph.C.  </para>
97   </refsection>
98 </refentry>