Module: Rabbit::Renderer::Engine::Cairo

Includes:
Kernel
Included in:
Display::ClutterEmbed, Pixmap::Cairo, Print::Cairo
Defined in:
lib/rabbit/renderer/engine/cairo.rb

Constant Summary collapse

@@rsvg_available = 
nil
@@poppler_available = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Kernel

#draw_circle, #draw_circle_by_radius, #draw_cone, #draw_cube, #draw_dodecahedron, #draw_flag, #draw_flag_layout, #draw_icosahedron, #draw_octahedron, #draw_rectangle_flag, #draw_slide, #draw_sphere, #draw_teapot, #draw_tetrahedron, #draw_torus, #draw_triangle_flag, #flag_size, #gl_call_list, #gl_compile, #gl_supported?, #make_color, #new_list_id, #z_far, #z_view

Instance Attribute Details

#background=(value) ⇒ Object (writeonly)

Sets the attribute background

Parameters:

  • value —

    the value to set the attribute background to.



74
75
76
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 74

def background=(value)
  @background = value
end

#foreground=(value) ⇒ Object (writeonly)

Sets the attribute foreground

Parameters:

  • value —

    the value to set the attribute foreground to.



74
75
76
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 74

def foreground=(value)
  @foreground = value
end

Class Method Details

.available_with_gdk? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 51

def available_with_gdk?
  Gdk.respond_to?(:cairo_available?) and Gdk.cairo_available?
end

.available_with_gdk_pixbuf? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 55

def available_with_gdk_pixbuf?
  Gdk::Pixbuf.respond_to?(:cairo_available?) and
    Gdk::Pixbuf.cairo_available?
end

.available_with_pango? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 60

def available_with_pango?
  Pango.respond_to?(:cairo_available?) and Pango.cairo_available?
end

.priority ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 64

def priority
  if available_with_gdk? and available_with_gdk_pixbuf? and
      available_with_pango?
    100
  else
    -100
  end
end

Instance Method Details

#alpha_available? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 76

def alpha_available?
  true
end

#background_image=(pixbuf) ⇒ Object 



80
81
82
83
84
85
86
87
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 80

def background_image=(pixbuf)
  surface = ::Cairo::ImageSurface.new(::Cairo::FORMAT_A1, 1, 1)
  context = ::Cairo::Context.new(surface)
  context.set_source_pixbuf(pixbuf)
  @background_image = context.source
  @background_image.extend = ::Cairo::EXTEND_REPEAT
  pixbuf
end

#create_pango_context ⇒ Object 



354
355
356
357
358
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 354

def create_pango_context
  context = Pango::CairoFontMap.default.create_context
  set_font_resolution(context)
  context
end

#draw_arc(filled, x, y, w, h, a1, a2, color = nil, params = {}) ⇒ Object 



205
206
207
208
209
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 205

def draw_arc(filled, x, y, w, h, a1, a2, color=nil, params={})
  r = w * 0.5
  draw_arc_by_radius(filled, x + w * 0.5, y + h * 0.5,
                     r, a1, a2, color, params)
end

#draw_arc_by_radius(filled, x, y, r, a1, a2, color = nil, params = {}) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 211

def draw_arc_by_radius(filled, x, y, r, a1, a2, color=nil, params={})
  x, y = from_screen(x, y)
  a1, a2 = convert_angle(a1, a2)
  @context.save do
    set_source(color, params)
    set_line_options(params)
    args = [x, y, r, a1, a2]
    action, = cairo_action(filled, params)
    @context.move_to(x, y) unless action == :stroke
    @context.arc(*args)
    @context.close_path unless action == :stroke
    apply_cairo_action(filled, params)
  end
end

#draw_background(slide) ⇒ Object 



157
158
159
160
161
162
163
164
165
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 157

def draw_background(slide)
  super
  if @background_image
    @context.save do
      @context.set_source(@background_image)
      @context.paint
    end
  end
end

#draw_layout(layout, x, y, color = nil, params = {}) ⇒ Object 



244
245
246
247
248
249
250
251
252
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 244

def draw_layout(layout, x, y, color=nil, params={})
  x, y = from_screen(x, y)
  @context.save do
    set_source(color, params)
    set_line_options(params)
    @context.move_to(x, y)
    @context.show_pango_layout(layout)
  end
end

#draw_line(x1, y1, x2, y2, color = nil, params = {}) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 167

def draw_line(x1, y1, x2, y2, color=nil, params={})
  x1, y1 = from_screen(x1, y1)
  x2, y2 = from_screen(x2, y2)
  @context.save do
    set_source(color, params)
    set_line_options(params)
    @context.new_path
    @context.move_to(x1, y1)
    @context.line_to(x2, y2)
    apply_cairo_action(false, params)
  end
end

#draw_lines(points, color = nil, params = {}) ⇒ Object 



226
227
228
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 226

def draw_lines(points, color=nil, params={})
  draw_polygon(false, points, color, params.merge({:opened => true}))
end

#draw_pixbuf(pixbuf, x, y, params = {}) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 254

def draw_pixbuf(pixbuf, x, y, params={})
  x, y = from_screen(x, y)
  @context.save do
    @context.translate(x, y)
    set_source_pixbuf(pixbuf, params)
    @context.paint(params[:alpha])
  end

  _draw_reflected_pixbuf(pixbuf, x, y, params)
end

#draw_polygon(filled, points, color = nil, params = {}) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 230

def draw_polygon(filled, points, color=nil, params={})
  return if points.empty?
  @context.save do
    set_source(color, params)
    set_line_options(params)
    @context.move_to(*from_screen(*points.first))
    points[1..-1].each do |x, y|
      @context.line_to(*from_screen(x, y))
    end
    @context.line_to(*from_screen(*points.first)) unless params[:opened]
    apply_cairo_action(filled, params)
  end
end

#draw_poppler_page(page, x, y, params = {}) ⇒ Object 



332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 332

def draw_poppler_page(page, x, y, params={})
  x, y = from_screen(x, y)
  w, h = page.size
  width = (params[:width] || w).to_f
  height = (params[:height] || h).to_f
  @context.save do
    @context.translate(x, y)
    @context.scale(width / w, height / h)
    @context.render_poppler_page(page)
  end
end

#draw_rectangle(filled, x, y, w, h, color = nil, params = {}) ⇒ Object 



180
181
182
183
184
185
186
187
188
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 180

def draw_rectangle(filled, x, y, w, h, color=nil, params={})
  x, y = from_screen(x, y)
  @context.save do
    set_source(color, params)
    set_line_options(params)
    @context.rectangle(x, y, w, h)
    apply_cairo_action(filled, params)
  end
end

#draw_rounded_rectangle(filled, x, y, w, h, radius, color = nil, params = {}) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 190

def draw_rounded_rectangle(filled, x, y, w, h, radius,
                           color=nil, params={})
  x, y = from_screen(x, y)
  x_radius = params[:x_radius] || radius
  y_radius = params[:y_radius] || radius

  @context.save do
    set_source(color, params)
    set_line_options(params)
    @context.new_path
    @context.rounded_rectangle(x, y, w, h, x_radius, y_radius)
    apply_cairo_action(filled, params)
  end
end

#draw_rsvg_handle(handle, x, y, params = {}) ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 310

def draw_rsvg_handle(handle, x, y, params={})
  x, y = from_screen(x, y)
  dim = handle.dimensions
  width = (params[:width] || dim.width).to_f
  height = (params[:height] || dim.height).to_f
  @context.save do
    @context.translate(x, y)
    @context.scale(width / dim.width, height / dim.height)
    @context.render_rsvg_handle(handle)
  end

  _draw_reflected_rsvg_handle(handle, x, y, width, height,
                              params)
end

#finish_context ⇒ Object 



109
110
111
112
113
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 109

def finish_context
  @contexts.pop
  @context.destroy if @context.respond_to?(:destroy)
  @context = @contexts.last
end

#finish_renderer ⇒ Object 



96
97
98
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 96

def finish_renderer
  finish_context
end

#init_context(context) ⇒ Object 



100
101
102
103
104
105
106
107
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 100

def init_context(context)
  @context = context
  @contexts ||= []
  @contexts.push(@context)
  set_line_width(1)
  @context.line_cap = ::Cairo::LINE_CAP_ROUND
  @context.line_join = ::Cairo::LINE_JOIN_ROUND
end

#init_renderer(drawable) ⇒ Object 



92
93
94
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 92

def init_renderer(drawable)
  init_context(drawable.create_cairo_context)
end

#make_layout(text) ⇒ Object 



344
345
346
347
348
349
350
351
352
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 344

def make_layout(text)
  attributes, text = Pango.parse_markup(text)
  layout = @context.create_pango_layout
  layout.text = text
  layout.attributes = attributes
  set_font_resolution(layout.context)
  @context.update_pango_layout(layout)
  layout
end

#poppler_available? ⇒ Boolean

Returns:

  • (Boolean) 


325
326
327
328
329
330
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 325

def poppler_available?
  if @@poppler_available.nil?
    @@poppler_available = Poppler.cairo_available?
  end
  @@poppler_available
end

#prepare_renderer(drawable) ⇒ Object 



89
90
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 89

def prepare_renderer(drawable)
end

#reflect_context(base, params = {}) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 131

def reflect_context(base, params={})
  case base
  when :y
    matrix = make_matrix(-1, 0, 0,
                          0, 1, 0)
  else
    matrix = make_matrix(1,  0, 0,
                         0, -1, 0)
  end
  @context.transform(matrix)
end

#restore_context ⇒ Object 



153
154
155
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 153

def restore_context
  @context.restore
end

#rotate_context(angle, params = {}) ⇒ Object 



123
124
125
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 123

def rotate_context(angle, params={})
  @context.rotate(convert_angle(angle, 0)[0])
end

#rsvg_available? ⇒ Boolean

Returns:

  • (Boolean) 


303
304
305
306
307
308
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 303

def rsvg_available?
  if @@rsvg_available.nil?
    @@rsvg_available = RSVG.cairo_available?
  end
  @@rsvg_available
end

#save_context ⇒ Object 



148
149
150
151
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 148

def save_context
  @context.save
  super
end

#scale_context(x, y, params = {}) ⇒ Object 



127
128
129
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 127

def scale_context(x, y, params={})
  @context.scale(x, y)
end

#set_font_resolution(context) ⇒ Object 



360
361
362
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 360

def set_font_resolution(context)
  context.resolution = @canvas.font_resolution
end

#set_source_pixbuf(pixbuf, params) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 265

def set_source_pixbuf(pixbuf, params)
  draw_scaled_pixbuf = params[:draw_scaled_pixbuf]
  draw_scaled_pixbuf = @draw_scaled_image if draw_scaled_pixbuf.nil?
  width = (params[:width] || pixbuf.width).to_f
  height = (params[:height] || pixbuf.height).to_f

  if [width, height] == [pixbuf.width, pixbuf.height]
    @context.set_source_pixbuf(pixbuf, 0, 0)
    return
  end

  case draw_scaled_pixbuf
  when true
    scaled_pixbuf = pixbuf.scale(width, height)
    @context.set_source_pixbuf(scaled_pixbuf, 0, 0)
  when false
    @context.set_source_pixbuf(pixbuf, 0, 0)
    matrix = ::Cairo::Matrix.scale(pixbuf.width / width,
                                   pixbuf.height / height)
    @context.source.matrix = matrix
  else
    scales = [4, 3, 2]
    scales.each do |scale|
      if width * scale < pixbuf.width and height * scale < pixbuf.height
        scaled_pixbuf = pixbuf.scale(width * scale, height * scale)
        @context.set_source_pixbuf(scaled_pixbuf)
        matrix = ::Cairo::Matrix.scale(scale, scale)
        @context.source.matrix = matrix
        return
      end
    end
    @context.set_source_pixbuf(pixbuf, 0, 0)
    matrix = ::Cairo::Matrix.scale(pixbuf.width / width,
                                   pixbuf.height / height)
    @context.source.matrix = matrix
  end
end

#shear_context(x, y, params = {}) ⇒ Object 



143
144
145
146
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 143

def shear_context(x, y, params={})
  @context.transform(make_matrix(1, x, 0,
                                 y, 1, 0))
end

#to_gdk_rgb(color) ⇒ Object 



115
116
117
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 115

def to_gdk_rgb(color)
  make_color(color).to_gdk_rgb
end

#translate_context(x, y, params = {}) ⇒ Object 



119
120
121
 
# File 'lib/rabbit/renderer/engine/cairo.rb', line 119

def translate_context(x, y, params={})
  @context.translate(x, y)
end