Texture import guide

Author: crapola

blender_t3d/__init__.py

@@ -1,8 +1,8 @@
 # type: ignore ; tell Pylance to ignore props.
-bl_info={
+bl_info:dict[str,any]={
 	"name": "Import and export old Unreal .T3D format",
 	"author": "Crapola",
-	"version": (1,1,0),
+	"version": (1,1,1),
 	"blender": (3,3,0),
 	"location": "File > Import-Export ; Object",
 	"description": "Import and export UnrealED .T3D files.",
@@ -117,13 +117,16 @@ def execute(self,context):
 		if not self.filename.split(".")[0]:
 			self.report({'ERROR'},INVALID_FILENAME)
 			return {'CANCELLED'}
-		importer.import_t3d_file(
+
+		results:dict[str,list[str]]=importer.import_t3d_file(
 			context,
 			self.filepath,
 			#self.filename,
 			self.snap_vertices,
 			self.snap_distance,
 			self.flip)
+		for w in results['WARNING']:
+			self.report({'WARNING'},w)
 		return {'FINISHED'}
 
 	def invoke(self, context, event):
@@ -144,18 +147,18 @@ def invoke(self, context, event):
 	lambda x,_:x.layout.operator(BT3D_MT_file_import.bl_idname),
 )
 
-def register():
-	print("Registering.")
+def register()->None:
+	#print("Registering.")
 	register_classes()
 	# Add to menu.
 	bpy.types.VIEW3D_MT_object.append(menus[0])
 	bpy.types.TOPBAR_MT_file_export.append(menus[1])
 	bpy.types.TOPBAR_MT_file_import.append(menus[2])
 
-def unregister():
-	print("Unregistering.")
+def unregister()->None:
+	#print("Unregistering.")
 	# Remove from menu.
 	bpy.types.VIEW3D_MT_object.remove(menus[0])
 	bpy.types.TOPBAR_MT_file_export.remove(menus[1])
 	bpy.types.TOPBAR_MT_file_import.remove(menus[2])
-	unregister_classes()
+	unregister_classes()

blender_t3d/blender_manifest.toml

@@ -0,0 +1,20 @@
+schema_version = "1.0.0"
+
+id = "blender_t3d"
+version = "1.1.1"
+name = "Blender T3D"
+tagline = "Import and export old Unreal .T3D format"
+maintainer = "Crapola <https://github.com/crapola>"
+type = "add-on"
+website = "https://github.com/crapola/blender_t3d"
+# # https://docs.blender.org/manual/en/dev/advanced/extensions/tags.html
+tags = ["Import-Export"]
+blender_version_min = "4.2.0"
+# License conforming to https://spdx.org/licenses/ (use "SPDX: prefix)
+# https://docs.blender.org/manual/en/dev/advanced/extensions/licenses.html
+license = [
+  "SPDX:GPL-3.0-or-later",
+]
+[permissions]
+files = "Import/export T3D from/to disk"
+clipboard = "Export brush to clipboard"

blender_t3d/exporter.py

@@ -24,10 +24,10 @@ def brush_from_object(o:'bpy.types.Object',scale_multiplier:float=1.0)->Brush|st
 	""" Turn Blender Object into t3d.Brush. """
 
 	if o.type!="MESH":
-		print(f"{o} is not a mesh.")
+		_print(f"{o} is not a mesh.")
 		return ""
 
-	print(f"Exporting {o.name}...")
+	_print(f"Exporting {o.name}...")
 
 	bm:bmesh.types.BMesh=bmesh.new()
 	bm.from_mesh(o.data)
@@ -59,7 +59,6 @@ def brush_from_object(o:'bpy.types.Object',scale_multiplier:float=1.0)->Brush|st
 		brush.mainscale=o.scale
 
 	# Custom properties.
-	#print(o.keys())
 	brush.csg=o.get("csg",brush.csg)
 	brush.group=o.get("group",brush.group)
 	brush.polyflags=o.get("polyflags",brush.polyflags)
@@ -83,7 +82,7 @@ def export_uv(verts:list[Vector],uvs:list[Vector],normal:Vector)->tuple:
 	uvs=[Vector((uv.x,1-uv.y))*TEXTURE_SIZE for uv in uvs]
 	verts=rotate_triangle_towards_normal(verts,Vector((0,0,1)))
 	_print("Rotated verts to XY plane:",verts)
-	height=verts[0].z
+	#height=verts[0].z
 	verts=[v.xy for v in verts]
 	_print("Flat Verts:",verts)
 	m_uvs=Matrix((*[v.to_3d()+Vector((0,0,1)) for v in uvs],))
@@ -136,7 +135,7 @@ def polygon_texture_transform(face:'bmesh.types.BMFace',mesh:'bmesh.types.BMesh'
 	""" Compute the Origin, TextureU, TextureV for a given face. """
 	points:list[bmesh.types.BMLoop]=face.loops[0:3]
 	if len(points)<2 or len(mesh.loops.layers.uv)==0:
-		print("Invalid geometry or no UV map.")
+		_print("Invalid geometry or no UV map.")
 		return ((0,0,0),(1,0,0),(0,1,0))
 	uvmap=mesh.loops.layers.uv[0]
 	verts:list[Vector]=[x.vert.co for x in points] # type: ignore

blender_t3d/importer.py

@@ -3,10 +3,13 @@
 """
 import math
 import time
+import typing
 from pathlib import Path
 
 import bmesh
+from bmesh.types import BMLayerItem
 import bpy
+from bpy.types import Material, Mesh
 from mathutils import Euler, Vector
 
 try:
@@ -26,20 +29,33 @@ def convert_uv(vertex:Vector,
 	v:Vector=vertex-origin
 	return Vector((v.dot(texture_u),v.dot(texture_v)))+pan
 
+def find_material(name:str)->Material|None:
+	"""
+	Case insensitive material search in Blender file.
+	It returns the first match in cases of case collisions.
+	"""
+	for m in bpy.data.materials:
+		if name.lower()==m.name.lower():
+			return m
+	return None
+
 def material_index_by_name(obj,matname:str)->int:
 	"""
 	Get material index using material name in object.
 	If material is not found on object, return 0.
 	"""
-	mat_dict = {mat.name: i for i, mat in enumerate(obj.data.materials)}
+	mat_dict:dict[str,int]={mat.name: i for i, mat in enumerate(obj.data.materials)}
 	try:
-		ret=mat_dict[matname]
+		ret:int=mat_dict[matname]
 		return ret
 	except KeyError:
 		return 0
 
-def create_object(collection:bpy.types.Collection,b:t3d.Brush)->bpy.types.Object:
+def create_object(collection:bpy.types.Collection,b:t3d.Brush)->tuple[bpy.types.Object,set[str]]:
 	""" Create blender object from t3d.Brush. """
+	# Keep track of missing materials for this object.
+	missing_materials:set[str]=set()
+	# Create mesh.
 	m:bpy.types.Mesh=bpy.data.meshes.new(b.actor_name)
 	m.from_pydata(*b.get_pydata())
 	# Create object.
@@ -52,9 +68,9 @@ def create_object(collection:bpy.types.Collection,b:t3d.Brush)->bpy.types.Object
 	mainscale=Vector(b.mainscale or (1,1,1))
 	pivot=Vector(b.prepivot or (0,0,0))
 	postscale=Vector(b.postscale or (1,1,1))
-	rotation=Vector(b.rotation or (0,0,0))*math.tau/65536
+	rotation:Vector|Euler=Vector(b.rotation or (0,0,0))*math.tau/65536
 	rotation.xy=-rotation.xy
-	rotation=Euler(rotation)
+	rotation=Euler(rotation.to_tuple())
 
 	pivot.rotate(rotation)
 	pivot*=postscale*mainscale
@@ -68,28 +84,35 @@ def create_object(collection:bpy.types.Collection,b:t3d.Brush)->bpy.types.Object
 	bm:bmesh.types.BMesh=bmesh.new()
 	bm.from_mesh(m)
 	# Create UV layer.
-	#uv_map=o.data.uv_layers.new(name='uvmap')
-	uv_layer=bm.loops.layers.uv.verify()
+	uv_layer:bmesh.types.BMLayerItem=bm.loops.layers.uv.verify()
 	# Polygon attributes.
-	texture_names=[p.texture for p in b.polygons]
-	flags=[p.flags for p in b.polygons]
-	layer_texture=bm.faces.layers.string.get("texture") or bm.faces.layers.string.new("texture")
-	layer_flags=bm.faces.layers.int.get("flags") or bm.faces.layers.int.new("flags")
+	texture_names:list[str]=[p.texture for p in b.polygons]
+	flags:list[int]=[p.flags for p in b.polygons]
+	layer_texture:BMLayerItem[bytes]=bm.faces.layers.string.get("texture") or bm.faces.layers.string.new("texture")
+	layer_flags:BMLayerItem[int]=bm.faces.layers.int.get("flags") or bm.faces.layers.int.new("flags")
+	i:int
+	face:bmesh.types.BMFace
 	for i,face in enumerate(bm.faces):
 		if texture_names[i]:
 			face[layer_texture]=bytes(str(texture_names[i]),'utf-8')
-			# Note: material names are case sensitive in Blender.
-			scene_mat=bpy.data.materials.get(texture_names[i])
-			# Add material to object if it's not there yet.
-			if scene_mat and not texture_names[i] in o.data.materials:
-				o.data.materials.append(scene_mat)
-			# Assign the face.
-			face.material_index=material_index_by_name(o,texture_names[i])
+			# Note: material names are case sensitive in Blender but
+			# not in UnrealEd.
+			scene_mat:Material|None=find_material(texture_names[i])
+			if scene_mat:
+				object_mesh_data:Mesh=typing.cast(Mesh,o.data)
+				# Add material to object if it's not there yet.
+				if not scene_mat.name in object_mesh_data.materials:
+					object_mesh_data.materials.append(scene_mat)
+				# Assign the face.
+				face.material_index=material_index_by_name(o,scene_mat.name)
+			else:
+				# Missing material.
+				missing_materials.add(texture_names[i])
 		face[layer_flags]=flags[i]
 		# UV coordinates.
-		poly=b.polygons[i]
+		poly:t3d.Polygon=b.polygons[i]
 		for loop in face.loops:
-			vert=loop.vert.co
+			vert:Vector=loop.vert.co
 			tu=Vector(poly.u)
 			tv=Vector(poly.v)
 			origin=Vector(poly.origin)
@@ -104,7 +127,6 @@ def create_object(collection:bpy.types.Collection,b:t3d.Brush)->bpy.types.Object
 	collection.objects.link(o)
 	# PostScale requires applying previous transforms.
 	if b.postscale:
-		#print("Postscale ",b.postscale)
 		o.select_set(True)
 		bpy.context.view_layer.objects.active=o
 		bpy.ops.object.transform_apply(scale=True,rotation=True,location=False)
@@ -115,36 +137,44 @@ def create_object(collection:bpy.types.Collection,b:t3d.Brush)->bpy.types.Object
 	o["group"]=b.group
 	o["polyflags"]=b.polyflags
 
-	return o
+	return o,missing_materials
 
 def import_t3d_file(
 	context:bpy.types.Context,
 	filepath:str,
 	snap_vertices:bool,
 	snap_distance:float,
-	flip:bool,
-	)->None:
+	flip:bool
+	)->dict[str,list[str]]:
 	""" Import T3D file into scene. """
-
+	# Missing materials that will be reported.
+	missing_materials:set[str]=set()
 	# Parse T3D file.
 	brushes:list[t3d.Brush]=t3d_parser.t3d_open(filepath)
 	time_start:float=time.time()
 	# Create a collection bearing the T3D file's name.
 	coll:bpy.types.Collection=bpy.data.collections.new(Path(filepath).name)
+	# Add it to the scene.
 	context.scene.collection.children.link(coll)
 	# Turn every t3d.Brush into a Blender object.
 	for b in brushes:
-		#print(f"Importing {b.actor_name}...")
+		obj:bpy.types.Object
 		if b.group=='cube':
 			# Ignore red brush.
-			print(f"blender_t3d import: {b.actor_name} is the red brush, so it won't be imported.")
+			print(f"blender_t3d: {b.actor_name} is the red brush, so it won't be imported.")
 			continue
 		# Snap to grid.
 		if snap_vertices:
 			b.snap(snap_distance)
-		obj=create_object(coll,b)
+		obj_missing_mats:set[str]
+		obj,obj_missing_mats=create_object(coll,b)
+		missing_materials.update(obj_missing_mats)
 		# Flip.
 		if b.csg.lower()=="csg_subtract" and flip:
 			obj.data.flip_normals()
 	# Output time to console.
-	print(f"Created {len(brushes)} meshes in {time.time()-time_start} seconds.")
+	print(f"blender_t3d: Created {len(brushes)} meshes in {time.time()-time_start} seconds.")
+	results:dict={"WARNING":[]}
+	if missing_materials:
+		results["WARNING"]=[f"{len(missing_materials)} materials missing: {', '.join(sorted(missing_materials))}"]
+	return results

blender_t3d/t3d_parser.py

@@ -2,7 +2,6 @@
 T3D parser.
 """
 import ast
-#import pprint
 import re
 from enum import IntEnum, auto
 
@@ -27,13 +26,12 @@ def filter_brushes(text:str)->str:
 	Filter T3D text to remove anything that's not a Brush actor.
 	Return the modified text.
 	"""
-	pattern:str=r"""(Begin Actor Class=Brush .*?End Actor)"""
+	pattern:str=r"""(Begin Actor Class=(?:Engine.)?Brush .*?End Actor)"""
 	rx:re.Pattern=re.compile(pattern,re.S|re.I)
 	matches:list=rx.findall(text)
 	ret:str="\n".join(matches)
 	return ret
 
-
 class Level(IntEnum):
 	""" Current nesting level. """
 	ROOT=0
@@ -67,7 +65,6 @@ def dict_from_t3d_property(line:str)->dict:
 		d=ast.literal_eval(x)
 	except (ValueError,SyntaxError):
 		# Errors might happen on lines we don't care about.
-		#print(line," ",x)
 		pass
 	return d
 
@@ -108,7 +105,7 @@ def parse_polygon_property(line:str)->dict[str,tuple]:
 	try:
 		keyword:str
 		data:str
-		line:str=line.replace("\t"," ") # TODO: all file
+		line=line.replace("\t"," ") # TODO: all file
 		keyword,data=line.strip().split(" ",1)
 		value:tuple=()
 		if keyword=="pan":
@@ -192,7 +189,6 @@ def t3d_open(path:str)->list[t3d.Brush]:
 		# Convert dictionaries to t3d.Brush.
 		tbs:list[t3d.Brush]=[]
 		for b in brushes:
-			#pprint.pprint(b)
 			# Convert values to tuples.
 			if b.get("mainscale") and b.get("mainscale",{}).get("scale"):
 				b["mainscale"]["scale"]=coords_from_xyz_dict(b["mainscale"]["scale"],1.0)
@@ -206,24 +202,24 @@ def t3d_open(path:str)->list[t3d.Brush]:
 				b["rotation"]=rotation_from_dict(b["rotation"])
 			tb:t3d.Brush=t3d.Brush.from_dictionary(b)
 			tbs.append(tb)
-		print(f"Loaded {len(tbs)} brushes from {path} in {time.time()-time_start} seconds.")
+		print(f"blender_t3d: Loaded {len(tbs)} brushes from {path} in {time.time()-time_start} seconds.")
 		return tbs
 
 def test()->None:
 	""" Test. """
 	samples_list:tuple[str,...]=(
-		"dev/samples/swat/fairfax-swat4.t3d",
-		"dev/samples/swat/map-ue2.t3d",
-		"dev/samples/swat/streets-raveshield.t3d",
-		"dev/samples/ut99/AS-Frigate.t3d",
-		"dev/samples/ut99/CTF-Coret.t3d",
-		"dev/samples/ut99/DM-Liandri.t3d",
-		"dev/samples/ut99/DOM-Cinder.t3d",
-		"dev/samples/ut2004/AS-FallenCity.t3d",
-		"dev/samples/ut2004/BR-Anubis.t3d",
-		"dev/samples/ut2004/DM-Deck17.t3d",
-		"dev/samples/xiii/DM_Amos.t3d",
-		"dev/samples/xiii/xiii_cubes.t3d"
+		"development/samples/swat/fairfax-swat4.t3d",
+		"development/samples/swat/map-ue2.t3d",
+		"development/samples/swat/streets-raveshield.t3d",
+		"development/samples/ut99/AS-Frigate.t3d",
+		"development/samples/ut99/CTF-Coret.t3d",
+		"development/samples/ut99/DM-Liandri.t3d",
+		"development/samples/ut99/DOM-Cinder.t3d",
+		"development/samples/ut2004/AS-FallenCity.t3d",
+		"development/samples/ut2004/BR-Anubis.t3d",
+		"development/samples/ut2004/DM-Deck17.t3d",
+		"development/samples/xiii/DM_Amos.t3d",
+		"development/samples/xiii/xiii_cubes.t3d"
 	)
 	for s in samples_list:
 		b:list[t3d.Brush]=t3d_open(s)