unmaintained/4DNav/4DNav-docs.factor

   1 ! Copyright (C) 2008 Jean-François Bigot.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel quotations strings ;
   4 IN: 4DNav
   5
   6
   7 HELP: menu-3D
   8 { $values
   9      { "gadget" "gadget" }
  10 }
  11 { $description "The menu dedicated to 3D movements of the camera" } ;
  12
  13 HELP: menu-4D
  14 { $values
  15
  16      { "gadget" "gadget" }
  17 }
  18 { $description "The menu dedicated to 4D movements of space" } ;
  19
  20 HELP: menu-bar
  21 { $values
  22
  23      { "gadget" "gadget" }
  24 }
  25 { $description "return gadget containing menu buttons" } ;
  26
  27 HELP: model-projection
  28 { $values
  29      { "x" "interger" }
  30      { "space" "space" }
  31 }
  32 { $description "Project space following coordinate x" } ;
  33
  34 HELP: mvt-3D-1
  35 { $values
  36
  37      { "quot" "quotation" }
  38 }
  39 { $description "return a quotation to orientate space to see it from first point of view" } ;
  40
  41 HELP: mvt-3D-2
  42 { $values
  43
  44      { "quot" "quotation" }
  45 }
  46 { $description "return a quotation to orientate space to see it from second point of view" } ;
  47
  48 HELP: mvt-3D-3
  49 { $values
  50
  51      { "quot" "quotation" }
  52 }
  53 { $description "return a quotation to orientate space to see it from third point of view" } ;
  54
  55 HELP: mvt-3D-4
  56 { $values
  57
  58      { "quot" "quotation" }
  59 }
  60 { $description "return a quotation to orientate space to see it from first point of view" } ;
  61
  62 HELP: load-model-file
  63 { $description "load space from file" } ;
  64
  65 HELP: rotation-4D
  66 { $values
  67      { "m" "a rotation matrix" }
  68 }
  69 { $description "Apply a 4D rotation matrix" } ;
  70
  71 HELP: translation-4D
  72 { $values
  73      { "v" "vector" }
  74 }
  75 { $description "Apply a 4D translation" } ;
  76
  77
  78 ARTICLE: "implementation details" "How 4DNav is done"
  79 "4DNav is build using :"
  80
  81 { $subsection "4DNav.camera" }
  82 { $subsection "adsoda-main-page" }
  83 ;
  84
  85 ARTICLE: "Space file" "Create a new space file"
  86 "To build a new space, create an XML file using " { $vocab-link "adsoda" } " model description. A solid is not caracterized by its corners but is defined as the intersection of hyperplanes."
  87
  88 $nl
  89 "An example is:"
  90 $nl
  91
  92 "\n<model>"
  93 "\n<space>"
  94 "\n <dimension>4</dimension>"
  95 "\n <solid>"
  96 "\n     <name>4cube1</name>"
  97 "\n     <dimension>4</dimension>"
  98 "\n     <face>1,0,0,0,100</face>"
  99 "\n     <face>-1,0,0,0,-150</face>"
 100 "\n     <face>0,1,0,0,100</face>"
 101 "\n     <face>0,-1,0,0,-150</face>"
 102 "\n     <face>0,0,1,0,100</face>"
 103 "\n     <face>0,0,-1,0,-150</face>"
 104 "\n     <face>0,0,0,1,100</face>"
 105 "\n     <face>0,0,0,-1,-150</face>"
 106 "\n     <color>1,0,0</color>"
 107 "\n </solid>"
 108 "\n <solid>"
 109 "\n     <name>4triancube</name>"
 110 "\n     <dimension>4</dimension>"
 111 "\n     <face>1,0,0,0,160</face>"
 112 "\n     <face>-0.4999999999999998,-0.8660254037844387,0,0,-130</face>"
 113 "\n     <face>-0.5000000000000004,0.8660254037844384,0,0,-130</face>"
 114 "\n     <face>0,0,1,0,140</face>"
 115 "\n     <face>0,0,-1,0,-180</face>"
 116 "\n     <face>0,0,0,1,110</face>"
 117 "\n     <face>0,0,0,-1,-180</face>"
 118 "\n     <color>0,1,0</color>"
 119 "\n </solid>"
 120 "\n <solid>"
 121 "\n     <name>triangone</name>"
 122 "\n     <dimension>4</dimension>"
 123 "\n     <face>1,0,0,0,60</face>"
 124 "\n     <face>0.5,0.8660254037844386,0,0,60</face>"
 125 "\n     <face>-0.5,0.8660254037844387,0,0,-20</face>"
 126 "\n     <face>-1.0,0,0,0,-100</face>"
 127 "\n     <face>-0.5,-0.8660254037844384,0,0,-100</face>"
 128 "\n     <face>0.5,-0.8660254037844387,0,0,-20</face>"
 129 "\n     <face>0,0,1,0,120</face>"
 130 "\n     <face>0,0,-0.4999999999999998,-0.8660254037844387,-120</face>"
 131 "\n     <face>0,0,-0.5000000000000004,0.8660254037844384,-120</face>"
 132 "\n     <color>0,1,1</color>"
 133 "\n </solid>"
 134 "\n <light>"
 135 "\n     <direction>1,1,1,1</direction>"
 136 "\n     <color>0.2,0.2,0.6</color>"
 137 "\n </light>"
 138 "\n <color>0.8,0.9,0.9</color>"
 139 "\n</space>"
 140 "\n</model>"
 141
 142
 143 ;
 144 ARTICLE: "TODO" "Todo"
 145 { $list
 146     "A vocab to initialize parameters"
 147     "an editor mode"
 148         { $list "add a face to a solid"
 149                 "add a solid to the space"
 150                 "move a face"
 151                 "move a solid"
 152                 "select a solid in a list"
 153                 "select a face"
 154                 "display selected face"
 155                 "edit a solid color"
 156                 "add a light"
 157                 "edit a light color"
 158                 "move a light"
 159                 }
 160     "add a tool wich give an hyperplane normal vector with enought points. Will use adsoda.intersect-hyperplanes with { { 0 } { 0 } { 1 } } "
 161     "decorrelate 3D camera and activate them with select buttons"
 162
 163 } ;
 164
 165
 166 ARTICLE: "4DNav" "The 4DNav app"
 167 { $vocab-link "4DNav" }
 168 $nl
 169 { $heading "4D Navigator" }
 170 "4DNav is a simple tool to visualize 4 dimensionnal objects."
 171 "\n"
 172 "It uses " { $vocab-link "adsoda" } " library to display a 4D space and navigate thru it."
 173 $nl
 174 "It will display:"
 175 { $list
 176     { "a menu window" }
 177     {  "4 visualization windows" }
 178 }
 179 "Each visualization window represents the projection of the 4D space on a particular 3D space."
 180
 181 { $heading "Start" }
 182 "type:" { $code "\"4DNav\" run" }
 183
 184 { $heading "Navigation" }
 185 "Menu window is divided in 4 areas"
 186 { $list
 187     { "a space-file chooser to select the file to display" }
 188     { "a parametrization area to select the projection mode" }
 189     { "4D submenu to translate and rotate the 4D space" }
 190     { "3D submenu to move the camera in 3D space. Cameras in every 3D spaces are manipulated as a single one" }
 191     }
 192
 193 { $heading "Links" }
 194 { $subsection "Space file" }
 195
 196 { $subsection "TODO" }
 197 { $subsection "implementation details" }
 198
 199 ;
 200
 201 ABOUT: "4DNav"