-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdd_editor.py
4027 lines (3323 loc) · 171 KB
/
mkdd_editor.py
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
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
"""
A tool for Mario Kart: Double Dash!! that can edit the BOL files that contain the course data (item
boxes, checkpoints, respawn points, etc.).
"""
import contextlib
import cProfile
import enum
import pickle
import platform
import pstats
import textwrap
import traceback
import weakref
import os
from timeit import default_timer
from copy import deepcopy, copy
from io import TextIOWrapper, BytesIO, StringIO
from math import sin, cos, atan2
import json
from PIL import Image
from PySide6 import QtCore, QtGui, QtWidgets
import py_obj
from lib import bti
from widgets.data_editor import choose_data_editor
from widgets.editor_widgets import catch_exception
from widgets.tree_view import LevelDataTreeView
from widgets.tooltip_list import markdown_to_html
import widgets.tree_view as tree_view
from configuration import (
make_default_config,
open_config_directory,
read_config,
save_cfg,
)
import mkdd_widgets # as mkddwidgets
from widgets import utils
from widgets.side_widget import PikminSideWidget
from widgets.editor_widgets import open_error_dialog, open_info_dialog, catch_exception_with_dialog
from mkdd_widgets import BolMapViewer, MODE_TOPDOWN, SnappingMode
from lib.libbol import BOL, MGEntry, Route, get_full_name
import lib.libbol as libbol
from lib.rarc import Archive
from lib.BCOllider import RacetrackCollision
from lib.model_rendering import TexturedModel, CollisionModel, Minimap
from widgets.editor_widgets import ErrorAnalyzer, ErrorAnalyzerButton, show_minimap_generator
from lib.dolreader import DolFile, read_float, write_float, read_load_immediate_r0, write_load_immediate_r0, UnmappedAddress
from widgets.file_select import FileSelect
from lib.bmd_render import clear_temp_folder, load_textured_bmd
from lib.game_visualizer import Game
from lib.vectors import Vector3
__version__ = '1.4'
APP_NAME = f'MKDD Track Editor {__version__}'
class SelectionHistorySpecials(enum.IntEnum):
MINIMAP_CORNER_1 = -1001
MINIMAP_CORNER_2 = -1002
CHECKPOINT_START = -1003
CHECKPOINT_END = -1004
RECENT_FILE_LIST_LENGTH = 20
def detect_dol_region(dol):
try:
dol.seek(0x803CDD38)
except UnmappedAddress:
pass
else:
if dol.read(5) == b"title":
return "US"
try:
dol.seek(0x803D7B78)
except UnmappedAddress:
pass
else:
if dol.read(5) == b"title":
return "PAL"
try:
dol.seek(0x803E8358)
except UnmappedAddress:
pass
else:
if dol.read(5) == b"title":
return "JP"
try:
dol.seek(0x80419020)
except UnmappedAddress:
pass
else:
if dol.read(5) == b"title":
return "US_DEBUG"
raise RuntimeError("Unsupported DOL version/region")
def get_treeitem(root: QtWidgets.QTreeWidgetItem, obj):
for i in range(root.childCount()):
child = root.child(i)
if child.bound_to == obj:
return child
return None
class UndoEntry:
_cache = weakref.WeakValueDictionary()
class _UndoCacheEntry:
def __init__(self, bol_document, enemy_path_data):
self.bol_document = bol_document
self.enemy_path_data = enemy_path_data
def __init__(self, bol_document: bytes, enemy_path_data: 'tuple[tuple[bool, int]]',
minimap_data: tuple, selected_items_data: tuple):
self.bol_hash = hash((bol_document, enemy_path_data))
# To avoid keeping track of duplicates of the BOL document (likely the case when the part
# that changes in the undo entry is the selection data), a cache is used.
if self.bol_hash not in UndoEntry._cache:
self._cache_entry = UndoEntry._UndoCacheEntry(bol_document, enemy_path_data)
UndoEntry._cache[self.bol_hash] = self._cache_entry
else:
self._cache_entry = UndoEntry._cache[self.bol_hash]
self.bol_document = self._cache_entry.bol_document
self.enemy_path_data = self._cache_entry.enemy_path_data
self.minimap_data = minimap_data
self.selected_items_data = selected_items_data
self.hash = hash((self.bol_hash, self.minimap_data, self.selected_items_data))
def __eq__(self, other) -> bool:
return self.hash == other.hash
class GenEditor(QtWidgets.QMainWindow):
def __init__(self):
super().__init__()
self.level_file = BOL()
self.dolphin = Game()
self.undo_history: list[UndoEntry] = []
self.redo_history: list[UndoEntry] = []
self.undo_history_disabled_count: int = 0
try:
self.configuration = read_config()
except FileNotFoundError as e:
print("No config file found, creating default config...")
self.configuration = make_default_config()
self.pathsconfig = self.configuration["default paths"]
self.editorconfig = self.configuration["editor"]
self.current_gen_path = None
self.dolphin.show_target_enemy_path_points = self.editorconfig.get(
'show_target_enemy_path_points', 'true') == 'true'
self.dolphin.show_target_item_points = self.editorconfig.get('show_target_item_points',
'true') == 'true'
self._template_enemy_path = libbol.EnemyPointGroup.new()
self._template_enemy_path_point = libbol.EnemyPoint.new()
self._template_enemy_path_point.scale = 2000.0
self._template_checkpoint_group = libbol.CheckpointGroup.new()
self._template_checkpoint = libbol.Checkpoint.new()
self._template_route = libbol.Route.new()
self._template_route_point = libbol.RoutePoint.new()
self._template_object = libbol.MapObject.new()
self._template_kart_start_point = libbol.KartStartPoint.new()
self._template_area = libbol.Area.new()
self._template_area.scale *= 100.0
self._template_camera = libbol.Camera.new()
self._template_respawn_point = libbol.JugemPoint.new()
self._template_light_param = libbol.LightParam.new()
self._template_minigame_param = libbol.MGEntry.new()
self._insertion_mode_type_name = None
self.setup_ui()
self.level_view.level_file = self.level_file
self.level_view.set_editorconfig(self.configuration["editor"])
self.level_view.visibility_menu = self.visibility_menu
self.collision_area_dialog = None
self.snapping_height_offset = 0
self.current_coordinates = None
self._window_title = ""
self._user_made_change = False
self._justupdatingselectedobject = False
self.bco_coll = None
self.loaded_archive = None
self.loaded_archive_file = None
self.next_checkpoint_start_position = None
self._dontselectfromtree = False
self.level_view.dolphin = self.dolphin
self.restore_geometry()
self.fullscreen.setChecked(
bool(QtCore.Qt.WindowFullScreen & self.windowState()))
self.undo_history.append(self.generate_undo_entry())
self.leveldatatreeview.set_objects(self.level_file)
self.leveldatatreeview.bound_to_group(self.level_file)
self.setAcceptDrops(True)
def save_geometry(self):
if "geometry" not in self.configuration:
self.configuration["geometry"] = {}
geo_config = self.configuration["geometry"]
def to_base64(byte_array: QtCore.QByteArray) -> str:
return bytes(byte_array.toBase64()).decode(encoding='ascii')
geo_config["window_geometry"] = to_base64(self.saveGeometry())
geo_config["window_state"] = to_base64(self.saveState())
geo_config["window_splitter"] = to_base64(self.horizontalLayout.saveState())
if self.collision_area_dialog is not None:
geo_config["collision_window_geometry"] = to_base64(
self.collision_area_dialog.saveGeometry())
save_cfg(self.configuration)
def restore_geometry(self):
if "geometry" not in self.configuration:
return
geo_config = self.configuration["geometry"]
def to_byte_array(byte_array: str) -> QtCore.QByteArray:
return QtCore.QByteArray.fromBase64(byte_array.encode(encoding='ascii'))
if "window_geometry" in geo_config:
self.restoreGeometry(to_byte_array(geo_config["window_geometry"]))
if "window_state" in geo_config:
self.restoreState(to_byte_array(geo_config["window_state"]))
if "window_splitter" in geo_config:
self.horizontalLayout.restoreState(to_byte_array(geo_config["window_splitter"]))
def closeEvent(self, event: QtGui.QCloseEvent):
self.save_geometry()
if self._user_made_change:
msgbox = QtWidgets.QMessageBox(self)
size = self.fontMetrics().height() * 3
msgbox.setIconPixmap(QtGui.QIcon('resources/warning.svg').pixmap(size, size))
msgbox.setWindowTitle("Unsaved Changes")
msgbox.setText('Are you sure you want to exit the application?')
msgbox.addButton('Cancel', QtWidgets.QMessageBox.RejectRole)
exit_button = msgbox.addButton('Exit', QtWidgets.QMessageBox.DestructiveRole)
msgbox.exec()
if msgbox.clickedButton() != exit_button:
event.ignore()
return
super().closeEvent(event)
@catch_exception
def reset(self):
self.next_checkpoint_start_position = None
self.loaded_archive = None
self.loaded_archive_file = None
self.level_view.reset()
self.current_coordinates = None
self.current_gen_path = None
self.pik_control.reset_info()
self._window_title = ""
self._user_made_change = False
def set_base_window_title(self, name):
self._window_title = name
if name != "":
self.setWindowTitle(f"{APP_NAME} - {name}")
else:
self.setWindowTitle(f"{APP_NAME}")
def set_has_unsaved_changes(self, hasunsavedchanges):
if hasunsavedchanges and not self._user_made_change:
self._user_made_change = True
if self._window_title != "":
self.setWindowTitle(f"{APP_NAME} [Unsaved Changes] - {self._window_title}")
else:
self.setWindowTitle(f"{APP_NAME} [Unsaved Changes]")
elif not hasunsavedchanges and self._user_made_change:
self._user_made_change = False
if self._window_title != "":
self.setWindowTitle(f"{APP_NAME} - {self._window_title}")
else:
self.setWindowTitle(f"{APP_NAME}")
def generate_undo_entry(self) -> UndoEntry:
bol_document = self.level_file.to_bytes(extended_format=True)
# List containing a tuple with the emptiness and ID of each of the enemy paths.
enemy_paths = self.level_file.enemypointgroups.groups
enemy_path_data = tuple((not path.points, path.id) for path in enemy_paths)
minimap = self.level_view.minimap
minimap_data = (
minimap.corner1.x, minimap.corner1.y, minimap.corner1.z,
minimap.corner2.x, minimap.corner2.y, minimap.corner2.z,
minimap.orientation
)
# Model indexes would be quickly invalidated, so they are not used. Instead, row indexes
# (of the item, and all its ancestors) are tracked.
selected_items_data = []
for model_index in self.leveldatatreeview.selectionModel().selectedIndexes():
selected_item_data = [model_index.row()]
model_index_parent = model_index.parent()
while model_index_parent.isValid():
selected_item_data.append(model_index_parent.row())
model_index_parent = model_index_parent.parent()
selected_items_data.append(tuple(selected_item_data))
if minimap.corner1 in self.level_view.selected_positions:
selected_items_data.append((SelectionHistorySpecials.MINIMAP_CORNER_1, ))
if minimap.corner2 in self.level_view.selected_positions:
selected_items_data.append((SelectionHistorySpecials.MINIMAP_CORNER_2, ))
for i, checkpoint_groups in enumerate(self.level_file.checkpoints.groups):
for j, checkpoint in enumerate(checkpoint_groups.points):
if checkpoint.start in self.level_view.selected_positions:
selected_items_data.append((SelectionHistorySpecials.CHECKPOINT_START, i, j))
if checkpoint.end in self.level_view.selected_positions:
selected_items_data.append((SelectionHistorySpecials.CHECKPOINT_END, i, j))
selected_items_data = tuple(selected_items_data)
return UndoEntry(bol_document, enemy_path_data, minimap_data, selected_items_data)
def load_top_undo_entry(self):
if not self.undo_history:
return
current_undo_entry = self.generate_undo_entry()
undo_entry = self.undo_history[-1]
bol_changed = current_undo_entry.bol_hash != undo_entry.bol_hash
self.level_file = BOL.from_bytes(undo_entry.bol_document, extended_format=True)
# The BOL document cannot store information on empty enemy paths; this information is
# sourced from a separate list.
bol_enemy_paths = list(self.level_file.enemypointgroups.groups)
self.level_file.enemypointgroups.groups.clear()
enemy_path_data = undo_entry.enemy_path_data
for empty, enemy_path_id in enemy_path_data:
if empty:
empty_enemy_path = libbol.EnemyPointGroup()
empty_enemy_path.id = enemy_path_id
self.level_file.enemypointgroups.groups.append(empty_enemy_path)
else:
enemy_path = bol_enemy_paths.pop(0)
assert enemy_path.id == enemy_path_id
self.level_file.enemypointgroups.groups.append(enemy_path)
# Clear existing selection.
with QtCore.QSignalBlocker(self.leveldatatreeview):
for item in self.leveldatatreeview.selectedItems():
item.setSelected(False)
self.level_view.level_file = self.level_file
self.leveldatatreeview.set_objects(self.level_file)
minimap = self.level_view.minimap
minimap.corner1.x = undo_entry.minimap_data[0]
minimap.corner1.y = undo_entry.minimap_data[1]
minimap.corner1.z = undo_entry.minimap_data[2]
minimap.corner2.x = undo_entry.minimap_data[3]
minimap.corner2.y = undo_entry.minimap_data[4]
minimap.corner2.z = undo_entry.minimap_data[5]
minimap.orientation = undo_entry.minimap_data[6]
self.level_view.selected = []
self.level_view.selected_positions = []
self.level_view.selected_rotations = []
# Restore the selection that was current when the undo entry was produced.
items_to_select = []
with QtCore.QSignalBlocker(self.leveldatatreeview):
for selected_item_data in undo_entry.selected_items_data:
# Deal with special cases that are not linked to the tree view first.
if selected_item_data[0] in (SelectionHistorySpecials.MINIMAP_CORNER_1,
SelectionHistorySpecials.MINIMAP_CORNER_2):
if minimap not in self.level_view.selected:
self.level_view.selected.append(minimap)
if selected_item_data[0] == SelectionHistorySpecials.MINIMAP_CORNER_1:
self.level_view.selected_positions.append(minimap.corner1)
else:
self.level_view.selected_positions.append(minimap.corner2)
continue
if selected_item_data[0] in (SelectionHistorySpecials.CHECKPOINT_START,
SelectionHistorySpecials.CHECKPOINT_END):
i, j = selected_item_data[1:]
checkpoint_group = self.level_file.checkpoints.groups[i]
checkpoint = checkpoint_group.points[j]
if checkpoint not in self.level_view.selected:
self.level_view.selected.append(checkpoint)
if selected_item_data[0] == SelectionHistorySpecials.CHECKPOINT_START:
self.level_view.selected_positions.append(checkpoint.start)
else:
self.level_view.selected_positions.append(checkpoint.end)
continue
item = self.leveldatatreeview.invisibleRootItem()
for row in reversed(selected_item_data):
item = item.child(row)
item.setSelected(True)
if hasattr(item, 'bound_to') and isinstance(item.bound_to, libbol.Checkpoint):
# Handled as a special case.
continue
items_to_select.append(item)
self.tree_select_object(items_to_select, clear_existing_selection=False)
self.update_3d()
self.pik_control.update_info()
if bol_changed:
self.set_has_unsaved_changes(True)
self.error_analyzer_button.analyze_bol(self.level_file)
def on_undo_action_triggered(self):
if len(self.undo_history) > 1:
self.redo_history.insert(0, self.undo_history.pop())
self.update_undo_redo_actions()
self.load_top_undo_entry()
def on_redo_action_triggered(self):
if self.redo_history:
self.undo_history.append(self.redo_history.pop(0))
self.update_undo_redo_actions()
self.load_top_undo_entry()
def on_document_potentially_changed(self, update_unsaved_changes=True):
# Early out if undo history is temporarily disabled.
if self.undo_history_disabled_count:
return
undo_entry = self.generate_undo_entry()
if self.undo_history[-1] != undo_entry:
bol_changed = self.undo_history[-1].bol_hash != undo_entry.bol_hash
self.undo_history.append(undo_entry)
self.redo_history.clear()
self.update_undo_redo_actions()
if bol_changed:
if update_unsaved_changes:
self.set_has_unsaved_changes(True)
self.error_analyzer_button.analyze_bol(self.level_file)
self.action_update_data_editor_label()
def update_undo_redo_actions(self):
self.undo_action.setEnabled(len(self.undo_history) > 1)
self.redo_action.setEnabled(bool(self.redo_history))
@contextlib.contextmanager
def undo_history_disabled(self):
self.undo_history_disabled_count += 1
try:
yield
finally:
self.undo_history_disabled_count -= 1
self.on_document_potentially_changed()
@catch_exception_with_dialog
def do_goto_action(self, item, index):
_ = index
self.tree_select_object([item])
self.frame_selection(adjust_zoom=False)
def frame_selection(self, adjust_zoom=True, selected_only=True):
selected_only = selected_only and bool(self.level_view.selected_positions)
minx, miny, minz, maxx, maxy, maxz = self.compute_objects_extent(selected_only)
# Center of the extent.
x = (maxx + minx) / 2
y = (maxy + miny) / 2
z = (maxz + minz) / 2
if self.level_view.mode == MODE_TOPDOWN:
self.level_view.offset_z = -z
self.level_view.offset_x = -x
if adjust_zoom:
if self.level_view.canvas_width > 0 and self.level_view.canvas_height > 0:
MARGIN = 2000
deltax = maxx - minx + MARGIN
deltay = maxz - minz + MARGIN
hzoom = deltax / self.level_view.canvas_width * 10
vzoom = deltay / self.level_view.canvas_height * 10
DEFAULT_ZOOM = 80
self.level_view._zoom_factor = max(hzoom, vzoom, DEFAULT_ZOOM)
else:
look = self.level_view.camera_direction
if adjust_zoom:
MARGIN = 3000
deltax = maxx - minx + MARGIN
fac = deltax
else:
fac = 5000
self.level_view.camera_z = -(z + look.y * fac)
self.level_view.camera_x = x - look.x * fac
self.level_view.camera_height = y - look.z * fac
self.level_view.do_redraw()
def compute_objects_extent(self, selected_only):
extent = []
def extend(position):
if not extent:
extent.extend([position.x, position.y, position.z,
position.x, position.y, position.z])
return
extent[0] = min(extent[0], position.x)
extent[1] = min(extent[1], position.y)
extent[2] = min(extent[2], position.z)
extent[3] = max(extent[3], position.x)
extent[4] = max(extent[4], position.y)
extent[5] = max(extent[5], position.z)
if selected_only:
for selected_position in self.level_view.selected_positions:
extend(selected_position)
return tuple(extent) or (0, 0, 0, 0, 0, 0)
if self.visibility_menu.enemyroute.is_visible():
for enemy_path in self.level_file.enemypointgroups.groups:
for enemy_path_point in enemy_path.points:
if enemy_path_point.hidden:
continue
extend(enemy_path_point.position)
visible_objectroutes = self.visibility_menu.objectroutes.is_visible()
visible_cameraroutes = self.visibility_menu.cameraroutes.is_visible()
visible_unassignedroutes = self.visibility_menu.unassignedroutes.is_visible()
if visible_objectroutes or visible_cameraroutes or visible_unassignedroutes:
camera_routes = set(camera.route for camera in self.level_file.cameras)
object_routes = set(obj.route for obj in self.level_file.objects.objects)
assigned_routes = camera_routes.union(object_routes)
for object_route in self.level_file.routes:
if (not ((object_route in object_routes and visible_objectroutes) or
(object_route in camera_routes and visible_cameraroutes) or
(object_route not in assigned_routes and visible_unassignedroutes))):
continue
for object_route_point in object_route.points:
if object_route_point.hidden:
continue
extend(object_route_point.position)
if self.visibility_menu.checkpoints.is_visible():
for checkpoint_group in self.level_file.checkpoints.groups:
for checkpoint in checkpoint_group.points:
if checkpoint.hidden:
continue
extend(checkpoint.start)
extend(checkpoint.end)
if self.visibility_menu.objects.is_visible():
for object_ in self.level_file.objects.objects:
if object_.hidden:
continue
extend(object_.position)
if self.visibility_menu.areas.is_visible():
for area in self.level_file.areas.areas:
if area.hidden:
continue
extend(area.position)
if self.visibility_menu.cameras.is_visible():
for camera in self.level_file.cameras:
if camera.hidden:
continue
extend(camera.position)
if self.visibility_menu.respawnpoints.is_visible():
for respawn_point in self.level_file.respawnpoints:
if respawn_point.hidden:
continue
extend(respawn_point.position)
if self.visibility_menu.kartstartpoints.is_visible():
for karts_point in self.level_file.kartpoints.positions:
if karts_point.hidden:
continue
extend(karts_point.position)
if (self.level_view.minimap is not None and self.level_view.minimap.is_available()
and self.visibility_menu.minimap.is_visible()):
extend(self.level_view.minimap.corner1)
extend(self.level_view.minimap.corner2)
if self.level_view.collision is not None and self.level_view.collision.extent is not None:
min_x, min_y, min_z, max_x, max_y, max_z = self.level_view.collision.extent
min_y, min_z, max_y, max_z = min_z, -max_y, max_z, -min_y
if extent:
extent[0] = min(extent[0], min_x)
extent[1] = min(extent[1], min_y)
extent[2] = min(extent[2], min_z)
extent[3] = max(extent[3], max_x)
extent[4] = max(extent[4], max_y)
extent[5] = max(extent[5], max_z)
else:
extent.extend([min_x, min_y, min_z, max_x, max_y, max_z])
return tuple(extent) or (0, 0, 0, 0, 0, 0)
def tree_select_arrowkey(self):
self.tree_select_object(self.leveldatatreeview.selectedItems())
def tree_select_object(self, items, clear_existing_selection=True):
if clear_existing_selection:
self.level_view.selected = []
self.level_view.selected_positions = []
self.level_view.selected_rotations = []
for item in items:
if isinstance(item, (tree_view.CameraEntry, tree_view.RespawnEntry, tree_view.AreaEntry,
tree_view.ObjectEntry, tree_view.KartpointEntry,
tree_view.EnemyRoutePoint, tree_view.ObjectRoutePoint)):
bound_to = item.bound_to
self.level_view.selected.append(bound_to)
self.level_view.selected_positions.append(bound_to.position)
if hasattr(bound_to, "rotation"):
self.level_view.selected_rotations.append(bound_to.rotation)
elif isinstance(item, tree_view.Checkpoint):
bound_to = item.bound_to
self.level_view.selected.append(bound_to)
self.level_view.selected_positions.extend((bound_to.start, bound_to.end))
elif isinstance(item, (
tree_view.EnemyPointGroup,
tree_view.CheckpointGroup,
tree_view.ObjectPointGroup,
)):
self.level_view.selected.append(item.bound_to)
elif isinstance(item, tree_view.BolHeader) and self.level_file is not None:
self.level_view.selected.append(self.level_file)
elif isinstance(item, (tree_view.LightParamEntry, tree_view.MGEntry)):
self.level_view.selected.append(item.bound_to)
self.level_view.gizmo.move_to_average(self.level_view.selected_positions,
self.level_view.selected_rotations)
self.level_view.do_redraw()
self.action_update_info()
def setup_ui(self):
self.resize(1000, 800)
self.set_base_window_title("")
self.setup_ui_menubar()
self.setup_ui_toolbar()
#self.centralwidget = QWidget(self)
#self.centralwidget.setObjectName("centralwidget")
self.horizontalLayout = QtWidgets.QSplitter()
self.centralwidget = self.horizontalLayout
self.setCentralWidget(self.horizontalLayout)
self.leveldatatreeview = LevelDataTreeView(self, self.centralwidget)
#self.leveldatatreeview.itemClicked.connect(self.tree_select_object)
self.leveldatatreeview.itemDoubleClicked.connect(self.do_goto_action)
self.leveldatatreeview.itemSelectionChanged.connect(self.tree_select_arrowkey)
self.level_view = BolMapViewer(int(self.editorconfig.get("multisampling", 8)),
self.centralwidget)
self.level_view.editor = self
self.horizontalLayout.setObjectName("horizontalLayout")
self.horizontalLayout.addWidget(self.leveldatatreeview)
self.horizontalLayout.addWidget(self.level_view)
self.leveldatatreeview.resize(200, self.leveldatatreeview.height())
self.pik_control = PikminSideWidget(self)
self.horizontalLayout.addWidget(self.pik_control)
self.snapping_toggle_shortcut = QtGui.QShortcut(QtGui.QKeySequence(QtCore.Qt.Key_V), self)
self.snapping_toggle_shortcut.activated.connect(self.level_view.toggle_snapping)
self.snapping_cycle_shortcut = QtGui.QShortcut(
QtGui.QKeySequence(QtCore.QKeyCombination(QtCore.Qt.ShiftModifier, QtCore.Qt.Key_V)),
self)
self.snapping_cycle_shortcut.activated.connect(self.level_view.cycle_snapping_mode)
QtGui.QShortcut(QtGui.QKeySequence(QtCore.Qt.Key_G), self).activated.connect(self.action_ground_objects)
self.statusbar = QtWidgets.QStatusBar(self)
self.statusbar.setObjectName("statusbar")
self.setStatusBar(self.statusbar)
self.error_analyzer_button = ErrorAnalyzerButton()
self.error_analyzer_button.clicked.connect(lambda _checked: self.analyze_for_mistakes())
self.statusbar.addPermanentWidget(self.error_analyzer_button)
self.connect_actions()
@catch_exception_with_dialog
def setup_ui_menubar(self):
self.menubar = QtWidgets.QMenuBar(self)
self.file_menu = QtWidgets.QMenu(self)
self.file_menu.setTitle("File")
save_file_shortcut = QtGui.QShortcut(
QtGui.QKeySequence(QtCore.QKeyCombination(QtCore.Qt.ControlModifier, QtCore.Qt.Key_V)),
self.file_menu)
save_file_shortcut.activated.connect(self.button_save_level)
self.file_load_action = QtGui.QAction("Load", self)
self.file_load_recent_menu = QtWidgets.QMenu("Load Recent", self)
self.save_file_action = QtGui.QAction("Save", self)
self.save_file_as_action = QtGui.QAction("Save As", self)
self.save_file_action.setShortcut("Ctrl+S")
self.file_load_action.setShortcut("Ctrl+O")
self.save_file_as_action.setShortcut("Ctrl+Alt+S")
self.save_file_copy_as_action = QtGui.QAction("Save Copy As", self)
open_config_dir_action = QtGui.QAction('Open Configuration Directory...', self)
quit_action = QtGui.QAction('Quit', self)
self.file_load_action.triggered.connect(self.button_load_level)
self.save_file_action.triggered.connect(self.button_save_level)
self.save_file_as_action.triggered.connect(self.button_save_level_as)
self.save_file_copy_as_action.triggered.connect(self.button_save_level_copy_as)
open_config_dir_action.triggered.connect(open_config_directory)
quit_action.triggered.connect(self.close)
self.file_menu.addAction(self.file_load_action)
self.file_menu.addMenu(self.file_load_recent_menu)
self.file_menu.addSeparator()
self.file_menu.addAction(self.save_file_action)
self.file_menu.addAction(self.save_file_as_action)
self.file_menu.addAction(self.save_file_copy_as_action)
self.file_menu.addSeparator()
self.file_menu.addAction(open_config_dir_action)
self.file_menu.addSeparator()
self.file_menu.addAction(quit_action)
self.file_menu.aboutToShow.connect(self.on_file_menu_aboutToShow)
self.edit_menu = QtWidgets.QMenu(self)
self.edit_menu.setTitle("Edit")
self.undo_action = self.edit_menu.addAction('Undo')
self.undo_action.setShortcut(QtGui.QKeySequence('Ctrl+Z'))
self.undo_action.triggered.connect(self.on_undo_action_triggered)
self.redo_action = self.edit_menu.addAction('Redo')
self.redo_action.setShortcuts([
QtGui.QKeySequence('Ctrl+Shift+Z'),
QtGui.QKeySequence('Ctrl+Y'),
])
self.redo_action.triggered.connect(self.on_redo_action_triggered)
self.update_undo_redo_actions()
self.edit_menu.addSeparator()
self.cut_action = self.edit_menu.addAction("Cut")
self.cut_action.setShortcut(QtGui.QKeySequence('Ctrl+X'))
self.cut_action.triggered.connect(self.on_cut_action_triggered)
self.copy_action = self.edit_menu.addAction("Copy")
self.copy_action.setShortcut(QtGui.QKeySequence('Ctrl+C'))
self.copy_action.triggered.connect(self.on_copy_action_triggered)
self.paste_action = self.edit_menu.addAction("Paste")
self.paste_action.setShortcut(QtGui.QKeySequence('Ctrl+V'))
self.paste_action.triggered.connect(self.on_paste_action_triggered)
# ---- Visibility
self.visibility_menu = mkdd_widgets.FilterViewMenu(self)
self.visibility_menu.filter_update.connect(self.on_filter_update)
filters = self.editorconfig["filter_view"].split(",")
for object_toggle in self.visibility_menu.get_entries():
if object_toggle.action_view_toggle.text() in filters:
object_toggle.action_view_toggle.blockSignals(True)
object_toggle.action_view_toggle.setChecked(False)
object_toggle.action_view_toggle.blockSignals(False)
if object_toggle.action_select_toggle.text() in filters:
object_toggle.action_select_toggle.blockSignals(True)
object_toggle.action_select_toggle.setChecked(False)
object_toggle.action_select_toggle.blockSignals(False)
# ------ Collision Menu
self.collision_menu = QtWidgets.QMenu(self.menubar)
self.collision_menu.setTitle("Geometry")
self.choose_default_collision = QtWidgets.QMenu("Choose Autoloaded Geometry", self)
self.collision_menu.addMenu(self.choose_default_collision)
self.auto_load_choose = self.choose_default_collision.addAction("Always Ask")
self.auto_load_choose.setCheckable(True)
self.auto_load_choose.setChecked(self.editorconfig.get("addi_file_on_load") == "Choose")
self.auto_load_choose.triggered.connect(lambda: self.on_default_geometry_changed("Choose"))
self.auto_load_bco = self.choose_default_collision.addAction("BCO")
self.auto_load_bco.setCheckable(True)
self.auto_load_bco.setChecked(self.editorconfig.get("addi_file_on_load") == "BCO")
self.auto_load_bco.triggered.connect(lambda: self.on_default_geometry_changed("BCO"))
self.auto_load_bmd = self.choose_default_collision.addAction("BMD")
self.auto_load_bmd.setCheckable(True)
self.auto_load_bmd.setChecked(self.editorconfig.get("addi_file_on_load") == "BMD")
self.auto_load_bmd.triggered.connect(lambda: self.on_default_geometry_changed("BMD"))
self.auto_load_none = self.choose_default_collision.addAction("Nothing")
self.auto_load_none.setCheckable(True)
self.auto_load_none.setChecked(self.editorconfig.get("addi_file_on_load") == "None")
self.auto_load_none.triggered.connect(lambda: self.on_default_geometry_changed("None"))
if self.editorconfig.get("addi_file_on_load") not in ("BCO", "BMD", "None", "Choose"):
self.on_default_geometry_changed("Choose")
self.collision_menu.addSeparator()
self.collision_load_bco_action = QtGui.QAction("Load BCO", self)
self.collision_load_bco_action.triggered.connect(self.button_load_collision_bco)
self.collision_menu.addAction(self.collision_load_bco_action)
self.collision_load_bmd_action = QtGui.QAction("Load BMD", self)
self.collision_load_bmd_action.triggered.connect(self.button_load_collision_bmd)
self.collision_menu.addAction(self.collision_load_bmd_action)
self.collision_load_obj_action = QtGui.QAction("Load OBJ", self)
self.collision_load_obj_action.triggered.connect(self.button_load_collision_obj)
self.collision_menu.addAction(self.collision_load_obj_action)
self.clear_current_collision = QtGui.QAction("Clear Current Model", self)
self.clear_current_collision.triggered.connect(self.clear_collision)
self.collision_menu.addAction(self.clear_current_collision)
self.collision_menu.addSeparator()
cull_faces_action = self.collision_menu.addAction("Cull Faces")
cull_faces_action.setCheckable(True)
cull_faces_action.setChecked(self.editorconfig.get("cull_faces") == "True")
cull_faces_action.triggered.connect(self.on_cull_faces_triggered)
self.choose_bco_area = QtGui.QAction("Collision Areas (BCO)")
self.choose_bco_area.triggered.connect(self.action_choose_bco_area)
self.collision_menu.addAction(self.choose_bco_area)
self.choose_bco_area.setShortcut("Ctrl+K")
# ------- Tools Menu
self.tools_menu = QtWidgets.QMenu(self.menubar)
self.tools_menu.setTitle("Tools")
snapping_menu_tool_tip = markdown_to_html(
'Snapping',
'Press **V** to toggle snapping on and off. '
'Press **Shift+V** to cycle through snapping modes.',
)
self.snapping_menu = self.tools_menu.addMenu('Snapping\tV')
self.snapping_menu.setToolTipsVisible(True)
self.snapping_menu.aboutToShow.connect(self.on_snapping_menu_aboutToShow)
self.snapping_menu.addAction('Disabled')
for snapping_mode in SnappingMode:
self.snapping_menu.addAction(f'Snap to {snapping_mode.value}').setObjectName(
snapping_mode.name)
self.snapping_menu_action_group = QtGui.QActionGroup(self)
for action in self.snapping_menu.actions():
action.triggered.connect(self.on_snapping_menu_action_triggered)
action.setCheckable(True)
action.setToolTip(snapping_menu_tool_tip)
self.snapping_menu_action_group.addAction(action)
self.snapping_menu.addSeparator()
self.snapping_height_offset_action = self.snapping_menu.addAction(
'Set Height Offset (0 units)')
self.snapping_height_offset_action.triggered.connect(
self.on_snapping_height_offset_action_triggered)
self.analyze_action = QtGui.QAction("Analyze for common mistakes", self)
self.analyze_action.triggered.connect(self.analyze_for_mistakes)
self.tools_menu.addAction(self.analyze_action)
self.show_code_patch_fields_action = QtGui.QAction("Show Code Patch-Dependent Fields (🧩)")
self.show_code_patch_fields_action.setCheckable(True)
self.show_code_patch_fields_action.setChecked(
bool(self.editorconfig.get('show_code_patch_fields') == 'true'))
def on_show_code_patch_fields_triggered(checked):
self.editorconfig['show_code_patch_fields'] = 'true' if checked else 'false'
self.action_update_info()
self.show_code_patch_fields_action.triggered[bool].connect(
on_show_code_patch_fields_triggered)
self.tools_menu.addAction(self.show_code_patch_fields_action)
self.tools_menu.addSeparator()
self.rotation_mode = QtGui.QAction("Rotate Around Median Point", self)
self.rotation_mode.setCheckable(True)
self.rotation_mode.setChecked(True)
self.tools_menu.addAction(self.rotation_mode)
# -------- Minimap Menu
self.minimap_menu = QtWidgets.QMenu(self.menubar)
self.minimap_menu.setTitle("Minimap")
load_minimap = QtGui.QAction("Load Minimap Image", self)
save_minimap_png = QtGui.QAction("Save Minimap Image as PNG", self)
save_minimap_bti = QtGui.QAction("Save Minimap Image as BTI", self)
load_coordinates_dol = QtGui.QAction("Load Data from DOL", self)
save_coordinates_dol = QtGui.QAction("Save Data to DOL", self)
load_coordinates_json = QtGui.QAction("Load Data from JSON", self)
save_coordinates_json = QtGui.QAction("Save Data to JSON", self)
minimap_generator_action = QtGui.QAction("Minimap Generator", self)
minimap_generator_action.setShortcut("Ctrl+M")
load_minimap.triggered.connect(self.action_load_minimap_image)
save_minimap_png.triggered.connect(
lambda checked: self.action_save_minimap_image(checked, 'png'))
save_minimap_bti.triggered.connect(
lambda checked: self.action_save_minimap_image(checked, 'bti'))
load_coordinates_dol.triggered.connect(self.action_load_dol)
save_coordinates_dol.triggered.connect(self.action_save_to_dol)
load_coordinates_json.triggered.connect(self.action_load_coordinates_json)
save_coordinates_json.triggered.connect(self.action_save_coordinates_json)
minimap_generator_action.triggered.connect(self.minimap_generator_action)
self.minimap_menu.addAction(load_minimap)
self.minimap_menu.addAction(save_minimap_png)
self.minimap_menu.addAction(save_minimap_bti)
self.minimap_menu.addSeparator()
self.minimap_menu.addAction(load_coordinates_dol)
self.minimap_menu.addAction(save_coordinates_dol)
self.minimap_menu.addAction(load_coordinates_json)
self.minimap_menu.addAction(save_coordinates_json)
self.minimap_menu.addSeparator()
self.minimap_menu.addAction(minimap_generator_action)
#View
self.view_menu = QtWidgets.QMenu(self.menubar)
self.view_menu.setTitle("View")
frame_selected_action = QtGui.QAction("Frame Selected\tNumpad . or F", self)
frame_selected_action.triggered.connect(lambda _checked: self.frame_selection())
frame_selected_shortcut = QtGui.QShortcut(QtGui.QKeySequence(QtCore.Qt.Key_F), self)
frame_selected_shortcut.activated.connect(self.frame_selection)
self.view_menu.addAction(frame_selected_action)
frame_all_action = QtGui.QAction("Frame All", self)
frame_all_action.triggered.connect(
lambda _checked: self.frame_selection(selected_only=False))
frame_all_action.setShortcut(QtGui.QKeySequence(QtCore.Qt.Key_Home))
self.view_menu.addAction(frame_all_action)
self.view_menu.addSeparator()
self.view_action_group = QtGui.QActionGroup(self)
self.change_to_topdownview_action = QtGui.QAction("Topdown View", self)
self.view_action_group.addAction(self.change_to_topdownview_action)
self.change_to_topdownview_action.triggered.connect(self.change_to_topdownview)
self.view_menu.addAction(self.change_to_topdownview_action)
self.change_to_topdownview_action.setCheckable(True)
self.change_to_topdownview_action.setChecked(True)
self.change_to_topdownview_action.setShortcut("Ctrl+1")
self.change_to_3dview_action = QtGui.QAction("3D View", self)
self.view_action_group.addAction(self.change_to_3dview_action)
self.change_to_3dview_action.triggered.connect(self.change_to_3dview)
self.view_menu.addAction(self.change_to_3dview_action)
self.change_to_3dview_action.setCheckable(True)
self.change_to_3dview_action.setShortcut("Ctrl+2")
self.view_menu.addSeparator()
show_hide_objects_menu = QtWidgets.QMenu('Show/Hide Objects', self)
self.view_menu.addMenu(show_hide_objects_menu)
show_hidden_objects_action = show_hide_objects_menu.addAction('Show Hidden Objects')
show_hidden_objects_action.setShortcut('Alt+H')
show_hidden_objects_action.triggered.connect(self.on_show_hidden_objects_action_triggered)
show_hide_objects_menu.addSeparator()
hide_selected_action = show_hide_objects_menu.addAction('Hide Selected')
hide_selected_action.setShortcut('H')
hide_selected_action.triggered.connect(self.on_hide_selected_action_triggered)
hide_unselected_action = show_hide_objects_menu.addAction('Hide Unselected')
hide_unselected_action.setShortcut('Shift+H')
hide_unselected_action.triggered.connect(self.on_hide_unselected_action_triggered)
self.view_menu.addSeparator()
self.viewer_toolbar_action = self.view_menu.addAction('Viewer Toolbar')
self.viewer_toolbar_action.setShortcut('Ctrl+T')
self.viewer_toolbar_action.setCheckable(True)
self.viewer_toolbar_action.setChecked(True)
self.transform_gizmo = self.view_menu.addAction('&Transform Gizmo')