<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>

  <TITLE>arc_properties</TITLE>

  <TYPE>Scilab Data type</TYPE>

  <DATE>2002</DATE>

  <SHORT_DESCRIPTION name="arc_properties">description of the Arc entity
  properties</SHORT_DESCRIPTION>

  <DESCRIPTION>
    <P>The Arc entity is a leaf of the graphics entities hierarchy. This
    entity defines the parameters for ellipses and part of ellipses and the
    filled ones.</P>

    <DESCRIPTION_INDENT>
      <DESCRIPTION_ITEM label="parent: ">
        <SP>This field contains the handle of the parent. The parent of the
        arc entity should be of the type <VERB>"Axes"</VERB> or
        <VERB>"Compound"</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="children: ">
        <SP>This property contains a vector with the <VERB>children</VERB> of
        the handle. However, <VERB>arc</VERB> handles currently do not have
        any <VERB>children</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="thickness: ">
        <SP>This field contains the line <VERB>thickness</VERB> property. Its
        value should be positive integer.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="line_style: ">
        <SP>The <VERB>line_style</VERB> property value should be an integer in
        [1 6]. 1 stands for solid the other value stands for a selection of
        dashes.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="line_mode: ">
        <SP>This property allows to display or not the line representing the
        arc. The value must be <VERB>"on"</VERB> or <VERB>"off"</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="fill_mode: ">
        <SP>If <VERB>fill_mode</VERB> property value is <VERB>"on" </VERB>,
        the arc is filled with the <VERB>background</VERB> color.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="foreground: ">
        <SP>This field contains the default <VERB>foreground</VERB> property
        value used to draw or to fill arc. It should be a color index
        (relative to the current colormap).</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="background: ">
        <SP>This field contains the color used to fill the arc. It should be a
        color index (relative to the current colormap).</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="data: ">
        <SP>This property is to return the coordinates of the upper-left
        point, the width and the height of the inclosing rectangle as well as
        the boundary angles of the sector. It is the matrix
        <VERB>[xleft,yup,[zup],width,height,a1,a2]</VERB> where
        <VERB>a1/64</VERB> and <VERB>a2/64</VERB> are the sector boundary
        angles in degree.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="visible: ">
        <SP>This field contains the <VERB>visible</VERB> property value for
        the entity . It should be <VERB>"on" </VERB> or <VERB>"off"</VERB>. If
        <VERB>"on"</VERB> the arc is drawn, If <VERB>"off"</VERB> the arc is
        not displayed on the screen.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="clip_state: ">
        <SP>This field contains the <VERB>clip_state</VERB> property value for
        the arc. Clip_state value should be :</SP>

        <DESCRIPTION_INDENT>
          <DESCRIPTION_ITEM>
            <SP><VERB>"off"</VERB> this means that the arc is not clipped</SP>
          </DESCRIPTION_ITEM>

          <DESCRIPTION_ITEM>
            <SP><VERB>"clipgrf"</VERB> this means that the arc is clipped
            outside the Axes box.</SP>
          </DESCRIPTION_ITEM>

          <DESCRIPTION_ITEM>
            <SP><VERB>"on"</VERB> this means that the arc is clipped outside
            the arc given by property clip_box.</SP>
          </DESCRIPTION_ITEM>
        </DESCRIPTION_INDENT>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="clip_box: ">
        <SP>This field is to determinate the <VERB>clip_box</VERB> property.
        By Default its value should be an empty matrix if clip_state is "off".
        Other cases the vector <VERB>[x,y,w,h]</VERB> (upper-left point width
        height) defines the portions of the arc to display, however
        <VERB>clip_state</VERB> property value will be changed.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="user_data: ">
        <SP>This field can be use to store any scilab variable in the arc data
        structure, and to retreive it.</SP>
      </DESCRIPTION_ITEM>
    </DESCRIPTION_INDENT>
  </DESCRIPTION>

  <EXAMPLE><![CDATA[
   set("figure_style","new") //create a figure
   a=get("current_axes");//get the handle of the newly created axes
   a.data_bounds=[-2,-2;2,2];

   xarc(-1.5,1.5,3,3,0,360*64)

   arc=get("hdl"); //get handle on current entity (here the arc entity)
   arc.fill_mode="on";
   arc.foreground=5;
   arc.data(:,[3 6])=[2 270*64];  
   xfarc(-.5,1,.4,.6,0,360*64);
   arc.visible="off";

 ]]></EXAMPLE>

  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>set</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>get</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>delete</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>xarc</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>xarcs</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>xfarc</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>xfarcs</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>graphics_entities</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>

  <AUTHOR>Djalel ABDEMOUCHE</AUTHOR>
</MAN>
