Skip to content

Commit

Permalink
Fix obj file header parsing from being cleared and some pep8 cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheDuckCow
TheDuckCow committed Jun 25, 2024
1 parent 0afc1c9 commit 23d4fa4
Show file tree
Hide file tree
Showing 2 changed files with 166 additions and 73 deletions.
151 changes: 82 additions & 69 deletions MCprep_addon/world_tools.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ class ObjHeaderOptions:

def __init__(self):
# This assumes all OBJs that aren't from Mineways
# and don't have a CommonMCOBJ header are from
# and don't have a CommonMCOBJ header are from
# jmc2obj, and use individual tiles for textures
self._exporter: Optional[str] = "jmc2obj"
self._file_type: Optional[str] = "INDIVIDUAL_TILES"

"""
Wrapper functions to avoid typos causing issues
"""
Expand Down Expand Up @@ -124,30 +124,31 @@ class WorldExporter(Enum):
"""

# Mineways with CommonMCOBJ
Mineways = auto()
Mineways = auto()

# Jmc2OBJ with CommonMCOBJ
Jmc2OBJ = auto()
Jmc2OBJ = auto()

# Cmc2OBJ, the reference
# Cmc2OBJ, the reference
# implementation of CommonMCOBJ
#
# For the most part, this
# will be treated as
# For the most part, this
# will be treated as
# Unknown as it's not meant
# for regular use. The distinct
# option exists for testing purposes
Cmc2OBJ = auto()
Cmc2OBJ = auto()

# Any untested exporter
Unknown = auto()
Unknown = auto()

# Mineways before the CommonMCOBJ standard
ClassicMW = auto()
ClassicMW = auto()

# jmc2OBJ before the CommonMCOBJ standard
ClassicJmc = auto()


EXPORTER_MAPPING = {
"mineways" : WorldExporter.Mineways,
"jmc2obj" : WorldExporter.Jmc2OBJ,
Expand All @@ -156,15 +157,16 @@ class WorldExporter(Enum):
"jmc2obj-c" : WorldExporter.ClassicJmc
}


def get_exporter(context: Context) -> Optional[WorldExporter]:
"""
Return the exporter on the active object if it has
Return the exporter on the active object if it has
an exporter attribute.
For maximum backwards compatibility, it'll convert the
explicit options we have in MCprep for world exporters to
For maximum backwards compatibility, it'll convert the
explicit options we have in MCprep for world exporters to
WorldExporter enum objects, if the object does not have either
the CommonMCOBJ exporter attribute, or if it does not have the
the CommonMCOBJ exporter attribute, or if it does not have the
MCPREP_OBJ_EXPORTER attribute added in MCprep 3.6. This backwards
compatibility will be removed by default in MCprep 4.0
Expand All @@ -184,8 +186,8 @@ def get_exporter(context: Context) -> Optional[WorldExporter]:
elif "MCPREP_OBJ_HEADER" in obj:
if "MCPREP_OBJ_EXPORTER" in obj:
return EXPORTER_MAPPING[obj["MCPREP_OBJ_EXPORTER"]]
# This section will be placed behind a legacy

# This section will be placed behind a legacy
# option in MCprep 4.0, once CommonMCOBJ becomes
# more adopted in exporters
prefs = util.get_user_preferences(context)
Expand All @@ -195,6 +197,7 @@ def get_exporter(context: Context) -> Optional[WorldExporter]:
return WorldExporter.ClassicJmc
return None


def detect_world_exporter(filepath: Path) -> Union[CommonMCOBJ, ObjHeaderOptions]:
"""Detect whether Mineways or jmc2obj was used, based on prefix info.
Expand All @@ -203,38 +206,41 @@ def detect_world_exporter(filepath: Path) -> Union[CommonMCOBJ, ObjHeaderOptions
set in the obj file as comments.
"""
obj_header = ObjHeaderOptions()

# First parse header for commonmcobj
with open(filepath, 'r') as obj_fd:
cmc_header = parse_header(obj_fd)
if cmc_header is not None:
return cmc_header

# If not found, fall back to recognizing the mineway legacy convention
with open(filepath, 'r') as obj_fd:
try:
cmc_header = parse_header(obj_fd)
if cmc_header is not None:
return cmc_header
else:
header = obj_fd.readline()
if 'mineways' in header.lower():
obj_header.set_mineways()
# form of: # Wavefront OBJ file made by Mineways version 5.10...
for line in obj_fd:
if line.startswith("# File type:"):
header = line.rstrip() # Remove trailing newline

# The issue here is that Mineways has changed how the header is generated.
# As such, we're limited with only a couple of OBJs, some from
# 2020 and some from 2023, so we'll assume people are using
# an up to date version.
atlas = (
"# File type: Export all textures to three large images",
"# File type: Export full color texture patterns"
)
tiles = (
"# File type: Export tiles for textures to directory textures",
"# File type: Export individual textures to directory tex"
)
print('"{}"'.format(header))
if header in atlas: # If a texture atlas is used
obj_header.set_atlas()
elif header in tiles: # If the OBJ uses individual textures
obj_header.set_seperated()
return obj_header
header = obj_fd.readline()
if 'mineways' in header.lower():
obj_header.set_mineways()
# form of: # Wavefront OBJ file made by Mineways version 5.10...
for line in obj_fd:
if line.startswith("# File type:"):
header = line.rstrip() # Remove trailing newline

# The issue here is that Mineways has changed how the header is generated.
# As such, we're limited with only a couple of OBJs, some from
# 2020 and some from 2023, so we'll assume people are using
# an up to date version.
atlas = (
"# File type: Export all textures to three large images",
"# File type: Export full color texture patterns"
)
tiles = (
"# File type: Export tiles for textures to directory textures",
"# File type: Export individual textures to directory tex"
)
if header in atlas: # If a texture atlas is used
obj_header.set_atlas()
elif header in tiles: # If the OBJ uses individual textures
obj_header.set_seperated()
return obj_header
except UnicodeDecodeError:
print(f"Failed to read first line of obj: {filepath}")
return obj_header
Expand Down Expand Up @@ -704,7 +710,6 @@ def execute(self, context):

if isinstance(header, ObjHeaderOptions):
prefs.MCprep_exporter_type = header.exporter()


# Create empty at the center of the OBJ
empty = None
Expand All @@ -720,7 +725,7 @@ def execute(self, context):
min_pair = (header.export_bounds_min[0] + header.export_offset[0],
(-header.export_bounds_min[2]) + (-header.export_offset[2]),
header.export_bounds_min[1] + header.export_offset[1])

# Calculate the center of the bounding box
#
# We do this by taking the average of the given
Expand All @@ -732,56 +737,64 @@ def execute(self, context):
# This will give us the midpoints of these
# coordinates, which in turn will correspond
# to the center of the bounding box
location = ((max_pair[0] + min_pair[0]) / 2,
(max_pair[1] + min_pair[1]) / 2,
(max_pair[2] + min_pair[2]) / 2)
empty = bpy.data.objects.new(name=header.world_name + "_mcprep_empty", object_data=None)
location = (
(max_pair[0] + min_pair[0]) / 2,
(max_pair[1] + min_pair[1]) / 2,
(max_pair[2] + min_pair[2]) / 2)
empty = bpy.data.objects.new(
name=header.world_name + "_mcprep_empty", object_data=None)
empty.empty_display_size = 2
empty.empty_display_type = 'PLAIN_AXES'
empty.location = location
empty.hide_viewport = True # Hide empty globally
empty.hide_viewport = True # Hide empty globally
util.update_matrices(empty)
for field in fields(header):
if getattr(header, field.name) is None:
continue
if field.type == CommonMCOBJTextureType:
empty[field.name] = getattr(header, field.name).value
else:
empty[field.name] = getattr(header, field.name)
if getattr(header, field.name) is None:
continue
if field.type == CommonMCOBJTextureType:
empty[field.name] = getattr(header, field.name).value
else:
empty[field.name] = getattr(header, field.name)

else:
empty = bpy.data.objects.new("mcprep_obj_empty", object_data=None)
empty.empty_display_size = 2
empty.empty_display_type = 'PLAIN_AXES'
empty.hide_viewport = True # Hide empty globally
empty.hide_viewport = True # Hide empty globally

addon_prefs = util.get_user_preferences(context)

for obj in context.selected_objects:
if isinstance(header, CommonMCOBJ):
obj["COMMONMCOBJ_HEADER"] = True
obj["PARENTED_EMPTY"] = empty
obj.parent = empty
obj.matrix_parent_inverse = empty.matrix_world.inverted() # don't transform object
obj.matrix_parent_inverse = empty.matrix_world.inverted() # don't transform object
self.track_exporter = header.exporter

elif isinstance(header, ObjHeaderOptions):
obj["MCPREP_OBJ_HEADER"] = True
obj["MCPREP_OBJ_FILE_TYPE"] = header.texture_type()

obj.parent = empty
obj.matrix_parent_inverse = empty.matrix_world.inverted() # don't transform object
obj.matrix_parent_inverse = empty.matrix_world.inverted() # don't transform object

# Future-proofing for MCprep 4.0 when we
# Future-proofing for MCprep 4.0 when we
# put global exporter options behind a legacy
# option and by default use the object for
# option and by default use the object for
# getting the exporter
obj["MCPREP_OBJ_EXPORTER"] = "mineways-c" if header.exporter() == "Mineways" else "jmc2obj-c"
addon_prefs = util.get_user_preferences(context)
self.track_exporter = addon_prefs.MCprep_exporter_type # Soft detect.

# One final assignment of the preferences, to avoid doing each loop
val = header.exporter if isinstance(header, CommonMCOBJ) else header.exporter()
addon_prefs.MCprep_exporter_type = "Mineways" if val.lower().startswith("mineways") else "jmc2obj"

new_col = self.split_world_by_material(context)
new_col.objects.link(empty) # parent empty
new_col.objects.link(empty) # parent empty

return {'FINISHED'}

def obj_name_to_material(self, obj):
"""Update an objects name based on its first material"""
if not obj:
Expand Down
88 changes: 84 additions & 4 deletions test_files/world_tools_test.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,7 @@ def test_enable_obj_importer(self):
in_import_scn = "obj_import" in dir(bpy.ops.wm)
self.assertTrue(in_import_scn, "obj_import operator not found")


def test_world_import_jmc_full(self):
def test_world_import_legacy_jmc_full(self):
test_subpath = os.path.join(
"test_data", "jmc2obj_test_1_15_2.obj")
self._import_world_with_settings(file=test_subpath)
Expand All @@ -190,7 +189,29 @@ def test_world_import_jmc_full(self):
with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_jmc")

def test_world_import_mineways_separated(self):
def test_world_import_cmcobj_jmc_full(self):
test_subpath = os.path.join(
"test_data", "jmc2obj_test_1_21.obj")
self._import_world_with_settings(file=test_subpath)
# TODO: Check that affirms it picks up the mcobj format.
self.assertEqual(self.addon_prefs.MCprep_exporter_type, "jmc2obj")

# UV tool test. Would be in its own test, but then we would be doing
# multiple unnecessary imports of the same world. So make it a subtest.
with self.subTest("test_uv_transform_no_alert_jmc2obj"):
invalid, invalid_objs = detect_invalid_uvs_from_objs(
bpy.context.selected_objects)
prt = ",".join([obj.name.split("_")[-1] for obj in invalid_objs])
self.assertFalse(
invalid, f"jmc2obj export should not alert: {prt}")

with self.subTest("canon_name_validation"):
self._canonical_name_no_none()

with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_jmc")

def test_world_import_legacy_mineways_separated(self):
test_subpath = os.path.join(
"test_data", "mineways_test_separated_1_15_2.obj")
self._import_world_with_settings(file=test_subpath)
Expand All @@ -212,7 +233,29 @@ def test_world_import_mineways_separated(self):
with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_mineways")

def test_world_import_mineways_combined(self):
def test_world_import_cmcobj_mineways_separated(self):
test_subpath = os.path.join(
"test_data", "mineways_test_separated_1_21.obj")
self._import_world_with_settings(file=test_subpath)
self.assertEqual(self.addon_prefs.MCprep_exporter_type, "Mineways")

# UV tool test. Would be in its own test, but then we would be doing
# multiple unnecessary imports of the same world. So make it a subtest.
with self.subTest("test_uv_transform_no_alert_mineways"):
invalid, invalid_objs = detect_invalid_uvs_from_objs(
bpy.context.selected_objects)
prt = ",".join([obj.name for obj in invalid_objs])
self.assertFalse(
invalid,
f"Mineways separated tiles export should not alert: {prt}")

with self.subTest("canon_name_validation"):
self._canonical_name_no_none()

with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_mineways")

def test_world_import_legacy_mineways_combined(self):
test_subpath = os.path.join(
"test_data", "mineways_test_combined_1_15_2.obj")
self._import_world_with_settings(file=test_subpath)
Expand Down Expand Up @@ -247,6 +290,41 @@ def test_world_import_mineways_combined(self):
with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_mineways")

def test_world_import_cmcobj_mineways_combined(self):
test_subpath = os.path.join(
"test_data", "mineways_test_combined_1_21.obj")
self._import_world_with_settings(file=test_subpath)
self.assertEqual(self.addon_prefs.MCprep_exporter_type, "Mineways")

with self.subTest("test_uv_transform_combined_alert"):
invalid, invalid_objs = detect_invalid_uvs_from_objs(
bpy.context.selected_objects)
self.assertTrue(invalid, "Combined image export should alert")
if not invalid_objs:
self.fail(
"Correctly alerted combined image, but no obj's returned")

# Do specific checks for water and lava, could be combined and
# cover more than one uv position (and falsely pass the test) in
# combined, water is called "Stationary_Wat" and "Stationary_Lav"
# (yes, appears cutoff; and yes includes the flowing too)
# NOTE! in 2.7x, will be named "Stationary_Water", but in 2.9 it is
# "Test_MCprep_1.16.4__-145_4_1271_to_-118_255_1311_Stationary_Wat"
water_obj = [obj for obj in bpy.data.objects
if "Stationary_Wat" in obj.name][0]
lava_obj = [obj for obj in bpy.data.objects
if "Stationary_Lav" in obj.name][0]

invalid, invalid_objs = detect_invalid_uvs_from_objs(
[lava_obj, water_obj])
self.assertTrue(invalid, "Combined lava/water should still alert")

with self.subTest("canon_name_validation"):
self._canonical_name_no_none()

with self.subTest("test_mappings"):
self._import_materials_util("block_mapping_mineways")

def test_world_import_fails_expected(self):
testdir = os.path.dirname(__file__)
obj_path = os.path.join(testdir, "fake_world.obj")
Expand Down Expand Up @@ -314,6 +392,8 @@ def test_convert_mtl_simple(self):

# Resultant file
res = world_tools.convert_mtl(tmp_mtl)
print("Need to fix this, it's giving none (meaning a success, when it shouldn't?)")
print(res, " for: ", tmp_mtl)

# Restore the property we unset.
world_tools.BUILTIN_SPACES = save_init
Expand Down

0 comments on commit 23d4fa4

Please sign in to comment.