← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/graphics/segs_properties.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fr/graphics/segs_properties.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>segs_properties</TITLE>
 
6
  <TYPE>Scilab Data type </TYPE>
 
7
  <DATE> 2002 </DATE>
 
8
  <SHORT_DESCRIPTION name="segs_properties"> description of the
 
9
   Segments entity properties </SHORT_DESCRIPTION>
 
10
 
 
11
  <DESCRIPTION>
 
12
  <P>
 
13
  The Segs entity is a leaf of the graphics entities
 
14
  hierarchy. This entity defines the parameters for a set of colored
 
15
  segments or colored arrows.
 
16
  </P>
 
17
  <DESCRIPTION_INDENT>
 
18
   <DESCRIPTION_ITEM label="visible: ">
 
19
    <SP>This field contains the  <VERB>visible</VERB> property value
 
20
   for the entity . It should
 
21
   be <VERB>&quot;on&quot; </VERB> or <VERB>&quot;off&quot;</VERB>  . By default, 
 
22
   the segments are visibles, the value's property is  <VERB>&quot;on&quot;
 
23
   </VERB>. If <VERB>&quot;off&quot;</VERB> the segments are not drawn on the screen.</SP>
 
24
   </DESCRIPTION_ITEM>
 
25
 
 
26
 
 
27
   <DESCRIPTION_ITEM label="data: ">
 
28
    <SP>This field is two column matrix  <VERB>[x,y,[z]]</VERB> which gives
 
29
    the coordinates of the segments boundary.
 
30
    If  <VERB>xv=matrix(x,2,-1)</VERB> and
 
31
    <VERB>yv=matrix(y,2,-1)</VERB> then <VERB>xv(:,k)</VERB> and
 
32
    <VERB>yv(:,k)</VERB> are the boundary coordinates of the segment
 
33
    numbered  <VERB>k</VERB>.</SP>
 
34
   </DESCRIPTION_ITEM>
 
35
 
 
36
    <DESCRIPTION_ITEM label="line_style: ">
 
37
      <SP>The  <VERB>line_style</VERB> property value should be an integer in [0 9].
 
38
       0 stands for solid the other value stands for a selection of
 
39
       dashes. This property applies to all segments.</SP>
 
40
     </DESCRIPTION_ITEM>
 
41
 
 
42
     <DESCRIPTION_ITEM label="thickness: ">
 
43
       <SP>This field contains the  <VERB>thickness</VERB> property for
 
44
       all segments. Its value should
 
45
       be a non negative integer..</SP>
 
46
     </DESCRIPTION_ITEM>
 
47
 
 
48
      <DESCRIPTION_ITEM label="arrow_size: ">
 
49
       <SP>If the value of this property is 0, segments are drawn, else
 
50
       arrows are drawn and the size of the arrows is given by the
 
51
       absolute value of this property.</SP>
 
52
     </DESCRIPTION_ITEM>
 
53
 
 
54
 
 
55
     <DESCRIPTION_ITEM label="segs_color: ">
 
56
      <SP>This field contains the vector of colors to use to draw each
 
57
      segment. Each element is a color index relative to the current colormap.</SP>
 
58
     </DESCRIPTION_ITEM>
 
59
 
 
60
     <DESCRIPTION_ITEM label="clip_state: ">
 
61
      <SP>This field contains the <VERB>clip_state</VERB> property
 
62
      value for the segments. It should be :</SP>
 
63
      <DESCRIPTION_INDENT>
 
64
         <DESCRIPTION_ITEM > 
 
65
         <SP><VERB>&quot;off&quot;</VERB> this means that the segments is not clipped.</SP>
 
66
         </DESCRIPTION_ITEM>
 
67
 
 
68
         <DESCRIPTION_ITEM > 
 
69
         <SP><VERB>&quot;clipgrf&quot;</VERB> this means that the
 
70
         segments is clipped outside the Axes box.</SP>
 
71
         </DESCRIPTION_ITEM>
 
72
 
 
73
        <DESCRIPTION_ITEM > 
 
74
         <SP><VERB>&quot;on&quot;</VERB> this means that the
 
75
         segments is clipped outside the rectangle given by the property  <VERB>clip_box</VERB>.</SP>
 
76
         </DESCRIPTION_ITEM>
 
77
      </DESCRIPTION_INDENT>
 
78
     </DESCRIPTION_ITEM>
 
79
 
 
80
     <DESCRIPTION_ITEM label="clip_box: ">
 
81
      <SP>This field contains the  <VERB>clip_box</VERB> property.
 
82
      By default segment are not clipped, clip_state is &quot;off&quot;, so the value should be an empty 
 
83
      matrix .Other cases the vector <VERB>[x,y,w,h]</VERB> (upper-left point width height) 
 
84
       defines the portions of the segments to display, however <VERB>clip_state</VERB> property 
 
85
       value will be changed.</SP>
 
86
     </DESCRIPTION_ITEM>
 
87
 
 
88
     <DESCRIPTION_ITEM label="parent: "> 
 
89
      <SP>This property contains the handle of the parent. The parent of the segment
 
90
      entity should be of the type <VERB>&quot;Axes&quot;</VERB> or <VERB>&quot;Agregation&quot;</VERB>.</SP>
 
91
     </DESCRIPTION_ITEM>
 
92
  
 
93
  </DESCRIPTION_INDENT>
 
94
  </DESCRIPTION>
 
95
  <EXAMPLE><![CDATA[
 
96
 
 
97
  set("figure_style","new") //create a figure
 
98
   a=get("current_axes");//get the handle of the newly created axes
 
99
   a.data_bounds=[-10,-10;10,10];
 
100
   x=2*%pi*(0:7)/8;
 
101
   xv=[2*sin(x);9*sin(x)];
 
102
   yv=[2*cos(x);9*cos(x)];
 
103
   xsegs(xv,yv,1:8)
 
104
 
 
105
   s=a.children
 
106
   s.arrow_size=1;
 
107
    s.segs_color=15:22;
 
108
    for j=1:2
 
109
      for i=1:8
 
110
        h=s.data(i*2,j);
 
111
        s.data(i*2,j)=s.data(i*2-1,j);
 
112
        s.data(i*2-1,j)=  h;
 
113
       end
 
114
    end
 
115
 
 
116
   s.segs_color=5; //set all the colors to 5
 
117
 
 
118
   s.clip_box=[-4,4,8,8];
 
119
   a.thickness=4;
 
120
   xrect(s.clip_box);
 
121
 
 
122
 ]]></EXAMPLE>
 
123
  <SEE_ALSO>
 
124
    <SEE_ALSO_ITEM> <LINK>set</LINK> </SEE_ALSO_ITEM>
 
125
    <SEE_ALSO_ITEM> <LINK>get</LINK> </SEE_ALSO_ITEM>
 
126
    <SEE_ALSO_ITEM> <LINK>delete</LINK> </SEE_ALSO_ITEM>
 
127
    <SEE_ALSO_ITEM> <LINK>xsegs</LINK> </SEE_ALSO_ITEM>
 
128
    <SEE_ALSO_ITEM> <LINK>graphics_entities</LINK> </SEE_ALSO_ITEM>
 
129
  </SEE_ALSO>
 
130
<AUTHOR>Djalel ABDMOUCHE  </AUTHOR>
 
131
</MAN>
 
132