little_helpers/tikz/sketch-0.2.161/Doc/sketch/Forms-of-references.html

   1 <html lang="en">
   2 <head>
   3 <title>Forms of references - Sketch</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="Sketch">
   6 <meta name="generator" content="makeinfo 4.7">
   7 <link title="Top" rel="start" href="index.html#Top">
   8 <link rel="up" href="Definitions.html#Definitions" title="Definitions">
   9 <link rel="prev" href="Forms-of-definitions.html#Forms-of-definitions" title="Forms of definitions">
  10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  11 <!--
  12 Copyright (C) 2005, 2006, 2007, 2008 Eugene K. Ressler.
  13
  14 This manual is for `sketch', version 0.2 (build 161),
  15 Tuesday, September 08, 2009, a program that converts descriptions of simple
  16 three-dimensional scenes into static drawings. This version generates
  17 `PSTricks' or `PGF/TikZ' code suitable for use with the
  18 TeX document processing system.
  19
  20 `Sketch' is free software; you can redistribute it and/or modify
  21 it under the terms of the GNU General Public License as published by
  22 the Free Software Foundation; either version 3, or (at your option)
  23 any later version.
  24
  25 Sketch is distributed in the hope that it will be useful,
  26 but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 GNU General Public License for more details.
  29
  30 You should have received a copy of the GNU General Public License
  31 along with `sketch'; see the file COPYING.txt.  If not, see
  32 http://www.gnu.org/copyleft.-->
  33 <meta http-equiv="Content-Style-Type" content="text/css">
  34 <style type="text/css"><!--
  35   pre.display { font-family:inherit }
  36   pre.format  { font-family:inherit }
  37   pre.smalldisplay { font-family:inherit; font-size:smaller }
  38   pre.smallformat  { font-family:inherit; font-size:smaller }
  39   pre.smallexample { font-size:smaller }
  40   pre.smalllisp    { font-size:smaller }
  41   span.sc { font-variant:small-caps }
  42   span.roman { font-family: serif; font-weight: normal; }
  43 --></style>
  44 </head>
  45 <body>
  46 <div class="node">
  47 <p>
  48 <a name="Forms-of-references"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="Forms-of-definitions.html#Forms-of-definitions">Forms of definitions</a>,
  49 Up:&nbsp;<a rel="up" accesskey="u" href="Definitions.html#Definitions">Definitions</a>
  50 <hr><br>
  51 </div>
  52
  53 <h4 class="subsection">3.3.2 Forms of references</h4>
  54
  55 <p>References to defined names are enclosed in bracketing delimiters.
  56 The delimiter characters imply the type of the associated value as
  57 shown in the table below.  A type error is raised if the type of a
  58 reference does not match the type of the defined value.  The intent of
  59 this mechanism is, again, to make <code>sketch</code> input files more
  60 readable.
  61    <p><table summary=""><tr align="left"><th valign="top">Type  </th><th valign="top">Reference
  62 <br></th></tr><tr align="left"><td valign="top">scalar    </td><td valign="top"><var>id</var>
  63 <a name="index-scalar-reference-347"></a><a name="index-reference_002c-scalar-348"></a><br></td></tr><tr align="left"><td valign="top">point     </td><td valign="top"><code>(</code><var>id</var><code>)</code>
  64 <a name="index-point-reference-349"></a><a name="index-reference_002c-point-350"></a><a name="index-_0028foo_0029_0040r_007b_002c-point-reference_007d-351"></a><br></td></tr><tr align="left"><td valign="top">vector    </td><td valign="top"><code>[</code><var>id</var><code>]</code>
  65 <a name="index-vector-reference-352"></a><a name="index-reference_002c-vector-353"></a><a name="index-_005bfoo_005d_0040r_007b_002c-vector-reference_007d-354"></a><br></td></tr><tr align="left"><td valign="top">transform </td><td valign="top"><code>[[</code><var>id</var><code>]]</code>
  66 <a name="index-transform-reference-355"></a><a name="index-reference_002c-transform-356"></a><a name="index-_005b_005bfoo_005d_005d_0040r_007b_002c-transform-reference_007d-357"></a><br></td></tr><tr align="left"><td valign="top">drawable  </td><td valign="top"><code>{</code><var>id</var><code>}</code>
  67 <a name="index-drawable-reference-358"></a><a name="index-reference_002c-drawable-359"></a><a name="index-_0040_007bfoo_0040_007d_0040r_007b_002c-drawable-reference_007d-360"></a><br></td></tr><tr align="left"><td valign="top">options   </td><td valign="top"><code>[</code><var>id</var><code>]</code> or <code>[</code><var>id1</var><code>,...,</code><var>idN</var><code>]</code>
  68 <a name="index-options-reference-361"></a><a name="index-reference_002c-options-362"></a><a name="index-_005bfoo_005d_0040r_007b_002c-options-reference_007d-363"></a><a name="index-options-multiple-reference-364"></a><a name="index-reference_002c-multiple-options-365"></a><a name="index-_005bfoo_002c_002e_002e_002e_002cbar_005d_0040r_007b_002c-multiple-options-reference_007d-366"></a><br></td></tr><tr align="left"><td valign="top">tag       </td><td valign="top"><code>&lt;</code><var>id</var><code>&gt;</code>
  69 <a name="index-tag-reference-367"></a><a name="index-reference_002c-tag-368"></a><a name="index-_003cfoo_003e_0040r_007b_002c-tag-reference_007d-369"></a>
  70    <br></td></tr></table>
  71    <pre class="sp">
  72
  73 </pre>
  74 Note that square brackets <span class="samp">[ ]</span> are used both for vector and for
  75 options references.  Details of <code>sketch</code> syntax make it
  76 impossible for these two reference types to be confused.  The
  77 special multiple reference <code>[</code><var>id1</var><code>,</code><var>id2</var><code>,...,</code><var>idN</var><code>]</code>
  78 acts as if the respective lists of options were concatenated.
  79
  80    </body></html>
  81