basis/ui/render/render-docs.factor

   1 USING: ui.gadgets ui.pens ui.gestures help.markup help.syntax
   2 kernel classes strings opengl opengl.gl models
   3 math.rectangles math colors ;
   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 implementation of the " { $link "ui-pen-protocol" } }
  18         { { $snippet "boundary" } " - an implementation of the " { $link "ui-pen-protocol" } }
  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 ARTICLE: "ui-paint" "Customizing gadget appearance"
  34 "The UI carries out the following steps when drawing a gadget:"
  35 { $list
  36     { "The " { $link draw-interior } " generic word is called on the value of the " { $snippet "interior" } " slot." }
  37     { "The " { $link draw-gadget* } " generic word is called on the gadget." }
  38     { "The gadget's visible children are drawn, determined by calling " { $link visible-children } " on the gadget." }
  39     { "The " { $link draw-boundary } " generic word is called on the value of the " { $snippet "boundary" } " slot." }
  40 }
  41 "Now, each one of these steps will be covered in detail."
  42 { $subsections
  43     "ui-pen-protocol"
  44     "ui-paint-custom"
  45 } ;
  46
  47 ARTICLE: "ui-paint-coord" "The UI co-ordinate system"
  48 "The UI uses a co-ordinate system where the y axis is oriented down. The OpenGL " { $link GL_MODELVIEW } " matrix is saved or restored when rendering a gadget, and the origin is translated to the gadget's origin within the window. The current origin is stored in a variable:"
  49 { $subsections origin }
  50 "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." ;
  51
  52 ABOUT: "ui-paint"