unmaintained/4DNav/turtle/turtle-docs.factor

   1 ! Copyright (C) 2008 Jean-François Bigot.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: arrays help.markup help.syntax kernel sequences ;
   4 IN: 4DNav.turtle
   5
   6 HELP: <turtle>
   7 { $values
   8
   9      { "turtle" null }
  10 }
  11 { $description "" } ;
  12
  13 HELP: >turtle-ori
  14 { $values
  15      { "val" null }
  16 }
  17 { $description "" } ;
  18
  19 HELP: >turtle-pos
  20 { $values
  21      { "val" null }
  22 }
  23 { $description "" } ;
  24
  25 HELP: Rx
  26 { $values
  27      { "angle" null }
  28      { "Rz" null }
  29 }
  30 { $description "" } ;
  31
  32 HELP: Ry
  33 { $values
  34      { "angle" null }
  35      { "Ry" null }
  36 }
  37 { $description "" } ;
  38
  39 HELP: Rz
  40 { $values
  41      { "angle" null }
  42      { "Rx" null }
  43 }
  44 { $description "" } ;
  45
  46 HELP: V
  47 { $values
  48
  49      { "V" null }
  50 }
  51 { $description "" } ;
  52
  53 HELP: X
  54 { $values
  55
  56      { "3array" null }
  57 }
  58 { $description "" } ;
  59
  60 HELP: Y
  61 { $values
  62
  63      { "3array" null }
  64 }
  65 { $description "" } ;
  66
  67 HELP: Z
  68 { $values
  69
  70      { "3array" null }
  71 }
  72 { $description "" } ;
  73
  74 HELP: apply-rotation
  75 { $values
  76      { "rotation" null }
  77 }
  78 { $description "" } ;
  79
  80 HELP: distance
  81 { $values
  82      { "turtle" null } { "turtle" null }
  83      { "n" null }
  84 }
  85 { $description "" } ;
  86
  87 HELP: move-by
  88 { $values
  89      { "point" null }
  90 }
  91 { $description "" } ;
  92
  93 HELP: pitch-down
  94 { $values
  95      { "angle" null }
  96 }
  97 { $description "" } ;
  98
  99 HELP: pitch-up
 100 { $values
 101      { "angle" null }
 102 }
 103 { $description "" } ;
 104
 105 HELP: reset-turtle
 106 { $description "" } ;
 107
 108 HELP: roll-left
 109 { $values
 110      { "angle" null }
 111 }
 112 { $description "" } ;
 113
 114 HELP: roll-right
 115 { $values
 116      { "angle" null }
 117 }
 118 { $description "" } ;
 119
 120 HELP: roll-until-horizontal
 121 { $description "" } ;
 122
 123 HELP: rotate-x
 124 { $values
 125      { "angle" null }
 126 }
 127 { $description "" } ;
 128
 129 HELP: rotate-y
 130 { $values
 131      { "angle" null }
 132 }
 133 { $description "" } ;
 134
 135 HELP: rotate-z
 136 { $values
 137      { "angle" null }
 138 }
 139 { $description "" } ;
 140
 141 HELP: set-X
 142 { $values
 143      { "seq" sequence }
 144 }
 145 { $description "" } ;
 146
 147 HELP: set-Y
 148 { $values
 149      { "seq" sequence }
 150 }
 151 { $description "" } ;
 152
 153 HELP: set-Z
 154 { $values
 155      { "seq" sequence }
 156 }
 157 { $description "" } ;
 158
 159 HELP: step-turtle
 160 { $values
 161      { "length" null }
 162 }
 163 { $description "" } ;
 164
 165 HELP: step-vector
 166 { $values
 167      { "length" null }
 168      { "array" array }
 169 }
 170 { $description "" } ;
 171
 172 HELP: strafe-down
 173 { $values
 174      { "length" null }
 175 }
 176 { $description "" } ;
 177
 178 HELP: strafe-left
 179 { $values
 180      { "length" null }
 181 }
 182 { $description "" } ;
 183
 184 HELP: strafe-right
 185 { $values
 186      { "length" null }
 187 }
 188 { $description "" } ;
 189
 190 HELP: strafe-up
 191 { $values
 192      { "length" null }
 193 }
 194 { $description "" } ;
 195
 196 HELP: turn-left
 197 { $values
 198      { "angle" null }
 199 }
 200 { $description "" } ;
 201
 202 HELP: turn-right
 203 { $values
 204      { "angle" null }
 205 }
 206 { $description "" } ;
 207
 208 HELP: turtle
 209 { $description "" } ;
 210
 211 HELP: turtle-ori>
 212 { $values
 213
 214      { "val" null }
 215 }
 216 { $description "" } ;
 217
 218 HELP: turtle-pos>
 219 { $values
 220
 221      { "val" null }
 222 }
 223 { $description "" } ;
 224
 225 ARTICLE: "4DNav.turtle" "4DNav.turtle"
 226 { $vocab-link "4DNav.turtle" }
 227 ;
 228
 229 ABOUT: "4DNav.turtle"