clean up indentation and spacing
[supercollider.git] / HelpSource / Classes / HiliteGradient.schelp
blob82abfdd55d5d618bb1a9b45064d53fa12df5a494
1 class:: HiliteGradient
2 summary:: A linear color fade between an outside and an inside color
3 categories:: GUI>Accessories
4 related:: Classes/Color, Classes/Gradient
6 description::
7 A linear color fade between an outside and an inside color.
9 note:: The use of HiliteGradient is strong::not supported yet in Qt GUI::. When HiliteGradient is used in place of Color, the average gradient color will be used instead. ::
11 classmethods::
13 method:: new
14 argument:: color1
15 An instance of Color.
16 argument:: color2
17 An instance of Color.
18 argument:: direction
19 code::\h:: or code::\v:: for horizontal and vertical respectively. Default value is code::\v::.
20 argument:: steps
21 The resolution of the gradient. Default value is 64.
22 argument:: frac
23 The center of the gradient. Default value is 0.33, i.e. off center toward the top on a vertical gradient.
25 examples::
26 code::
27 // basic usage
29 w = Window.new.front;
30 v = CompositeView(w, Rect(50, 50, 200, 50));
31 v.background = HiliteGradient(Color.gray, Color.white);
34 // change direction and resolution
36 w = Window.new.front;
37 w.view.background = HiliteGradient(Color.red, Color.white, \h, 12, 0.5);
40 // almost unnoticeable variations can be pleasant
42 w = Window.new.front;
43 v = CompositeView(w, Rect(50,50,300,300));
44 c = Color.rand;
45 d = c.vary(0.15);
46 v.background = HiliteGradient(c, d, \v);
47 [c, d].postln
51 var w, k, c, d, e, c1, c2, f, g;
52 w = Window.new.front;
53 k = Slider2D(w, Rect(50, 50, 300, 300));
54 f = {
55         c = Color.rand;
56         d = c.vary(0.5);
57         e = d.vary(0.5);
59 g = {
60         c1 = d.hueBlend(e, k.y).round(0.01);
61         c2 = c.hueBlend(e, k.x).round(0.01);
62         k.background = HiliteGradient(c1, c2, \v)
64 f.value; g.value;
65 k.action = g;
66 k.mouseUpAction = { [c1, c2].postln };
67 k.keyDownAction = f; // hit any key for new color