Utility that exports mesh data to Wavefront OBJ and accompanying MTL text files. It writes vertex positions, normals, UVs, face groups with material assignments, and constructs MTL entries using a provided callback for per-material map lines.
namespace Sandbox;
/// <summary>
/// Writes Wavefront OBJ + MTL text from model vertex data and material slots.
/// </summary>
internal static class ObjWriter
{
public readonly record struct MaterialSlot( string Name, Material Material );
public readonly record struct FaceGroup(
string ObjectName,
string MaterialName,
IReadOnlyList<int> TriangleIndices );
public static void Write(
string objPath,
string mtlFileName,
Vertex[] vertices,
IReadOnlyList<FaceGroup> groups,
IReadOnlyList<MaterialSlot> materials,
Func<MaterialSlot, string> writeMaterialBlock )
{
var objDir = Path.GetDirectoryName( objPath ) ?? ".";
Directory.CreateDirectory( objDir );
var mtlPath = Path.Combine( objDir, mtlFileName );
WriteMtl( mtlPath, materials, writeMaterialBlock );
WriteObj( objPath, mtlFileName, vertices, groups );
}
static void WriteObj(
string objPath,
string mtlFileName,
Vertex[] vertices,
IReadOnlyList<FaceGroup> groups )
{
var sb = new StringBuilder( capacity: Math.Max( 4096, vertices.Length * 48 ) );
sb.AppendLine( "# Exported by local.modelexporter" );
sb.AppendLine( $"mtllib {mtlFileName}" );
sb.AppendLine();
for ( var i = 0; i < vertices.Length; i++ )
{
var v = vertices[i];
sb.AppendLine( FormattableString.Invariant(
$"v {v.Position.x:0.######} {v.Position.y:0.######} {v.Position.z:0.######}" ) );
}
sb.AppendLine();
for ( var i = 0; i < vertices.Length; i++ )
{
var n = vertices[i].Normal;
sb.AppendLine( FormattableString.Invariant(
$"vn {n.x:0.######} {n.y:0.######} {n.z:0.######}" ) );
}
sb.AppendLine();
for ( var i = 0; i < vertices.Length; i++ )
{
var uv = vertices[i].TexCoord0;
// OBJ / Blender expect V flipped relative to Source-style UVs.
var v = 1f - uv.y;
sb.AppendLine( FormattableString.Invariant(
$"vt {uv.x:0.######} {v:0.######}" ) );
}
sb.AppendLine();
foreach ( var group in groups )
{
if ( group.TriangleIndices.Count < 3 )
continue;
sb.AppendLine( $"o {SanitizeObjName( group.ObjectName )}" );
if ( !string.IsNullOrWhiteSpace( group.MaterialName ) )
sb.AppendLine( $"usemtl {SanitizeMtlName( group.MaterialName )}" );
for ( var i = 0; i + 2 < group.TriangleIndices.Count; i += 3 )
{
var a = group.TriangleIndices[i] + 1;
var b = group.TriangleIndices[i + 1] + 1;
var c = group.TriangleIndices[i + 2] + 1;
sb.AppendLine( $"f {a}/{a}/{a} {b}/{b}/{b} {c}/{c}/{c}" );
}
sb.AppendLine();
}
File.WriteAllText( objPath, sb.ToString() );
}
static void WriteMtl(
string mtlPath,
IReadOnlyList<MaterialSlot> materials,
Func<MaterialSlot, string> writeMaterialBlock )
{
var sb = new StringBuilder();
sb.AppendLine( "# Exported by local.modelexporter" );
sb.AppendLine();
foreach ( var slot in materials )
{
sb.AppendLine( $"newmtl {SanitizeMtlName( slot.Name )}" );
sb.AppendLine( "Ka 1.000 1.000 1.000" );
sb.AppendLine( "Kd 1.000 1.000 1.000" );
sb.AppendLine( "Ks 0.000 0.000 0.000" );
sb.AppendLine( "d 1.0" );
sb.AppendLine( "illum 1" );
var maps = writeMaterialBlock( slot );
if ( !string.IsNullOrWhiteSpace( maps ) )
sb.Append( maps );
sb.AppendLine();
}
File.WriteAllText( mtlPath, sb.ToString() );
}
public static string SanitizeMtlName( string name )
{
if ( string.IsNullOrWhiteSpace( name ) )
return "material";
var sb = new StringBuilder( name.Length );
foreach ( var c in name )
{
if ( char.IsLetterOrDigit( c ) || c is '_' or '-' or '.' )
sb.Append( c );
else
sb.Append( '_' );
}
return sb.Length > 0 ? sb.ToString() : "material";
}
public static string SanitizeObjName( string name )
{
return SanitizeMtlName( name );
}
}