Class: MiniGL::TextHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/minigl/text.rb

Overview

This class provides methods for easily drawing one or multiple lines of text, with control over the text alignment and coloring.

Instance Method Summary collapse

Constructor Details

#initialize(font, line_spacing = 0, scale_x = 1, scale_y = 1) ⇒ TextHelper

Creates a TextHelper.

Parameters:

font

A Gosu::Font or ImageFont that will be used to draw the text.

line_spacing

When drawing multiple lines, the default distance, in pixels, between each line.

scale_x

The default horizontal scale of the font.

scale_y

The default vertical scale of the font.



113
114
115
116
117
118
 
# File 'lib/minigl/text.rb', line 113

def initialize(font, line_spacing = 0, scale_x = 1, scale_y = 1)
  @font = font
  @line_spacing = line_spacing
  @scale_x = scale_x
  @scale_y = scale_y
end

Instance Method Details

#write_breaking(text, x, y, width, mode = :left, color = 0, alpha = 0xff, z_index = 0, scale_x = nil, scale_y = nil, line_spacing = nil) ⇒ Object

x

The horizontal reference for drawing the text. Works like in write_line for the :left, :right and :center modes. For the :justified mode, works the same as for :left.

y

The vertical reference for drawing the text. All text will be drawn from this point down.

width

The maximum width for the lines of text. Line is broken when this width is exceeded.

mode

The alignment of the text. Valid values are :left, :right, :center and :justified.

color

The color of the text, in hexadecimal RRGGBB format.

alpha

The opacity of the text. Valid values vary from 0 (fully transparent) to 255 (fully opaque).

z_index

The z-order to draw the object. Objects with larger z-orders will be drawn on top of the ones with smaller z-orders.

scale_x

The horizontal scaling of the text. If nil, this instance’s @scale_x value will be used.

scale_y

The vertical scaling of the text. If nil, this instance’s @scale_y value will be used.

line_spacing

The spacing between lines, in pixels. If nil, this instance’s @line_spacing value will be used.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/minigl/text.rb', line 230

def write_breaking(text, x, y, width, mode = :left, color = 0, alpha = 0xff, z_index = 0, scale_x = nil, scale_y = nil, line_spacing = nil)
  line_spacing = @line_spacing if line_spacing.nil?
  scale_x = @scale_x if scale_x.nil?
  scale_y = @scale_y if scale_y.nil?
  color = (alpha << 24) | color
  text.split("\n").each do |p|
    if mode == :justified
      y = write_paragraph_justified p, x, y, width, color, z_index, scale_x, scale_y, line_spacing
    else
      rel =
        case mode
        when :left then 0
        when :center then 0.5
        when :right then 1
        else 0
        end
      y = write_paragraph p, x, y, width, rel, color, z_index, scale_x, scale_y, line_spacing
    end
  end
end

#write_line(text, x = nil, y = nil, mode = :left, color = 0, alpha = 0xff, effect = nil, effect_color = 0, effect_size = 1, effect_alpha = 0xff, z_index = 0, scale_x = nil, scale_y = nil) ⇒ Object

Draws a single line of text.

Parameters:

text

The text to be drawn. No line breaks are allowed. You can use the ‘<b>` tag for bold, `<i>` for italic and `<c=rrggbb>` for colors.

x

The horizontal reference for drawing the text. If mode is :left, all text will be drawn from this point to the right; if mode is :right, all text will be drawn from this point to the left; and if mode is :center, the text will be equally distributed to the left and to the right of this point.

y

The vertical reference for drawing the text. All text will be drawn from this point down.

mode

The alignment of the text. Valid values are :left, :right and :center.

color

The color of the text, in hexadecimal RRGGBB format.

alpha

The opacity of the text. Valid values vary from 0 (fully transparent) to 255 (fully opaque).

effect

Effect to add to the text. It can be either nil, for no effect, :border for bordered text, or :shadow for shadowed text (the shadow is always placed below and to the right of the text).

effect_color

Color of the effect, if any.

effect_size

Size of the effect, if any. In the case of :border, this will be the width of the border (the border will only look good when effect_size is relatively small, compared to the size of the font); in the case of :shadow, it will be the distance between the text and the shadow.

effect_alpha

Opacity of the effect, if any. For shadows, it is usual to provide less than 255.

z_index

The z-order to draw the object. Objects with larger z-orders will be drawn on top of the ones with smaller z-orders.

scale_x

The horizontal scaling of the text. If nil, this instance’s @scale_x value will be used.

scale_y

The vertical scaling of the text. If nil, this instance’s @scale_y value will be used.

Obs.: This method accepts named parameters, but text, x and y are mandatory.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/minigl/text.rb', line 157

def write_line(text, x = nil, y = nil, mode = :left, color = 0, alpha = 0xff,
               effect = nil, effect_color = 0, effect_size = 1, effect_alpha = 0xff,
               z_index = 0, scale_x = nil, scale_y = nil)
  if text.is_a? Hash
    x = text[:x]
    y = text[:y]
    mode = text.fetch(:mode, :left)
    color = text.fetch(:color, 0)
    alpha = text.fetch(:alpha, 0xff)
    effect = text.fetch(:effect, nil)
    effect_color = text.fetch(:effect_color, 0)
    effect_size = text.fetch(:effect_size, 1)
    effect_alpha = text.fetch(:effect_alpha, 0xff)
    z_index = text.fetch(:z_index, 0)
    scale_x = text.fetch(:scale_x, nil)
    scale_y = text.fetch(:scale_y, nil)
    text = text[:text]
  end

  scale_x = @scale_x if scale_x.nil?
  scale_y = @scale_y if scale_y.nil?
  color = (alpha << 24) | color
  rel =
    case mode
    when :left then 0
    when :center then 0.5
    when :right then 1
    else 0
    end
  if effect
    effect_color = (effect_alpha << 24) | effect_color
    if effect == :border
      @font.draw_markup_rel text, x - effect_size, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x + effect_size, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x + effect_size, y, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x - effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
      @font.draw_markup_rel text, x - effect_size, y, z_index, rel, 0, scale_x, scale_y, effect_color
    elsif effect == :shadow
      @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
    end
  end
  @font.draw_markup_rel text, x, y, z_index, rel, 0, scale_x, scale_y, color
end