basis/ui/render/render-docs.factor

   1 USING: ui.gadgets ui.gestures help.markup help.syntax
   2 kernel classes strings opengl opengl.gl models
   3 math.geometry.rect math ;
   4 IN: ui.render
   5
   6 HELP: gadget
   7 { $class-description "An object which displays itself on the screen and acts on user input gestures. Gadgets have the following slots:"
   8     { $list
   9         { { $snippet "pref-dim" } " - a cached value for " { $link pref-dim } "; do not read or write this slot directly." }
  10         { { $snippet "parent" } " - the gadget containing this one, or " { $link f } " if this gadget is not part of the visible gadget hierarchy." }
  11         { { $snippet "children" } " - a vector of child gadgets. Do not modify this vector directly, instead use " { $link add-gadget } ", " { $link add-gadgets } ", " { $link unparent } " or " { $link clear-gadget } "." }
  12         { { $snippet "orientation" } " - an orientation specifier. This slot is used by layout gadgets." }
  13         { { $snippet "layout-state" } " - stores the layout state of the gadget. Do not read or write this slot directly, instead call " { $link relayout } " and " { $link relayout-1 } " if the gadget needs to be re-laid out." }
  14         { { $snippet "visible?" } " - a boolean indicating if the gadget should display and receive user input." }
  15         { { $snippet "root?" } " - if set to " { $link t } ", layout changes in this gadget will not propagate to the gadget's parent." }
  16         { { $snippet "clipped?" } " - a boolean indicating if clipping will be enabled when drawing this gadget's children." }
  17         { { $snippet "interior" } " - an object whose class implements the " { $link draw-interior } " generic word." }
  18         { { $snippet "boundary" } " - an object whose class implements the " { $link draw-boundary } " generic word." }
  19         { { $snippet "model" } " - a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } }
  20     }
  21 "Gadgets subclass the " { $link rect } " class, and thus all instances have " { $snippet "loc" } " and " { $snippet "dim" } " instances holding their location and dimensions." }
  22 { $notes
  23 "Other classes may inherit from " { $link gadget } " in order to re-implement generic words such as " { $link draw-gadget* } " and " { $link user-input* } ", or to define gestures with " { $link set-gestures } "." } ;
  24
  25 HELP: clip
  26 { $var-description "The current clipping rectangle." } ;
  27
  28 HELP: draw-gadget*
  29 { $values { "gadget" gadget } }
  30 { $contract "Draws the gadget by making OpenGL calls. The top-left corner of the gadget should be drawn at the location stored in the " { $link origin } " variable." }
  31 { $notes "This word should not be called directly. To force a gadget to redraw, call " { $link relayout-1 } "." } ;
  32
  33 HELP: draw-interior
  34 { $values { "interior" object } { "gadget" gadget } }
  35 { $contract "Draws the interior of a gadget by making OpenGL calls. The " { $snippet "interior" } " slot may be set to objects implementing this generic word." } ;
  36
  37 HELP: draw-boundary
  38 { $values { "boundary" object } { "gadget" gadget } }
  39 { $contract "Draws the boundary of a gadget by making OpenGL calls. The " { $snippet "boundary" } " slot may be set to objects implementing this generic word." } ;
  40
  41 HELP: solid
  42 { $class-description "A class implementing the " { $link draw-boundary } " and " { $link draw-interior } " generic words to draw a solid outline or a solid fill, respectively. The " { $snippet "color" } " slot stores a color specifier." } ;
  43
  44 HELP: gradient
  45 { $class-description "A class implementing the " { $link draw-interior } " generic word to draw a smoothly shaded transition between colors. The " { $snippet "colors" } " slot stores a sequence of color specifiers and the gradient is drawn in the direction given by the " { $snippet "orientation" } " slot of the gadget." } ;
  46
  47 HELP: polygon
  48 { $class-description "A class implementing the " { $link draw-boundary } " and " { $link draw-interior } " generic words to draw a solid outline or a solid filled polygon, respectively. Instances of " { $link polygon } " have two slots:"
  49     { $list
  50         { { $snippet "color" } " - a color specifier" }
  51         { { $snippet "points" } " - a sequence of points" }
  52     }
  53 } ;
  54
  55 HELP: <polygon>
  56 { $values { "color" "a color specifier" } { "points" "a sequence of points" } { "polygon" polygon } }
  57 { $description "Creates a new instance of " { $link polygon } "." } ;
  58
  59 HELP: <polygon-gadget>
  60 { $values { "color" "a color specifier" } { "points" "a sequence of points" } { "gadget" "a new " { $link gadget } } }
  61 { $description "Creates a gadget which is drawn as a solid filled polygon. The gadget's size is the minimum bounding box containing all the points of the polygon." } ;
  62
  63 ARTICLE: "gadgets-polygons" "Polygon gadgets"
  64 "A polygon gadget renders a simple shaded polygon."
  65 { $subsection <polygon-gadget> }
  66 "Some pre-made polygons:"
  67 { $subsection arrow-up }
  68 { $subsection arrow-right }
  69 { $subsection arrow-down }
  70 { $subsection arrow-left }
  71 { $subsection close-box }
  72 "Polygon gadgets are rendered by the " { $link polygon } " pen protocol implementation." ;
  73
  74 ARTICLE: "ui-paint" "Customizing gadget appearance"
  75 "The UI carries out the following steps when drawing a gadget:"
  76 { $list
  77     { "The " { $link draw-interior } " generic word is called on the value of the " { $snippet "interior" } " slot." }
  78     { "The " { $link draw-gadget* } " generic word is called on the gadget." }
  79     { "The gadget's visible children are drawn, determined by calling " { $link visible-children } " on the gadget." }
  80     { "The " { $link draw-boundary } " generic word is called on the value of the " { $snippet "boundary" } " slot." }
  81 }
  82 "Now, each one of these steps will be covered in detail."
  83 { $subsection "ui-pen-protocol" }
  84 { $subsection "ui-paint-custom" } ;
  85
  86 ARTICLE: "ui-pen-protocol" "UI pen protocol"
  87 "The " { $snippet "interior" } " and " { $snippet "boundary" } " slots of a gadget facilitate easy factoring and sharing of drawing logic. Objects stored in these slots must implement the pen protocol:"
  88 { $subsection draw-interior }
  89 { $subsection draw-boundary }
  90 "The default value of these slots is the " { $link f } " singleton, which implements the above protocol by doing nothing."
  91 $nl
  92 "Some other pre-defined implementations:"
  93 { $subsection solid }
  94 { $subsection gradient }
  95 { $subsection polygon }
  96 "Custom implementations must follow the guidelines set forth in " { $link "ui-paint-custom" } "." ;
  97
  98 ARTICLE: "ui-paint-coord" "The UI co-ordinate system"
  99 "The UI uses a co-ordinate system where the y axis is oriented down. The OpenGL " { $link GL_MODELVIEW } " matrix is not saved or restored when rendering a gadget. Instead, the origin of the gadget relative to the OpenGL context is stored in a variable:"
 100 { $subsection origin }
 101 "Custom drawing implementations can translate co-ordinates manually, or save and restore the " { $link GL_MODELVIEW } " matrix using a word such as " { $link with-translation } "."
 102 $nl
 103 "Gadgets must not draw outside of their bounding box, however clipping is not enforced by default, for performance reasons. This can be changed by setting the " { $slot "clipped?" } " slot to " { $link t } " in the gadget's constructor." ;
 104
 105 ABOUT: "ui-paint-custom"