Module: CDK::Draw

Defined in:
lib/cdk/draw.rb

Class Method Summary collapse

Class Method Details

.attrbox(win, tlc, trc, blc, brc, horz, vert, attr) ⇒ Object

This draws a box with attributes and lets the user define each element of the box



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/cdk/draw.rb', line 50

def Draw.attrbox(win, tlc, trc, blc, brc, horz, vert, attr)
  x1 = 0
  y1 = 0
  y2 = win.getmaxy - 1
  x2 = win.getmaxx - 1
  count = 0

  # Draw horizontal lines
  if horz != 0
    win.mvwhline(y1, 0, horz | attr, win.getmaxx)
    win.mvwhline(y2, 0, horz | attr, win.getmaxx)
    count += 1
  end

  # Draw vertical lines
  if vert != 0
    win.mvwvline(0, x1, vert | attr, win.getmaxy)
    win.mvwvline(0, x2, vert | attr, win.getmaxy)
    count += 1
  end

  # Draw in the corners.
  if tlc != 0
    win.mvwaddch(y1, x1, tlc | attr)
    count += 1
  end
  if trc != 0
    win.mvwaddch(y1, x2, trc | attr)
    count += 1
  end
  if blc != 0
    win.mvwaddch(y2, x1, blc | attr)
    count += 1
  end
  if brc != 0
    win.mvwaddch(y2, x2, brc | attr)
    count += 1
  end
  if count != 0
    SCREEN.wrefresh(win)
  end
end

.boxWindow(window, attr) ⇒ Object

This prints out a box around a window with attributes



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cdk/draw.rb', line 26

def Draw.boxWindow(window, attr)
  tlx = 0
  tly = 0
  brx = window.getmaxx - 1
  bry = window.getmaxy - 1

  # Draw horizontal lines.
  window.mvwhline(tly, 0, Ncurses::ACS_HLINE | attr, window.getmaxx)
  window.mvwhline(bry, 0, Ncurses::ACS_HLINE | attr, window.getmaxx)

  # Draw horizontal lines.
  window.mvwvline(0, tlx, Ncurses::ACS_VLINE | attr, window.getmaxy)
  window.mvwvline(0, brx, Ncurses::ACS_VLINE | attr, window.getmaxy)

  # Draw in the corners.
  window.mvwaddch(tly, tlx, Ncurses::ACS_ULCORNER | attr)
  window.mvwaddch(tly, brx, Ncurses::ACS_URCORNER | attr)
  window.mvwaddch(bry, tlx, Ncurses::ACS_LLCORNER | attr)
  window.mvwaddch(bry, brx, Ncurses::ACS_LRCORNER | attr)
  SCREEN.wrefresh(window)
end

.drawLine(window, startx, starty, endx, endy, line) ⇒ Object

This draws a line on the given window. (odd angle lines not working yet)



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cdk/draw.rb', line 102

def Draw.drawLine(window, startx, starty, endx, endy, line)
  xdiff = endx - startx
  ydiff = endy - starty
  x = 0
  y = 0

  # Determine if we're drawing a horizontal or vertical line.
  if ydiff == 0
    if xdiff > 0
      window.mvwhline(starty, startx, line, xdiff)
    end
  elsif xdiff == 0
    if ydiff > 0
      window.mvwvline(starty, startx, line, ydiff)
    end
  else
    # We need to determine the angle of the line.
    height = xdiff
    width = ydiff
    xratio = if height > width then 1 else width / height end
    yration = if width > height then width / height else 1 end
    xadj = 0
    yadj = 0

    # Set the vars
    x = startx
    y = starty
    while x!= endx && y != endy
      # Add the char to the window
      window.mvwaddch(y, x, line)

      # Make the x and y adjustments.
      if xadj != xratio
        x = if xdiff < 0 then x - 1 else x + 1 end
        xadj += 1
      else
        xadj = 0
      end
      if yadj != yratio
        y = if ydiff < 0 then y - 1 else y + 1 end
        yadj += 1
      else
        yadj = 0
      end
    end
  end
end

.drawObjBox(win, object) ⇒ Object

Draw a box around the given window using the object’s defined line-drawing characters



95
96
97
98
99
 
# File 'lib/cdk/draw.rb', line 95

def Draw.drawObjBox(win, object)
  Draw.attrbox(win,
      object.ULChar, object.URChar, object.LLChar, object.LRChar,
      object.HZChar, object.VTChar, object.BXAttr)
end

.drawShadow(shadow_win) ⇒ Object

This draws a shadow around a window.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cdk/draw.rb', line 151

def Draw.drawShadow(shadow_win)
  unless shadow_win.nil?
    x_hi = shadow_win.getmaxx - 1
    y_hi = shadow_win.getmaxy - 1

    # Draw the line on the bottom.
    shadow_win.mvwhline(y_hi, 1, Ncurses::ACS_HLINE | Ncurses::A_DIM, x_hi)
    
    # Draw the line on teh right.
    shadow_win.mvwvline(0, x_hi, Ncurses::ACS_VLINE | Ncurses::A_DIM, y_hi)

    shadow_win.mvwaddch(0, x_hi, Ncurses::ACS_URCORNER | Ncurses::A_DIM)
    shadow_win.mvwaddch(y_hi, 0, Ncurses::ACS_LLCORNER | Ncurses::A_DIM)
    shadow_win.mvwaddch(y_hi, x_hi, Ncurses::ACS_LRCORNER | Ncurses::A_DIM)
    SCREEN.wrefresh(shadow_win)
  end
end

.initCDKColor ⇒ Object

This sets up a basic set of color pairs. These can be redefined if wanted



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/cdk/draw.rb', line 4

def Draw.initCDKColor
  color = [Ncurses::COLOR_WHITE, Ncurses::COLOR_RED, Ncurses::COLOR_GREEN,
      Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLUE, Ncurses::COLOR_MAGENTA,
      Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK]
  pair = 1

  if Ncurses.has_colors?
    # XXX: Only checks if terminal has colours not if colours are started
    Ncurses.start_color
    limit = if Ncurses.COLORS < 8 then Ncurses.COLORS else 8 end

    # Create the color pairs
    (0...limit).each do |fg|
      (0...limit).each do |bg|
        Ncurses.init_pair(pair, color[fg], color[bg])
        pair += 1
      end
    end
  end
end

.writeBlanks(window, xpos, ypos, align, start, endn) ⇒ Object

Write a string of blanks using writeChar()



170
171
172
173
174
175
176
 
# File 'lib/cdk/draw.rb', line 170

def Draw.writeBlanks(window, xpos, ypos, align, start, endn)
  if start < endn
    want = (endn - start) + 1000
    blanks = ' ' * (want - 1)
    Draw.writeChar(window, xpos, ypos, blanks, align, start, endn)
  end
end

.writeChar(window, xpos, ypos, string, align, start, endn) ⇒ Object

This writes out a char string with no attributes



179
180
181
182
 
# File 'lib/cdk/draw.rb', line 179

def Draw.writeChar(window, xpos, ypos, string, align, start, endn)
  Draw.writeCharAttrib(window, xpos, ypos, string, Ncurses::A_NORMAL,
      align, start, endn)
end

.writeCharAttrib(window, xpos, ypos, string, attr, align, start, endn) ⇒ Object

This writes out a char string with attributes



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/cdk/draw.rb', line 185

def Draw.writeCharAttrib(window, xpos, ypos, string, attr, align,
    start, endn)
  display = endn - start

  if align == CDK::HORIZONTAL
    # Draw the message on a horizontal axis
    display = [display, window.getmaxx - 1].min
    (0...display).each do |x|
      window.mvwaddch(ypos, xpos + x, string[x + start].ord | attr)
    end
  else
    # Draw the message on a vertical axis
    display = [display, window.getmaxy - 1].min
    (0...display).each do |x|
      window.mvwaddch(ypos + x, xpos, string[x + start].ord | attr)
    end
  end
end

.writeChtype(window, xpos, ypos, string, align, start, endn) ⇒ Object

This writes out a chtype string



205
206
207
208
 
# File 'lib/cdk/draw.rb', line 205

def Draw.writeChtype (window, xpos, ypos, string, align, start, endn)
  Draw.writeChtypeAttrib(window, xpos, ypos, string, Ncurses::A_NORMAL,
      align, start, endn)
end

.writeChtypeAttrib(window, xpos, ypos, string, attr, align, start, endn) ⇒ Object

This writes out a chtype string with the given attributes added.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/cdk/draw.rb', line 211

def Draw.writeChtypeAttrib(window, xpos, ypos, string, attr,
    align, start, endn)
  diff = endn - start
  display = 0
  x = 0
  if align == CDK::HORIZONTAL
    # Draw the message on a horizontal axis.
    display = [diff, window.getmaxx - xpos].min
    (0...display).each do |x|
      window.mvwaddch(ypos, xpos + x, string[x + start].ord | attr)
    end
  else
    # Draw the message on a vertical axis.
    display = [diff, window.getmaxy - ypos].min
    (0...display).each do |x|
      window.mvwaddch(ypos + x, xpos, string[x + start].ord | attr)
    end
  end
end