Module: MagickPFA

Included in:
PFA::RelativePFA::Node
Defined in:
lib/pfa/imagemagick_module.rb

Overview

Note:

On le met en module pour avoir toutes les méthodes séparées du module principal.

Module inclus dans la classe RelativePFA::Node

Constant Summary collapse

DIMS_CONSTANTS_PER_THING =
Note:

Les tailles sont calculées pour un livre de 5.25 po (1334 mm) x 8 po (2032 mm) avec des marges de 20 mm Donc une surface utilisable de :

  1334 - 2 * 20 = 1334 - 40 = 1294
x 2032 - 2 * 20 = 2032 - 40 = 1992

Comme l’image sera mise “de travers” dans la page, sa largeur sera de 1992 et sa hauteur 1294. On triple pour obtenir une bonne taille pour l’imprimerie. Donc :

3 x 1992 = 5976 px en largeur (PFA_WIDTH)
3 x 1294 = 3882 px en hauteur (PFA_HEIGHT)

Soit un rapport de 5976 / 3882 = 1,5394

Pour les tests, on utilise les valeurs 4000 px x 2598 px (4000 / 1,5394)

Note:

En fait, :pfa_height ne définit pas vraiment la hauteur des PFA (et donc de l’image) mais permet de calculer la hauteur de ligne LINE_HEIGHT. L’image, elle, fera 12 * LINE_HEIGHT de hauteur.

Largeur totale du graphique (noter que les dimensions sont les mêmes pour l’image JPG et l’image HTML)

{
  real_book: {
    pfa_width: 5976, pfa_height: 3882, pfa_left_margin: 0, pfa_right_margin:0,
    font_size: 15
  },
  test: {
    pfa_width: 4000, pfa_height: 2598, pfa_left_margin: 20, pfa_right_margin:20,
    font_size: 15
  },
  default: {
    pfa_width: 4000, pfa_height: 2598, pfa_left_margin: 20, pfa_right_margin:20,
    font_size: 15
  },
}
FONTHEIGHT_MAIN_TITLE = 
25
CONVERT_CMD =

– Commande ImageMagick –

'convert'
CODE_TITRE_PARADIGME =

Pour écrire le titre du paradigme

<<~CMD.strip.freeze
-pointsize %{lh}
-font Arial
-draw "text %{lf},%{tp} '%{titre}'"
CMD
CODE_BOITE_ACTE = 
<<~CMD.strip.freeze
-stroke black
-strokewidth 3
-background transparent
-fill transparent
-draw "rectangle %{lf},%{tp} %{rg},%{bt}"
CMD
CODE_PART_NAME = 
<<~CMD.strip.freeze
  \\( -extent %{w}x%{h} -stroke black -strokewidth 1 -background transparent 
  -pointsize %{fs}  -font Arial -gravity Center label:"%{n}" \\) 
  -geometry +%{gh}+%{gv} -gravity NorthWest -composite
CMD
CODE_HORLOGE =

Code ImageMagick de l’horloge pour les parties

<<~CMD.strip.freeze
\\( -extent %{w}x%{h} -background %{bg} -stroke %{fg}  -strokewidth 1 -fill %{fg}
-pointsize %{fs} -font Georgia -gravity Center label:"%{mk}" \\) 
-geometry +%{l}+%{t} -gravity %{g} -composite
CMD
CODE_OFFSET =

Code ImageMagick pour indiquer le décalage entre le temps réel et le temps absolu.

<<~CMD.strip.freeze
\\( -extent %{wo}x%{ho} -pointsize %{fso} -font Georgia -background %{bgo}
-fill %{fgo} -stroke %{fgo} -strokewidth 1 -gravity Center 
label:"%{mko}" \\) -geometry +%{lo}+%{to} -gravity NorthWest -composite    
CMD
CODE_IMAGEMAGICK_NOEUD =

de Field Augmenté

Returns:

  • (BashString) —

    Code Image Magick pour un noeud du Paradigme

<<~CMD.strip.freeze
-stroke black
-fill gray40
-draw "circle %{l},%{t} %{r},%{b}"
\\( -extent %{w}x%{h} -pointsize %{fs} -stroke black -fill black -background transparent -gravity %{a} 
label:"%{m}" \\) -geometry +%{lm}+%{tm} -gravity NorthWest -composite
CMD
CODE_IMAGEMAGICK_SEQUENCE =

TODO : À FAIRE

<<~CMD.strip.freeze
-stroke black
-fill black
-draw "circle %{l},%{t} %{r},%{b}"
CMD
RECTIFS =

# La marque pour un nœud (un rond/point) def img_lines_for_real_noeud

<<~CMD
-strokewidth #{AnyBuilder::BORDERS[:noeud]}
-stroke #{AnyBuilder::COLORS[:noeud]}
-fill white
-draw "roundrectangle #{left},#{top} #{right},#{bottom} 10,10"
#{mark_horloge}
CMD

end

{
  part:         50, 
  sequence:     0, 
  noeud:        0
}
ABS_FONTWEIGHTS =

Graisse de la police en fonction du type de l’élément

{
  part:     3,
  sequence: 2,
  noeud:    1
}
FONTWEIGHTS = 
{ 
  part:     1,
  sequence: 1, 
  noeud:    1 
}
COLORS =

Couleur en fonction du type de l’élément

{
  part:     'gray75',
  sequence: 'gray55',
  noeud:    'gray55' 
}
DARKERS =

Couleur plus sombre en fonction de l’élément

{
  part:     'gray50',
  sequence: 'gray45',
  noeud:    'gray45' 
}
GRAVITIES =

Gravité en fonction du type de l’élément

{
  part:     'Center',
  sequence: 'Center',
  noeud:    'Center'
}
ABS_BORDERS =

Largeur des bords en fonction du type de l’élément

{
  part:     3,
  sequence: 2,
  noeud:    1
}
BORDERS = 
{
  part:     1,
  sequence: 1, 
  noeud:    1
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.code_for_intro ⇒ Object

Le début du code de la commande convert



225
226
227
228
229
230
231
232
233
 
# File 'lib/pfa/imagemagick_module.rb', line 225

def self.code_for_intro
  <<~CMD.strip
  #{CONVERT_CMD} -size #{PFA_WIDTH}x#{LINE_HEIGHT * 12} xc:white 
  -units PixelsPerInch
  -density 300
  -background transparent
  -set colorspace sRGB
  CMD
end

.define_dims_constants(key_thing) ⇒ Object

Définition des dimensions

Parameters:

  • params (Symbol|Hash) —

    Soit la clé dans la table DIMS_CONSTANTS_PER_THING Soit une table définissant :pfa_width, :pfa_height, :pfa_left_margin, pfa_right_margin



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
149
150
151
152
153
154
155
156
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/pfa/imagemagick_module.rb', line 77

def self.define_dims_constants(key_thing)

  params = nil
  case key_thing
  when Symbol then params = DIMS_CONSTANTS_PER_THING[key_thing]
  when Hash
    #
    # Table fournie
    # (dans ce cas, il faut vérifier les valeurs et mettre les
    #  valeurs par défaut des valeurs manquantes)
    # 
    params = key_thing
    DIMS_CONSTANTS_PER_THING[:default].each do |key, value|
      params.key?(key) || params.merge!(key => value)
    end
  else raise PFAFatalError.new(101)
  end

  params.each do |key, value|
    const_name = key.to_s.upcase
    rem_const_if_exists(const_name)
    # Object.const_set(const_name, value)
    # self.class.const_set(const_name, value)
    MagickPFA.const_set(const_name, value)
  end

  #
  # Définition de la hauteur de ligne 
  # 
  rem_const_if_exists('LINE_HEIGHT') # tests
  MagickPFA.const_set('LINE_HEIGHT', (MagickPFA::PFA_HEIGHT.to_f / 15).to_i)
  # MagickPFA.const_set('LINE_HEIGHT', (MagickPFA::PFA_HEIGHT.to_f / 10).to_i)

  rem_const_if_exists('QUART_LINE_HEIGHT') # tests
  MagickPFA.const_set('QUART_LINE_HEIGHT', LINE_HEIGHT / 4)

  #
  # Différence en hauteur du paradigme réel par rapport au paradigme
  # idéal
  # 
  rem_const_if_exists('VOFFSET_REL_PFA') # tests
  MagickPFA.const_set('VOFFSET_REL_PFA', 6 * LINE_HEIGHT)

  rem_const_if_exists('TOP_MARGIN')
  MagickPFA.const_set('TOP_MARGIN', 4 * FONTHEIGHT_MAIN_TITLE)

  #
  # Position verticale des éléments en fonction de leur nature
  # 
  rem_const_if_exists('ABS_TOPS') # tests
  MagickPFA.const_set('ABS_TOPS', {
      part:         TOP_MARGIN,
      sequence:     TOP_MARGIN + 3 * LINE_HEIGHT,       
      noeud:        TOP_MARGIN + 3 * LINE_HEIGHT,
  })
  rem_const_if_exists('ABS_BOTTOMS') # tests
  MagickPFA.const_set('ABS_BOTTOMS', {
    part:         ABS_TOPS[:part]     + VOFFSET_REL_PFA - LINE_HEIGHT - 100,
    sequence:     ABS_TOPS[:sequence] + VOFFSET_REL_PFA,
    noeud:        ABS_TOPS[:noeud]    + VOFFSET_REL_PFA,
  })
  rem_const_if_exists('TOPS') # tests
  MagickPFA.const_set('TOPS', {
    part:         ABS_BOTTOMS[:part]      + LINE_HEIGHT,
    sequence:     ABS_TOPS[:sequence]     + VOFFSET_REL_PFA,
    noeud:        ABS_TOPS[:noeud]        + VOFFSET_REL_PFA,
  })
  rem_const_if_exists('BOTTOMS') # tests
  MagickPFA.const_set('BOTTOMS', {
    part:       ABS_BOTTOMS[:part]      + VOFFSET_REL_PFA,
    sequence:   ABS_BOTTOMS[:sequence]  + VOFFSET_REL_PFA,
    noeud:      ABS_BOTTOMS[:noeud]     + VOFFSET_REL_PFA,
  })
  #
  # Hauteur en fonction du type des éléments 
  # 
  rem_const_if_exists('HEIGHTS') # tests
  MagickPFA.const_set('HEIGHTS', { 
    part:     PFA_HEIGHT / 1.4,
    sequence: 50, # avant : PFA::LINE_HEIGHT (dans fichier relatif)
    noeud:    50  # idem
  })

  #
  # Taille de fonte de base. Elle correspond à la grosseur
  # des séquences
  # 
  # @todo
  #   Plus tard, on pourra modifier aussi les proportions de
  #   chaque taille de partie
  # 
  rem_const_if_exists('BASE_FONTSIZE') # tests
  MagickPFA.const_set('BASE_FONTSIZE', params[:font_size])

  rem_const_if_exists('FONTSIZES') # tests
  MagickPFA.const_set('FONTSIZES', {
    part:     1.6 * BASE_FONTSIZE,
    sequence: 1.0 * BASE_FONTSIZE,
    noeud:    1.0 * BASE_FONTSIZE,
  })

  rem_const_if_exists('Label_Width') # tests
  MagickPFA.const_set('Label_Width', {
    part:     400,
    sequence: 400,
    noeud:    400,
  })
  rem_const_if_exists('Label_Height') # tests
  MagickPFA.const_set('Label_Height', {
    part:     200,
    sequence: 200,
    noeud:    200,
  })

  # Taille de fonte des horloges par partie
  rem_const_if_exists('FontSize_Horloges') # tests
  MagickPFA.const_set('FontSize_Horloges', {
    part:     1.2 * BASE_FONTSIZE,
    sequence: 1.2 * BASE_FONTSIZE,
    noeud:    1.2 * BASE_FONTSIZE,
  })
  rem_const_if_exists('Horloge_Width') # tests
  MagickPFA.const_set('Horloge_Width', {
    part:     300,
    sequence: 300,
    noeud:    300
  })
  # Hauteur de l'horloge (pour glisser l'offset en dessous)
  rem_const_if_exists('Horloge_Height') # tests
  MagickPFA.const_set('Horloge_Height', {
    part:     112,
    sequence: 112,
    noeud:    112
  })

  # Décalage vertical pour que les horloges des actes et de fin
  # soient bien collées au bord haut
  rem_const_if_exists('VOFFSET_MAIN_HORLOGES') # tests
  MagickPFA.const_set('VOFFSET_MAIN_HORLOGES', Horloge_Height[:part] - 60)

end

.rem_const_if_exists(const_name) ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'lib/pfa/imagemagick_module.rb', line 61

def self.rem_const_if_exists(const_name)
  if MagickPFA.const_defined?(const_name)
    # dbg "Je dois détruire la constante #{key.to_s.upcase}".orange
    MagickPFA.send(:remove_const, const_name)
  end
  if MagickPFA.const_defined?(const_name)
    MagickPFA.send(:remove_const, const_name)
  end
end

Instance Method Details

#act_box_code(real_pfa) ⇒ Object

BashString

Code pour dessiner le noeud, quand c’est un acte,

dans l’image.



380
381
382
383
384
385
386
387
 
# File 'lib/pfa/imagemagick_module.rb', line 380

def act_box_code(real_pfa)
  CODE_BOITE_ACTE % {
    lf: real_pfa ? left : abs_left, 
    tp: (real_pfa ? top : abs_top) + 50, # +50 pour ne pas coller au main title 
    rg: real_pfa ? right : abs_right, 
    bt: real_pfa ? bottom : abs_bottom
  }
end

#act_name_code(for_pfa) ⇒ Object

BashString

Code pour dessiner les noms des parties (actes)



390
391
392
393
394
395
396
 
# File 'lib/pfa/imagemagick_module.rb', line 390

def act_name_code(for_pfa)
  CODE_PART_NAME % {
    w: for_pfa ? width : abs_width, h: FONTSIZES[:part] + 100, n: mark, fs: FONTSIZES[:part], 
    gh: for_pfa ? left : abs_left, # pour la géométrie, décalage par rapport au Nord-Ouest
    gv: (for_pfa ? top : abs_top) + LINE_HEIGHT,  # pour la géométrie, décalage vertical
  }
end

#horloge_code(real_pfa, current_left) ⇒ BashString

les éléments

Returns:

  • (BashString) —

    Le code Image Magick de l’horloge pour tous



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/pfa/imagemagick_module.rb', line 284

def horloge_code(real_pfa, current_left)
  start_ntime = real_pfa ? start_at : abs_start
  #
  # Si c'est le noeud réel, il faut calculer son décalage avec le
  # noeud absolu
  # 
  start_at.calc_offset(abs_start) if real_pfa
  #
  # Le left dépend de la nature de l'élément
  # @TODO Il serait possible de mettre ça en propriété de l'éménet
  # 
  theleft = if part?
    (real_pfa ? left : abs_left) + 2
  else
    (real_pfa ? left : abs_left) - Horloge_Width[type] / 2
  end

  # Problème d'overlay
  if current_left && theleft < current_left
    theleft = current_left + 10
  end

  #
  # Le top dépend de la nature de l'élément
  # 
  thetop = if part?
    (real_pfa ? top : abs_top) + VOFFSET_MAIN_HORLOGES
  else
    (real_pfa ? top : abs_top) + 50
  end

  background = part? ? 'black' : 'gray90'
  foreground = part? ? 'gray90' : 'black'

  #
  # Les données template en fonction du pfa absolu ou réel
  # 
  data_template = {
    w:    Horloge_Width[type],  # largeur (sauf pour actes)
    h:    Horloge_Height[type], # hauteur de l'horloge (surtout pour décalage)
    l:    theleft,  # left de l'horloge
    t:    thetop,  # top de l'horloge (et du décalage)
    fs:   FontSize_Horloges[type], # Font size
    bg:   background,
    fg:   foreground,
    mk:   start_ntime.to_horloge, # Horloge
    g:    'NorthWest',
  }
  #
  # On ajoute les valeurs pour le pfa réel
  # 
  data_template.merge!({
    wo:   Horloge_Width[type],
    ho:   Horloge_Height[type],
    lo:   theleft, # left de la marque de décalage
    to:   thetop + Horloge_Height[type],  # top de l'offset (sous l'horloge)
    fso:  FontSize_Horloges[type] - 4, # Font size pour le décalage
    mko:  start_ntime.offset_as_horloge(abs_start), # marque du décalage
          # @note
          #   Il faut impérativement appeler offset_as_horloge avant
          #   le reste ci-dessous, 
    bgo:  start_ntime.background_per_offset, # background du décalage 
    fgo:  start_ntime.foreground_per_offset, # couleur du décalage      
  }) if real_pfa

  code =  CODE_HORLOGE
  code += ' ' + CODE_OFFSET if real_pfa
  code % data_template
end

#horloge_fin(real_pfa) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/pfa/imagemagick_module.rb', line 354

def horloge_fin(real_pfa)
  CODE_HORLOGE % {
    w:    Horloge_Width[type],
    h:    Horloge_Height[type],
    l:    0,
    t:    (real_pfa ? top : abs_top) + VOFFSET_MAIN_HORLOGES,
    fs:   FontSize_Horloges[type], # Font size
    mk:   pfa.duration.as_horloge,
    bg:   'black',
    fg:   'white',
    g:    'NorthEast'
  }
end

#image_magick_code(real_pfa, current_left) ⇒ BashString

Returns Le code pour dessiner l’élément.

Parameters:

  • real_pfa (Bool) —

    Pour savoir si on doit retourner le code pour le pfa réel ou pour le pfa absolu.

  • current_left (Integer|Float) —

    Le left sur lequel on se trouve, pour savoir si ça déborde

Returns:

  • (BashString) —

    Le code pour dessiner l’élément



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/pfa/imagemagick_module.rb', line 408

def image_magick_code(real_pfa, current_left)
  code =  if type == :sequence
            CODE_IMAGEMAGICK_SEQUENCE
          else
            CODE_IMAGEMAGICK_NOEUD
          end
  # Données template (en fonction du paradigem)
  # dbg "Node : #{id}".orange
  # dbg "Node type : #{type.inspect}".orange
  data_temp = {
    l: real_pfa ? left : abs_left, # alignement gauche
    t: real_pfa ? top : abs_top, # top
    w: Label_Width[type], # largeur pour la marque (pour le moment, arbitraire)
    h: Label_Height[type], # hauteur pour la marque (sur deux lignes)
    fs: FONTSIZES[type],
    a:  'Center', # modifié par l'overlay
    m: mark.gsub(/ /,"\\n"),
  }

  data_temp.merge!({
    # Noter que ci-dessous on n'utilise pas le @width de l'élément
    # pour avoir des ronds uniformes
    r:  data_temp[:l] + 20, # right (pour la boite du nom)
    b:  data_temp[:t] + 20,
    lm: data_temp[:l] - data_temp[:w] / 2, # le left de la marque du nom
    tm: data_temp[:t] - 250, # le top de la marque
    lh: data_temp[:l] - data_temp[:w] / 2, # le left de l'horloge
    th: data_temp[:t] + 150, # le top de l'horloge
  })

  if current_left && data_temp[:lm] < current_left
    # dbg "PROBLÈME D'OVERLAY avec #{id} (:l)".rouge
    data_temp[:lm] = current_left
    data_temp[:a]  = 'West'
  end

  code % data_temp
end

#titre_pfa(for_real) ⇒ Object

BashCode

Code ImageMagick pour le titre des paradigmes



369
370
371
372
373
374
375
376
 
# File 'lib/pfa/imagemagick_module.rb', line 369

def titre_pfa(for_real)
  CODE_TITRE_PARADIGME % {
    lf: 20, 
    lh: 25, # line-height (aka font-size)
    tp: (for_real ? top : abs_top), 
    titre: for_real ? "PARADIGME RÉEL DU FILM" : "PARADIGME IDÉAL DU FILM"
  }
end