Skip to content

SplitTemplate

src.templates.split.SplitTemplate

Bases: BaseTemplate

  • A template for split cards introduced in Invasion.
Adds
  • Must return all properties shared by both halves as a list of two items (left, right).
  • Must overwrite a lot of core functionality to navigate rendering 2 cards in one template.
Todo
  • Formalize as a vector template, implement 'Modifier' class.
Source code in src\templates\split.py
 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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
class SplitTemplate (BaseTemplate):
    """
    * A template for split cards introduced in Invasion.

    Adds:
        * Must return all properties shared by both halves as a list of two items (left, right).
        * Must overwrite a lot of core functionality to navigate rendering 2 cards in one template.

    Todo:
        * Formalize as a vector template, implement 'Modifier' class.
    """
    is_vehicle = False
    is_artifact = False

    # Color and gradient maps
    fuse_gradient_locations = {
        **CON.gradient_locations.copy(),
        2: [.50, .54],
        3: [.28, .33, .71, .76],
        4: [.28, .33, .50, .54, .71, .76]
    }
    pinline_gradient_locations = [
        {**CON.gradient_locations.copy(), 2: [.28, .33]},
        {**CON.gradient_locations.copy(), 2: [.71, .76]}
    ]

    def __init__(self, layout: SplitLayout, **kwargs):
        super().__init__(layout, **kwargs)

    """
    * Mixin Methods
    """

    @property
    def post_text_methods(self):
        """Rotate card sideways."""
        return [*super().post_text_methods, psd.rotate_counter_clockwise]

    """
    * Bool Properties
    """

    @auto_prop_cached
    def is_centered(self) -> list[bool]:
        """Allow centered text for each side independently."""
        return [
            bool(
                len(self.layout.flavor_text[i]) <= 1
                and len(self.layout.oracle_text[i]) <= 70
                and "\n" not in self.layout.oracle_text[i]
            ) for i in range(2)
        ]

    @auto_prop_cached
    def is_fuse(self) -> bool:
        """Determine if this is a 'Fuse' split card."""
        return bool('Fuse' in self.layout.keywords)

    """
    * Colors
    """

    @auto_prop_cached
    def color_limit(self) -> int:
        """One more than the max number of colors this card can split by."""
        return 3

    @auto_prop_cached
    def fuse_pinlines(self) -> str:
        """Merged pinline colors of each side."""
        if self.pinlines[0] != self.pinlines[1]:
            return self.pinlines[0] + self.pinlines[1]
        return self.pinlines[0]

    @auto_prop_cached
    def fuse_textbox_colors(self) -> str:
        """Gold if Fuse colors are more than 3, otherwise use Fuse colors."""
        if len(self.fuse_pinlines) > 3:
            return LAYERS.GOLD
        return self.fuse_pinlines

    @auto_prop_cached
    def fuse_pinline_colors(self) -> Union[list[int], list[dict]]:
        """Color definition for Fuse pinlines."""
        return psd.get_pinline_gradient(
            self.fuse_pinlines, location_map=self.fuse_gradient_locations)

    @auto_prop_cached
    def fuse_pinlines_action(self) -> Union[psd.create_color_layer, psd.create_gradient_layer]:
        """Action used to render Fuse pinlines."""
        return psd.create_color_layer if isinstance(
            self.fuse_pinline_colors, SolidColor
        ) else psd.create_gradient_layer

    @auto_prop_cached
    def pinlines_colors(self) -> list[Union[list[int], list[dict]]]:
        """Color definitions used for pinlines of each side."""
        return [
            psd.get_pinline_gradient(p, location_map=self.pinline_gradient_locations[i])
            for i, p in enumerate(self.pinlines)]

    @auto_prop_cached
    def pinlines_action(self) -> list[Union[psd.create_color_layer, psd.create_gradient_layer]]:
        """Action used to render the pinlines of each side."""
        return [
            psd.create_color_layer if isinstance(
                colors, SolidColor
            ) else psd.create_gradient_layer
            for colors in self.pinlines_colors]

    """
    * Layer Groups
    """

    @auto_prop_cached
    def fuse_group(self) -> Optional[LayerSet]:
        """Fuse elements parent group."""
        return psd.getLayerSet('Fuse')

    @auto_prop_cached
    def fuse_textbox_group(self) -> Optional[LayerSet]:
        """Fuse textbox group."""
        return psd.getLayerSet(LAYERS.TEXTBOX, self.fuse_group)

    @auto_prop_cached
    def fuse_pinlines_group(self) -> Optional[LayerSet]:
        """Fuse pinlines group."""
        return psd.getLayerSet(LAYERS.PINLINES, self.fuse_group)

    @auto_prop_cached
    def text_group(self) -> Optional[LayerSet]:
        """One text and icons group located in the 'Left' side group."""
        return psd.getLayerSet(LAYERS.TEXT_AND_ICONS, LAYERS.LEFT)

    @auto_prop_cached
    def card_groups(self):
        """Left and Right side parent groups."""
        return [
            psd.getLayerSet(LAYERS.LEFT),
            psd.getLayerSet(LAYERS.RIGHT)
        ]

    @auto_prop_cached
    def pinlines_groups(self) -> list[LayerSet]:
        """Pinlines group for each side."""
        return [psd.getLayerSet(LAYERS.PINLINES, group) for group in self.card_groups]

    @auto_prop_cached
    def twins_groups(self) -> list[LayerSet]:
        """Twins group for each side."""
        return [psd.getLayerSet(LAYERS.TWINS, group) for group in self.card_groups]

    @auto_prop_cached
    def textbox_groups(self) -> list[LayerSet]:
        """Textbox group for each side."""
        return [psd.getLayerSet(LAYERS.TEXTBOX, group) for group in self.card_groups]

    @auto_prop_cached
    def background_groups(self) -> list[LayerSet]:
        """Background group for each side."""
        return [psd.getLayerSet(LAYERS.BACKGROUND, group) for group in self.card_groups]

    """
    * References
    """

    @auto_prop_cached
    def textbox_reference(self) -> list[ArtLayer]:
        """Textbox positioning reference for each side."""
        return [
            psd.get_reference_layer(
                LAYERS.TEXTBOX_REFERENCE + ' Fuse' if self.is_fuse else LAYERS.TEXTBOX_REFERENCE,
                psd.getLayerSet(LAYERS.TEXT_AND_ICONS, group)
            ) for group in self.card_groups]

    @auto_prop_cached
    def name_reference(self) -> list[ArtLayer]:
        """list[ArtLayer]: Name reference for each side."""
        return self.text_layer_name

    @auto_prop_cached
    def type_reference(self) -> list[ArtLayer]:
        """list[ArtLayer]: Typeline reference for each side."""
        return [
            n or self.expansion_reference[i]
            for i, n in enumerate(self.expansion_symbols)]

    @auto_prop_cached
    def twins_reference(self) -> list[ArtLayer]:
        """Twins positioning reference for each side."""
        return [psd.getLayer('Reference', [group, LAYERS.TWINS]) for group in self.card_groups]

    @auto_prop_cached
    def background_reference(self) -> list[ArtLayer]:
        """Background positioning reference for each side."""
        return [psd.getLayer('Reference', [group, LAYERS.BACKGROUND]) for group in self.card_groups]

    @auto_prop_cached
    def art_reference(self) -> list[ArtLayer]:
        """Art layer positioning reference for each side."""
        return [psd.getLayer(LAYERS.ART_FRAME, group) for group in self.card_groups]

    """
    * Text Layers
    """

    @auto_prop_cached
    def text_layer_name(self) -> list[ArtLayer]:
        """Name text layer for each side."""
        return [psd.getLayer(LAYERS.NAME, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

    @auto_prop_cached
    def text_layer_rules(self) -> list[ArtLayer]:
        """Rules text layer for each side."""
        return [psd.getLayer(LAYERS.RULES_TEXT, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

    @auto_prop_cached
    def text_layer_type(self) -> list[ArtLayer]:
        """Typeline text layer for each side."""
        return [psd.getLayer(LAYERS.TYPE_LINE, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

    @auto_prop_cached
    def text_layer_mana(self) -> list[ArtLayer]:
        """Mana cost text layer for each side."""
        return [psd.getLayer(LAYERS.MANA_COST, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

    """
    * Expansion Symbol
    """

    @auto_prop_cached
    def expansion_references(self) -> list[ArtLayer]:
        """Expansion reference for each side."""
        return [self.expansion_reference, self.expansion_reference_right]

    @auto_prop_cached
    def expansion_reference_right(self) -> None:
        """Right side expansion symbol reference."""
        return psd.getLayer(LAYERS.EXPANSION_REFERENCE, [LAYERS.RIGHT, LAYERS.TEXT_AND_ICONS])

    @auto_prop_cached
    def expansion_symbols(self) -> list[Optional[ArtLayer]]:
        """Expansion symbol layers for each side. Right side is generated duplicating the left side."""
        if self.expansion_symbol_layer:
            layer = self.expansion_symbol_layer.duplicate(self.expansion_reference_right, ElementPlacement.PlaceAfter)
            psd.align_right(layer, self.expansion_reference_right)
            return [self.expansion_symbol_layer, layer]
        return [None, None]

    """
    * Layers
    """

    @auto_prop_cached
    def art_layer(self) -> list[ArtLayer]:
        """Art layer for each side."""
        return [psd.getLayer(LAYERS.DEFAULT, group) for group in self.card_groups]

    @auto_prop_cached
    def background_layer(self) -> list[ArtLayer]:
        """Background layer for each side."""
        return [psd.getLayer(b, LAYERS.BACKGROUND) for b in self.background]

    @auto_prop_cached
    def twins_layer(self) -> list[ArtLayer]:
        """Twins layer for each side."""
        return [psd.getLayer(t, LAYERS.TWINS) for t in self.twins]

    @auto_prop_cached
    def textbox_layer(self) -> list[ArtLayer]:
        """Textbox layer for each side."""
        return [psd.getLayer(t, LAYERS.TEXTBOX) for t in self.pinlines]

    @auto_prop_cached
    def divider_layer(self) -> list[Optional[ArtLayer]]:
        """Divider layer for each side. List updated if either side has flavor text."""
        return [None, None]

    """
    * Blending Masks
    """

    @auto_prop_cached
    def mask_layers(self) -> list[ArtLayer]:
        """Blending masks supported by this template."""
        return [psd.getLayer(LAYERS.HALF, LAYERS.MASKS)]

    """
    * Watermarks
    """

    @auto_prop_cached
    def watermark_colors(self) -> list[list[SolidColor]]:
        """A list of 'SolidColor' objects for each face."""
        colors = []
        for i, pinline in enumerate(self.pinlines):
            if pinline in self.watermark_color_map:
                # Named pinline colors
                colors.append([self.watermark_color_map.get(pinline, self.RGB_WHITE)])
            elif len(self.identity[i]) < 3:
                # Dual color based on identity
                colors.append([
                    self.watermark_color_map.get(c, self.RGB_WHITE)
                    for c in self.identity[i]])
            colors.append([])
        return colors

    @auto_prop_cached
    def watermark_fx(self) -> list[list[LayerEffects]]:
        """A list of LayerEffects' objects for each face."""
        fx: list[list[LayerEffects]] = []
        for color in self.watermark_colors:
            if len(color) == 1:
                fx.append([{
                    'type': 'color-overlay',
                    'opacity': 100,
                    'color': color[0]
                }])
            elif len(color) == 2:
                fx.append([{
                    'type': 'gradient-overlay',
                    'rotation': 0,
                    'colors': [
                        {'color': color[0], 'location': 0, 'midpoint': 50},
                        {'color': color[1], 'location': 4096, 'midpoint': 50}
                    ]
                }])
            else:
                fx.append([])
        return fx

    def create_watermark(self) -> None:
        """Render a watermark for each side that has one."""

        # Add watermark to each side if needed
        for i, watermark in enumerate(self.layout.watermark):

            # Required values to generate a Watermark
            if not all([
                self.layout.watermark_svg[i],
                self.textbox_reference[i],
                self.watermark_colors[i],
                watermark
            ]):
                return

            # Get watermark custom settings if available
            wm_details = CON.watermarks.get(self.layout.watermark[i], {})

            # Import and frame the watermark
            wm = psd.import_svg(
                path=self.layout.watermark_svg[i],
                ref=self.textbox_reference[i],
                placement=ElementPlacement.PlaceAfter,
                docref=self.docref)
            psd.frame_layer(
                layer=wm,
                ref=self.textbox_reference[i],
                smallest=True,
                scale=wm_details.get('scale', 80))

            # Apply opacity, blending, and effects
            wm.opacity = wm_details.get('opacity', CFG.watermark_opacity)
            wm.blendMode = BlendMode.ColorBurn
            psd.apply_fx(wm, self.watermark_fx[i])

    """
    * Loading Files
    """

    def load_artwork(self) -> None:
        """Lead artwork for each face."""

        # Check for fullart test image
        if ENV.TEST_MODE and self.is_fullart:
            p = (PATH.SRC_IMG / 'test-fa').with_suffix('.png')
            self.layout.art_file = [p, p]
        elif ENV.TEST_MODE:
            self.layout.art_file = [
                self.layout.art_file,
                self.layout.art_file]

        # Manually select a second artwork if not provided
        if len(self.layout.art_file) == 1:
            self.console.update("Please select the second split art!")
            file = self.app.openDialog()
            if not file:
                self.console.update('No art selected, cancelling render.')
                self.console.cancel_thread(thr=self.event)
                return

            # Place new art in the correct order
            if normalize_str(self.layout.name[0]) == normalize_str(self.layout.file['name']):
                self.layout.art_file.append(file[0])
            else:
                self.layout.art_file.insert(0, file[0])

        # Load art for each side
        for i, ref in enumerate(self.art_reference):

            # Import the file into the art layer
            self.active_layer = self.art_layer[i]
            if self.art_action:
                psd.paste_file(
                    layer=self.art_layer[i],
                    path=self.layout.art_file[i],
                    action=self.art_action,
                    action_args=self.art_action_args,
                    docref=self.docref)
            else:
                psd.import_art(
                    layer=self.art_layer[i],
                    path=self.layout.art_file[i],
                    docref=self.docref)

            # Frame the artwork
            psd.frame_layer(self.active_layer, ref)

            # Perform content aware fill if needed
            if self.is_content_aware_enabled:

                # Perform a generative fill
                if CFG.generative_fill:
                    docref = psd.generative_fill_edges(
                        layer=self.art_layer[i],
                        feather=CFG.feathered_fill,
                        close_doc=not CFG.select_variation,
                        docref=self.docref)
                    if docref:
                        self.console.await_choice(
                            self.event, msg="Select a Generative Fill variation, then click Continue ...")
                        docref.close(SaveOptions.SaveChanges)
                    continue

                # Perform a content aware fill
                psd.content_aware_fill_edges(self.art_layer, CFG.feathered_fill)

    """
    * Frame Layer Methods
    """

    def enable_frame_layers(self) -> None:
        """Enable frame layers for each side. Add Fuse layers if required."""

        # Frame layers
        for i in range(2):
            # Copy twins and position
            self.twins_layer[i].visible = True
            twins = self.twins_layer[i].parent.duplicate(self.twins_groups[i], ElementPlacement.PlaceBefore)
            self.twins_layer[i].visible = False
            twins.visible = True
            psd.align_horizontal(twins, self.twins_reference[i])

            # Copy background and position
            background = self.background_layer[i].duplicate(
                self.background_groups[i], ElementPlacement.PlaceInside)
            background.visible = True
            psd.align_horizontal(background, self.background_reference[i])

            # Copy textbox and position
            textbox = self.textbox_layer[i].duplicate(
                self.textbox_groups[i], ElementPlacement.PlaceInside)
            textbox.visible = True
            self.active_layer = textbox
            psd.align_horizontal(textbox, self.textbox_reference[i].dims)
            if self.is_fuse:
                psd.select_bounds(self.textbox_reference[i].bounds, self.doc_selection)
                self.doc_selection.invert()
                self.doc_selection.clear()
            self.doc_selection.deselect()

            # Apply pinlines
            self.generate_layer(
                group=self.pinlines_groups[i],
                colors=self.pinlines_colors[i])

        # Fuse addone
        if self.is_fuse:
            psd.getLayer(f'{LAYERS.BORDER} Fuse').visible = True
            self.fuse_group.visible = True
            self.generate_layer(
                group=self.fuse_pinlines_group,
                colors=self.fuse_pinline_colors)
            self.generate_layer(
                group=self.fuse_textbox_group,
                colors=self.fuse_textbox_colors,
                masks=self.mask_layers)

    """
    * Text Layer Methods
    """

    def basic_text_layers(self) -> None:
        """Add basic text layers for each side."""
        for i in range(2):
            self.text.extend([
                FormattedTextField(
                    layer = self.text_layer_mana[i],
                    contents = self.layout.mana_cost[i]
                ),
                ScaledTextField(
                    layer = self.text_layer_name[i],
                    contents = self.layout.name[i],
                    reference = self.name_reference[i]
                ),
                ScaledTextField(
                    layer = self.text_layer_type[i],
                    contents = self.layout.type_line[i],
                    reference = self.type_reference[i]
                )])

    def rules_text_and_pt_layers(self) -> None:
        """Add rules and P/T text for each face."""
        for i in range(2):
            self.text.append(
                FormattedTextArea(
                    layer = self.text_layer_rules[i],
                    contents = self.layout.oracle_text[i],
                    flavor = self.layout.flavor_text[i],
                    reference = self.textbox_reference[i],
                    divider = self.divider_layer[i],
                    centered = self.is_centered[i]))

Attributes

post_text_methods

Rotate card sideways.

Functions

art_layer() -> list[ArtLayer]

Art layer for each side.

Source code in src\templates\split.py
281
282
283
284
@auto_prop_cached
def art_layer(self) -> list[ArtLayer]:
    """Art layer for each side."""
    return [psd.getLayer(LAYERS.DEFAULT, group) for group in self.card_groups]

art_reference() -> list[ArtLayer]

Art layer positioning reference for each side.

Source code in src\templates\split.py
225
226
227
228
@auto_prop_cached
def art_reference(self) -> list[ArtLayer]:
    """Art layer positioning reference for each side."""
    return [psd.getLayer(LAYERS.ART_FRAME, group) for group in self.card_groups]

background_groups() -> list[LayerSet]

Background group for each side.

Source code in src\templates\split.py
185
186
187
188
@auto_prop_cached
def background_groups(self) -> list[LayerSet]:
    """Background group for each side."""
    return [psd.getLayerSet(LAYERS.BACKGROUND, group) for group in self.card_groups]

background_layer() -> list[ArtLayer]

Background layer for each side.

Source code in src\templates\split.py
286
287
288
289
@auto_prop_cached
def background_layer(self) -> list[ArtLayer]:
    """Background layer for each side."""
    return [psd.getLayer(b, LAYERS.BACKGROUND) for b in self.background]

background_reference() -> list[ArtLayer]

Background positioning reference for each side.

Source code in src\templates\split.py
220
221
222
223
@auto_prop_cached
def background_reference(self) -> list[ArtLayer]:
    """Background positioning reference for each side."""
    return [psd.getLayer('Reference', [group, LAYERS.BACKGROUND]) for group in self.card_groups]

basic_text_layers() -> None

Add basic text layers for each side.

Source code in src\templates\split.py
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
def basic_text_layers(self) -> None:
    """Add basic text layers for each side."""
    for i in range(2):
        self.text.extend([
            FormattedTextField(
                layer = self.text_layer_mana[i],
                contents = self.layout.mana_cost[i]
            ),
            ScaledTextField(
                layer = self.text_layer_name[i],
                contents = self.layout.name[i],
                reference = self.name_reference[i]
            ),
            ScaledTextField(
                layer = self.text_layer_type[i],
                contents = self.layout.type_line[i],
                reference = self.type_reference[i]
            )])

card_groups()

Left and Right side parent groups.

Source code in src\templates\split.py
162
163
164
165
166
167
168
@auto_prop_cached
def card_groups(self):
    """Left and Right side parent groups."""
    return [
        psd.getLayerSet(LAYERS.LEFT),
        psd.getLayerSet(LAYERS.RIGHT)
    ]

color_limit() -> int

One more than the max number of colors this card can split by.

Source code in src\templates\split.py
90
91
92
93
@auto_prop_cached
def color_limit(self) -> int:
    """One more than the max number of colors this card can split by."""
    return 3

create_watermark() -> None

Render a watermark for each side that has one.

Source code in src\templates\split.py
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
def create_watermark(self) -> None:
    """Render a watermark for each side that has one."""

    # Add watermark to each side if needed
    for i, watermark in enumerate(self.layout.watermark):

        # Required values to generate a Watermark
        if not all([
            self.layout.watermark_svg[i],
            self.textbox_reference[i],
            self.watermark_colors[i],
            watermark
        ]):
            return

        # Get watermark custom settings if available
        wm_details = CON.watermarks.get(self.layout.watermark[i], {})

        # Import and frame the watermark
        wm = psd.import_svg(
            path=self.layout.watermark_svg[i],
            ref=self.textbox_reference[i],
            placement=ElementPlacement.PlaceAfter,
            docref=self.docref)
        psd.frame_layer(
            layer=wm,
            ref=self.textbox_reference[i],
            smallest=True,
            scale=wm_details.get('scale', 80))

        # Apply opacity, blending, and effects
        wm.opacity = wm_details.get('opacity', CFG.watermark_opacity)
        wm.blendMode = BlendMode.ColorBurn
        psd.apply_fx(wm, self.watermark_fx[i])

divider_layer() -> list[Optional[ArtLayer]]

Divider layer for each side. List updated if either side has flavor text.

Source code in src\templates\split.py
301
302
303
304
@auto_prop_cached
def divider_layer(self) -> list[Optional[ArtLayer]]:
    """Divider layer for each side. List updated if either side has flavor text."""
    return [None, None]

enable_frame_layers() -> None

Enable frame layers for each side. Add Fuse layers if required.

Source code in src\templates\split.py
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
def enable_frame_layers(self) -> None:
    """Enable frame layers for each side. Add Fuse layers if required."""

    # Frame layers
    for i in range(2):
        # Copy twins and position
        self.twins_layer[i].visible = True
        twins = self.twins_layer[i].parent.duplicate(self.twins_groups[i], ElementPlacement.PlaceBefore)
        self.twins_layer[i].visible = False
        twins.visible = True
        psd.align_horizontal(twins, self.twins_reference[i])

        # Copy background and position
        background = self.background_layer[i].duplicate(
            self.background_groups[i], ElementPlacement.PlaceInside)
        background.visible = True
        psd.align_horizontal(background, self.background_reference[i])

        # Copy textbox and position
        textbox = self.textbox_layer[i].duplicate(
            self.textbox_groups[i], ElementPlacement.PlaceInside)
        textbox.visible = True
        self.active_layer = textbox
        psd.align_horizontal(textbox, self.textbox_reference[i].dims)
        if self.is_fuse:
            psd.select_bounds(self.textbox_reference[i].bounds, self.doc_selection)
            self.doc_selection.invert()
            self.doc_selection.clear()
        self.doc_selection.deselect()

        # Apply pinlines
        self.generate_layer(
            group=self.pinlines_groups[i],
            colors=self.pinlines_colors[i])

    # Fuse addone
    if self.is_fuse:
        psd.getLayer(f'{LAYERS.BORDER} Fuse').visible = True
        self.fuse_group.visible = True
        self.generate_layer(
            group=self.fuse_pinlines_group,
            colors=self.fuse_pinline_colors)
        self.generate_layer(
            group=self.fuse_textbox_group,
            colors=self.fuse_textbox_colors,
            masks=self.mask_layers)

expansion_reference_right() -> None

Right side expansion symbol reference.

Source code in src\templates\split.py
263
264
265
266
@auto_prop_cached
def expansion_reference_right(self) -> None:
    """Right side expansion symbol reference."""
    return psd.getLayer(LAYERS.EXPANSION_REFERENCE, [LAYERS.RIGHT, LAYERS.TEXT_AND_ICONS])

expansion_references() -> list[ArtLayer]

Expansion reference for each side.

Source code in src\templates\split.py
258
259
260
261
@auto_prop_cached
def expansion_references(self) -> list[ArtLayer]:
    """Expansion reference for each side."""
    return [self.expansion_reference, self.expansion_reference_right]

expansion_symbols() -> list[Optional[ArtLayer]]

Expansion symbol layers for each side. Right side is generated duplicating the left side.

Source code in src\templates\split.py
268
269
270
271
272
273
274
275
@auto_prop_cached
def expansion_symbols(self) -> list[Optional[ArtLayer]]:
    """Expansion symbol layers for each side. Right side is generated duplicating the left side."""
    if self.expansion_symbol_layer:
        layer = self.expansion_symbol_layer.duplicate(self.expansion_reference_right, ElementPlacement.PlaceAfter)
        psd.align_right(layer, self.expansion_reference_right)
        return [self.expansion_symbol_layer, layer]
    return [None, None]

fuse_group() -> Optional[LayerSet]

Fuse elements parent group.

Source code in src\templates\split.py
142
143
144
145
@auto_prop_cached
def fuse_group(self) -> Optional[LayerSet]:
    """Fuse elements parent group."""
    return psd.getLayerSet('Fuse')

fuse_pinline_colors() -> Union[list[int], list[dict]]

Color definition for Fuse pinlines.

Source code in src\templates\split.py
109
110
111
112
113
@auto_prop_cached
def fuse_pinline_colors(self) -> Union[list[int], list[dict]]:
    """Color definition for Fuse pinlines."""
    return psd.get_pinline_gradient(
        self.fuse_pinlines, location_map=self.fuse_gradient_locations)

fuse_pinlines() -> str

Merged pinline colors of each side.

Source code in src\templates\split.py
 95
 96
 97
 98
 99
100
@auto_prop_cached
def fuse_pinlines(self) -> str:
    """Merged pinline colors of each side."""
    if self.pinlines[0] != self.pinlines[1]:
        return self.pinlines[0] + self.pinlines[1]
    return self.pinlines[0]

fuse_pinlines_action() -> Union[psd.create_color_layer, psd.create_gradient_layer]

Action used to render Fuse pinlines.

Source code in src\templates\split.py
115
116
117
118
119
120
@auto_prop_cached
def fuse_pinlines_action(self) -> Union[psd.create_color_layer, psd.create_gradient_layer]:
    """Action used to render Fuse pinlines."""
    return psd.create_color_layer if isinstance(
        self.fuse_pinline_colors, SolidColor
    ) else psd.create_gradient_layer

fuse_pinlines_group() -> Optional[LayerSet]

Fuse pinlines group.

Source code in src\templates\split.py
152
153
154
155
@auto_prop_cached
def fuse_pinlines_group(self) -> Optional[LayerSet]:
    """Fuse pinlines group."""
    return psd.getLayerSet(LAYERS.PINLINES, self.fuse_group)

fuse_textbox_colors() -> str

Gold if Fuse colors are more than 3, otherwise use Fuse colors.

Source code in src\templates\split.py
102
103
104
105
106
107
@auto_prop_cached
def fuse_textbox_colors(self) -> str:
    """Gold if Fuse colors are more than 3, otherwise use Fuse colors."""
    if len(self.fuse_pinlines) > 3:
        return LAYERS.GOLD
    return self.fuse_pinlines

fuse_textbox_group() -> Optional[LayerSet]

Fuse textbox group.

Source code in src\templates\split.py
147
148
149
150
@auto_prop_cached
def fuse_textbox_group(self) -> Optional[LayerSet]:
    """Fuse textbox group."""
    return psd.getLayerSet(LAYERS.TEXTBOX, self.fuse_group)

is_centered() -> list[bool]

Allow centered text for each side independently.

Source code in src\templates\split.py
70
71
72
73
74
75
76
77
78
79
@auto_prop_cached
def is_centered(self) -> list[bool]:
    """Allow centered text for each side independently."""
    return [
        bool(
            len(self.layout.flavor_text[i]) <= 1
            and len(self.layout.oracle_text[i]) <= 70
            and "\n" not in self.layout.oracle_text[i]
        ) for i in range(2)
    ]

is_fuse() -> bool

Determine if this is a 'Fuse' split card.

Source code in src\templates\split.py
81
82
83
84
@auto_prop_cached
def is_fuse(self) -> bool:
    """Determine if this is a 'Fuse' split card."""
    return bool('Fuse' in self.layout.keywords)

load_artwork() -> None

Lead artwork for each face.

Source code in src\templates\split.py
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
def load_artwork(self) -> None:
    """Lead artwork for each face."""

    # Check for fullart test image
    if ENV.TEST_MODE and self.is_fullart:
        p = (PATH.SRC_IMG / 'test-fa').with_suffix('.png')
        self.layout.art_file = [p, p]
    elif ENV.TEST_MODE:
        self.layout.art_file = [
            self.layout.art_file,
            self.layout.art_file]

    # Manually select a second artwork if not provided
    if len(self.layout.art_file) == 1:
        self.console.update("Please select the second split art!")
        file = self.app.openDialog()
        if not file:
            self.console.update('No art selected, cancelling render.')
            self.console.cancel_thread(thr=self.event)
            return

        # Place new art in the correct order
        if normalize_str(self.layout.name[0]) == normalize_str(self.layout.file['name']):
            self.layout.art_file.append(file[0])
        else:
            self.layout.art_file.insert(0, file[0])

    # Load art for each side
    for i, ref in enumerate(self.art_reference):

        # Import the file into the art layer
        self.active_layer = self.art_layer[i]
        if self.art_action:
            psd.paste_file(
                layer=self.art_layer[i],
                path=self.layout.art_file[i],
                action=self.art_action,
                action_args=self.art_action_args,
                docref=self.docref)
        else:
            psd.import_art(
                layer=self.art_layer[i],
                path=self.layout.art_file[i],
                docref=self.docref)

        # Frame the artwork
        psd.frame_layer(self.active_layer, ref)

        # Perform content aware fill if needed
        if self.is_content_aware_enabled:

            # Perform a generative fill
            if CFG.generative_fill:
                docref = psd.generative_fill_edges(
                    layer=self.art_layer[i],
                    feather=CFG.feathered_fill,
                    close_doc=not CFG.select_variation,
                    docref=self.docref)
                if docref:
                    self.console.await_choice(
                        self.event, msg="Select a Generative Fill variation, then click Continue ...")
                    docref.close(SaveOptions.SaveChanges)
                continue

            # Perform a content aware fill
            psd.content_aware_fill_edges(self.art_layer, CFG.feathered_fill)

mask_layers() -> list[ArtLayer]

Blending masks supported by this template.

Source code in src\templates\split.py
310
311
312
313
@auto_prop_cached
def mask_layers(self) -> list[ArtLayer]:
    """Blending masks supported by this template."""
    return [psd.getLayer(LAYERS.HALF, LAYERS.MASKS)]

name_reference() -> list[ArtLayer]

list[ArtLayer]: Name reference for each side.

Source code in src\templates\split.py
203
204
205
206
@auto_prop_cached
def name_reference(self) -> list[ArtLayer]:
    """list[ArtLayer]: Name reference for each side."""
    return self.text_layer_name

pinlines_action() -> list[Union[psd.create_color_layer, psd.create_gradient_layer]]

Action used to render the pinlines of each side.

Source code in src\templates\split.py
129
130
131
132
133
134
135
136
@auto_prop_cached
def pinlines_action(self) -> list[Union[psd.create_color_layer, psd.create_gradient_layer]]:
    """Action used to render the pinlines of each side."""
    return [
        psd.create_color_layer if isinstance(
            colors, SolidColor
        ) else psd.create_gradient_layer
        for colors in self.pinlines_colors]

pinlines_colors() -> list[Union[list[int], list[dict]]]

Color definitions used for pinlines of each side.

Source code in src\templates\split.py
122
123
124
125
126
127
@auto_prop_cached
def pinlines_colors(self) -> list[Union[list[int], list[dict]]]:
    """Color definitions used for pinlines of each side."""
    return [
        psd.get_pinline_gradient(p, location_map=self.pinline_gradient_locations[i])
        for i, p in enumerate(self.pinlines)]

pinlines_groups() -> list[LayerSet]

Pinlines group for each side.

Source code in src\templates\split.py
170
171
172
173
@auto_prop_cached
def pinlines_groups(self) -> list[LayerSet]:
    """Pinlines group for each side."""
    return [psd.getLayerSet(LAYERS.PINLINES, group) for group in self.card_groups]

rules_text_and_pt_layers() -> None

Add rules and P/T text for each face.

Source code in src\templates\split.py
539
540
541
542
543
544
545
546
547
548
549
def rules_text_and_pt_layers(self) -> None:
    """Add rules and P/T text for each face."""
    for i in range(2):
        self.text.append(
            FormattedTextArea(
                layer = self.text_layer_rules[i],
                contents = self.layout.oracle_text[i],
                flavor = self.layout.flavor_text[i],
                reference = self.textbox_reference[i],
                divider = self.divider_layer[i],
                centered = self.is_centered[i]))

text_group() -> Optional[LayerSet]

One text and icons group located in the 'Left' side group.

Source code in src\templates\split.py
157
158
159
160
@auto_prop_cached
def text_group(self) -> Optional[LayerSet]:
    """One text and icons group located in the 'Left' side group."""
    return psd.getLayerSet(LAYERS.TEXT_AND_ICONS, LAYERS.LEFT)

text_layer_mana() -> list[ArtLayer]

Mana cost text layer for each side.

Source code in src\templates\split.py
249
250
251
252
@auto_prop_cached
def text_layer_mana(self) -> list[ArtLayer]:
    """Mana cost text layer for each side."""
    return [psd.getLayer(LAYERS.MANA_COST, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

text_layer_name() -> list[ArtLayer]

Name text layer for each side.

Source code in src\templates\split.py
234
235
236
237
@auto_prop_cached
def text_layer_name(self) -> list[ArtLayer]:
    """Name text layer for each side."""
    return [psd.getLayer(LAYERS.NAME, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

text_layer_rules() -> list[ArtLayer]

Rules text layer for each side.

Source code in src\templates\split.py
239
240
241
242
@auto_prop_cached
def text_layer_rules(self) -> list[ArtLayer]:
    """Rules text layer for each side."""
    return [psd.getLayer(LAYERS.RULES_TEXT, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

text_layer_type() -> list[ArtLayer]

Typeline text layer for each side.

Source code in src\templates\split.py
244
245
246
247
@auto_prop_cached
def text_layer_type(self) -> list[ArtLayer]:
    """Typeline text layer for each side."""
    return [psd.getLayer(LAYERS.TYPE_LINE, [self.card_groups[i], LAYERS.TEXT_AND_ICONS]) for i in range(2)]

textbox_groups() -> list[LayerSet]

Textbox group for each side.

Source code in src\templates\split.py
180
181
182
183
@auto_prop_cached
def textbox_groups(self) -> list[LayerSet]:
    """Textbox group for each side."""
    return [psd.getLayerSet(LAYERS.TEXTBOX, group) for group in self.card_groups]

textbox_layer() -> list[ArtLayer]

Textbox layer for each side.

Source code in src\templates\split.py
296
297
298
299
@auto_prop_cached
def textbox_layer(self) -> list[ArtLayer]:
    """Textbox layer for each side."""
    return [psd.getLayer(t, LAYERS.TEXTBOX) for t in self.pinlines]

textbox_reference() -> list[ArtLayer]

Textbox positioning reference for each side.

Source code in src\templates\split.py
194
195
196
197
198
199
200
201
@auto_prop_cached
def textbox_reference(self) -> list[ArtLayer]:
    """Textbox positioning reference for each side."""
    return [
        psd.get_reference_layer(
            LAYERS.TEXTBOX_REFERENCE + ' Fuse' if self.is_fuse else LAYERS.TEXTBOX_REFERENCE,
            psd.getLayerSet(LAYERS.TEXT_AND_ICONS, group)
        ) for group in self.card_groups]

twins_groups() -> list[LayerSet]

Twins group for each side.

Source code in src\templates\split.py
175
176
177
178
@auto_prop_cached
def twins_groups(self) -> list[LayerSet]:
    """Twins group for each side."""
    return [psd.getLayerSet(LAYERS.TWINS, group) for group in self.card_groups]

twins_layer() -> list[ArtLayer]

Twins layer for each side.

Source code in src\templates\split.py
291
292
293
294
@auto_prop_cached
def twins_layer(self) -> list[ArtLayer]:
    """Twins layer for each side."""
    return [psd.getLayer(t, LAYERS.TWINS) for t in self.twins]

twins_reference() -> list[ArtLayer]

Twins positioning reference for each side.

Source code in src\templates\split.py
215
216
217
218
@auto_prop_cached
def twins_reference(self) -> list[ArtLayer]:
    """Twins positioning reference for each side."""
    return [psd.getLayer('Reference', [group, LAYERS.TWINS]) for group in self.card_groups]

type_reference() -> list[ArtLayer]

list[ArtLayer]: Typeline reference for each side.

Source code in src\templates\split.py
208
209
210
211
212
213
@auto_prop_cached
def type_reference(self) -> list[ArtLayer]:
    """list[ArtLayer]: Typeline reference for each side."""
    return [
        n or self.expansion_reference[i]
        for i, n in enumerate(self.expansion_symbols)]

watermark_colors() -> list[list[SolidColor]]

A list of 'SolidColor' objects for each face.

Source code in src\templates\split.py
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
@auto_prop_cached
def watermark_colors(self) -> list[list[SolidColor]]:
    """A list of 'SolidColor' objects for each face."""
    colors = []
    for i, pinline in enumerate(self.pinlines):
        if pinline in self.watermark_color_map:
            # Named pinline colors
            colors.append([self.watermark_color_map.get(pinline, self.RGB_WHITE)])
        elif len(self.identity[i]) < 3:
            # Dual color based on identity
            colors.append([
                self.watermark_color_map.get(c, self.RGB_WHITE)
                for c in self.identity[i]])
        colors.append([])
    return colors

watermark_fx() -> list[list[LayerEffects]]

A list of LayerEffects' objects for each face.

Source code in src\templates\split.py
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
@auto_prop_cached
def watermark_fx(self) -> list[list[LayerEffects]]:
    """A list of LayerEffects' objects for each face."""
    fx: list[list[LayerEffects]] = []
    for color in self.watermark_colors:
        if len(color) == 1:
            fx.append([{
                'type': 'color-overlay',
                'opacity': 100,
                'color': color[0]
            }])
        elif len(color) == 2:
            fx.append([{
                'type': 'gradient-overlay',
                'rotation': 0,
                'colors': [
                    {'color': color[0], 'location': 0, 'midpoint': 50},
                    {'color': color[1], 'location': 4096, 'midpoint': 50}
                ]
            }])
        else:
            fx.append([])
    return fx