summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/control/ComponentAlign.lua
blob: dec07caaccd653474b9d187296436216a606ac0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
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
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
-- Copyright 2012 by Till Tantau
--
-- This file may be distributed an/or modified
--
-- 1. under the LaTeX Project Public License and/or
-- 2. under the GNU Public License
--
-- See the file doc/generic/pgf/licenses/LICENSE for more information

-- @release $Header$


local declare       = require "pgf.gd.interface.InterfaceToAlgorithms".declare


---
-- @section subsubsection {Aligning Components}
--
-- When components are placed next to each from left to right, it
-- is not immediately clear how the components should be aligned
-- vertically. What happens is that in each component a horizontal line is
-- determined and then all components are shifted vertically so that the
-- lines are aligned. There are different strategies for choosing these
-- ``lines'', see the description of the options described later on.
-- When the |component direction| option is used to change the direction
-- in which components are placed, it certainly make no longer sense to
-- talk about ``horizontal'' and ``vertical'' lines. Instead, what
-- actually happens is that the alignment does not consider
-- ``horizontal'' lines, but lines that go in the direction specified by
-- |component direction| and aligns them by moving components along a
-- line that is perpendicular to the line. For these reasons, let us call
-- the line in the component direction the \emph{alignment line} and a
-- line that is perpendicular to it the \emph{shift line}.
--
-- The first way of specifying through which point of a component the
-- alignment line should get is to use the option |align here|.
-- In many cases, however, you will not wish to specify an alignment node
-- manually in each component. Instead, you will use the
-- |component align| key to specify a \emph{strategy} that should be used to
-- automatically determine such a node.
--
-- Using a combination of |component direction| and |component align|,
-- numerous different packing strategies can be configured. However,
-- since names like |counterclockwise| are a bit hard to remember and to
-- apply in practice, a number of easier-to-remember keys are predefined
-- that combine an alignment and a direction.
--
-- @end

  
---
  
declare {
  key = "align here",
  type = "boolean",

  summary = [["  
       When this option is given to a node, this alignment line will go
       through the origin of this node. If this option is passed to more
       than one node of a component, the node encountered first in the
       component is used.
  "]],
  examples = [["     
       \tikz \graph [binary tree layout, nodes={draw}]
         { a, b -- c[align here], d -- e[second, align here] -- f };
  "]]
}

---

declare {
  key = "component align",
  type = "string",
  initial = "first node",
  
  summary = [["
    Specifies a ``strategy'' for the alignment of components.
  "]],
  documentation = [["  
       The following values are permissible:
       \begin{itemize}
       \item \declare{|first node|}
           In each component, the alignment line goes through the center of
           the first node of the component encountered during specification
           of the component.
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component align=first node]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
         \item \declare{|center|}
    
           The nodes of the component are projected onto the shift line. The
           alignment line is now chosen so that it is exactly in the middle
           between the maximum and minimum value that the projected nodes
           have on the shift line.
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component align=center]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component direction=90,
              component align=center]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
         \item \declare{|counterclockwise|}
      
           As for |center|, we project the nodes of the component onto the
           shift line. The alignment line is now chosen so that it goes
           through the center of the node whose center has the highest
           projected value.
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component align=counterclockwise]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component direction=90,
              component align=counterclockwise]
 { a, b -- c, d -- e[second] -- f };
\end{codeexample}
           The name |counterclockwise| is intended to indicate that the align
           line goes through the node that comes last if we go from the
           alignment direction in a counter-clockwise direction.
         \item \declare{|clockwise|}
          
           Works like |counterclockwise|, only in the other direction:
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component align=clockwise]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
\begin{codeexample}[]
\tikz \graph [binary tree layout, nodes={draw},
              component direction=90,
              component align=clockwise]
  { a, b -- c, d -- e[second] -- f };
\end{codeexample}
         \item \declare{|counterclockwise bounding box|}
      
           This method is quite similar to |counterclockwise|, only the
           alignment line does not go through the center of the node with a
           maximum projected value on the shift line, but through the maximum
           value of the projected bounding boxes. For a left-to-right
           packing, this means that the components are aligned so that the
           bounding boxes of the components are aligned at the top.
\begin{codeexample}[]
\tikz \graph [tree layout, nodes={draw, align=center},
              component sep=0pt,
              component align=counterclockwise]
  { a, "high\\node" -- b};\quad
\tikz \graph [tree layout, nodes={draw, align=center},
              component sep=0pt,
              component align=counterclockwise bounding box]
  { a, "high\\node" -- b};
\end{codeexample}
         \item \declare{|clockwise bounding box|}
       
         Works like |counterclockwise bounding box|.
       \end{itemize}
  "]]
}

---

declare {
  key = "components go right top aligned",
  use = {
    { key = "component direction", value = 0},
    { key = "component align", value = "counterclockwise"},
  },

  summary = [["  
         Shorthand for |component direction=right| and
         |component align=counterclockwise|. This means that, as the name
         suggest, the components will be placed left-to-right and they are
         aligned such that their top nodes are in a line.
  "]],
  examples = [["       
       \tikz \graph [tree layout, nodes={draw, align=center},
                     components go right top aligned]
         { a, "high\\node" -- b};
  "]]
}

---

declare {
  key = "components go right absolute top aligned",
  use = {
    { key = "component direction", value=0},
    { key = "component align", value = "counterclockwise bounding box"},
  },
  
  summary = [["  
       Like |components go right top aligned|, but with
       |component align| set to |counterclockwise| |bounding box|. This means that the
       components will be aligned with their bounding boxed being
       top-aligned.
  "]],
  examples = [["
       \tikz \graph [tree layout, nodes={draw, align=center},
                     components go right absolute top aligned]
         { a, "high\\node" -- b};
  "]]
}

---

declare {
  key = "components go right bottom aligned",
  use = {
    { key = "component direction", value=0},
    { key = "component align", value = "clockwise"},
  },
  
  summary = "See the other |components go ...| keys."
}

---
--

declare {
  key = "components go right absolute bottom aligned",
  use = {
    { key = "component direction", value=0},
    { key = "component align", value = "clockwise bounding box"},
  },
  
  summary = "See the other |components go ...| keys."
}


---

declare {
  key = "components go right center aligned",
  use = {
    { key = "component direction", value=0},
    { key = "component align", value = "center"},
  },
  
  summary = "See the other |components go ...| keys."
}


---

declare {
  key = "components go right",
  use = {
    { key = "component direction", value=0},
    { key = "component align", value = "first node"},
  },
  
  summary = [["  
       Shorthand for |component direction=right| and
       |component align=first node|.
   "]]
 }


---

declare {
  key = "components go left top aligned",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "clockwise"},
  },
  
  summary = "See the other |components go ...| keys.",

  examples = [["  
       \tikz \graph [tree layout, nodes={draw, align=center},
                     components go left top aligned]
         { a, "high\\node" -- b};
  "]]
}

---
--

declare {
  key = "components go left absolute top aligned",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "clockwise bounding box"},
  },
  
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go left bottom aligned",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "counterclockwise"},
  },
  
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go left absolute bottom aligned",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "counterclockwise bounding box"},
  },
  
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go left center aligned",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "center"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go left",
  use = {
    { key = "component direction", value=180},
    { key = "component align", value = "first node"},
  },
  summary = "See the other |components go ...| keys."
}



---

declare {
  key = "components go down right aligned",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "counterclockwise"},
  },
  summary = "See the other |components go ...| keys.",

  examples = {
    [["  
       \tikz \graph [tree layout, nodes={draw, align=center},
                     components go down left aligned]
         { a, hello -- {world,s} };
    "]],
    [["
       \tikz \graph [tree layout, nodes={draw, align=center},
                     components go up absolute left aligned]
         { a, hello -- {world,s}};
    "]]
  }
}

---
--

declare {
  key = "components go down absolute right aligned",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "counterclockwise bounding box"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go down left aligned",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "clockwise"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go down absolute left aligned",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "clockwise bounding box"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go down center aligned",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "center"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go down",
  use = {
    { key = "component direction", value=270},
    { key = "component align", value = "first node"},
  },
  summary = "See the other |components go ...| keys."
}

---
--

declare {
  key = "components go up right aligned",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "clockwise"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go up absolute right aligned",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "clockwise bounding box"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go up left aligned",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "counterclockwise"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go up absolute left aligned",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "counterclockwise bounding box"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go up center aligned",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "center"},
  },
  summary = "See the other |components go ...| keys."
}


---
--

declare {
  key = "components go up",
  use = {
    { key = "component direction", value=90},
    { key = "component align", value = "first node"},
  },
  summary = "See the other |components go ...| keys."
}




return Components