Wavefront .obj file

OBJ (or .OBJ) is a geometry definition file format first developed by Wavefront Technologies for '' The Advanced Visualizer'' animation package. It is an open file format and has been adopted by other 3D computer graphics application vendors.

The OBJ file format is a simple data-format that represents 3D geometry alone – namely, the position of each vertex, the UV position of each texture coordinate vertex, vertex normals, and the faces that make each polygon defined as a list of vertices, and texture vertices. Vertices are stored in a counter-clockwise order by default, making explicit declaration of face normals unnecessary. OBJ coordinates have no units, but OBJ files can contain scale information in a human readable comment line.

File format

Anything following a hash character (#) is a comment.

# This is a comment.

An OBJ file may contain vertex data, free-form curve/surface attributes, elements, free-form curve/surface body statements, connectivity between free-form surfaces, grouping and display/render attribute information. The most common elements are geometric vertices, texture coordinates, vertex normals and polygonal faces:

# List of geometric vertices, with (x, y, z, coordinates, w is optional and defaults to 1.0.
v 0.123 0.234 0.345 1.0
v ...
...
# List of texture coordinates, in (u, , w coordinates, these will vary between 0 and 1. v, w are optional and default to 0.
vt 0.500 1 vt ...
...
# List of vertex normals in (x,y,z) form; normals might not be unit vectors.
vn 0.707 0.000 0.707
vn ...
...
# Parameter space vertices in (u, , w form; free form geometry statement (see below)
vp 0.310000 3.210000 2.100000
vp ...
...
# Polygonal face element (see below)
f 1 2 3
f 3/1 4/2 5/3
f 6/4/1 3/5/3 7/6/5
f 7//1 8//2 9//3
f ...
...
# Line element (see below)
l 5 8 1 2 4 9

Geometric vertex

A vertex is specified via a line starting with the letter v. That is followed by (x,y,z w coordinates. W is optional and defaults to 1.0. W scales the point. The point (x,y,z,w) corresponds to the point (x/w,y/w,z/w). A right-hand coordinate system is used to specify the coordinate locations. Some applications support vertex colors, by putting red, green and blue values after x y and z (this precludes specifying w). The color values range from 0 to 1.

Parameter space vertices

A free-form geometry statement can be specified in a line starting with the string vp. Define points in parameter space of a curve or surface. u only is required for curve points, u and v for surface points and control points of non-rational trimming curves, and u, v and w (weight) for control points of rational trimming curves.

Face elements

Faces are defined using lists of vertex, texture and normal indices in the format vertex_index/texture_index/normal_index for which each index starts at 1 and increases corresponding to the order in which the referenced element was defined. Polygons such as quadrilaterals can be defined by using more than three indices.

OBJ files also support free-form geometry which use curves and surfaces to define objects, such as NURBS surfaces.

Vertex indices

A valid vertex index matches the corresponding vertex elements of a previously defined vertex list.
If an index is positive then it refers to the offset in that vertex list, starting at 1.
If an index is negative then it relatively refers to the end of the vertex list, -1 referring to the last element.

Each face can contain three or more vertices.

f v1 v2 v3 ....

Vertex texture coordinate indices

Optionally, texture coordinate indices can be used to specify texture coordinates when defining a face.
To add a texture coordinate index to a vertex index when defining a face,
one must put a slash immediately after the vertex index and then put the
texture coordinate index. No spaces are permitted before or after the slash.
A valid texture coordinate index starts from 1 and matches the corresponding
element in the previously defined list of texture coordinates.
Each face can contain three or more elements.

f v1/vt1 v2/vt2 v3/vt3 ...

Vertex normal indices

Optionally, normal indices can be used to specify normal vectors for vertices when defining a face.
To add a normal index to a vertex index when defining a face,
one must put a second slash after the texture coordinate index and then put
the normal index.
A valid normal index starts from 1 and matches the corresponding element
in the previously defined list of normals.
Each face can contain three or more elements.

f v1/vt1/vn1 v2/vt2/vn2 v3/vt3/vn3 ...

Vertex normal indices without texture coordinate indices

As texture coordinates are optional, one can define geometry without them, but
one must put two slashes after the vertex index before putting the normal index.

f v1//vn1 v2//vn2 v3//vn3 ...

Line elements

Records starting with the letter "l" (lowercase L) specify the order of the vertices which build a polyline.

l v1 v2 v3 v4 v5 v6 ...

Other geometry formats

Obj files support higher-order surfaces using several different kinds of interpolation, such as Taylor and B-splines, although support for those features in third party file readers is far from universal. Obj files also do not support mesh hierarchies or any kind of animation or deformation, such as vertex skinning or mesh morphing.

Reference materials

Materials that describe the visual aspects of the polygons are stored in
external files. More than one external MTL material file may be referenced from within the OBJ file. The file may contain one or more named material definitions.

mtllib xternal .mtl file name ...

This tag specifies the material name for the element following it. The material name matches a named material definition in an external file.

usemtl aterial name ...

Named objects and polygon groups are specified via the following tags.

o bject name ...
g roup name ...

Smooth shading across polygons is enabled by smoothing groups.

s 1
...
# Smooth shading can be disabled as well.
s off
...

Relative and absolute indices

OBJ files, due to their list structure, are able to reference vertices, normals, etc. either by their absolute position (1 represents the first defined vertex, N representing the Nth defined vertex), or by their relative position (-1 represents the latest defined vertex).
However, not all software supports the latter approach, and conversely some software inherently writes only the latter form (due to the convenience of appending elements without needing to recalculate vertex offsets, etc.), leading to occasional incompatibilities.

Material template library

The Material Template Library format (MTL) or File Format is a companion file format to .OBJ, also defined by Wavefront Technologies, that describes surface shading (material) properties of objects within one or more .OBJ files. A .OBJ file references one or more files (called "material libraries"), and from there, references one or more material descriptions by name. files are ASCII text that define the light reflecting properties of a surface for the purposes of computer rendering, and according to the Phong reflection model. The standard has widespread support among different computer software packages, making it a useful format for interchange of materials.

The MTL format, although still widely used, is outdated and does not fully support later technologies such as specular maps and parallax maps. However, due to the open and intuitive nature of the format, these can easily be added with a custom MTL file generator.

The MTL format defines a number of formats.

Basic materials

A single .mtl file may define multiple materials. Materials are defined one after another in the file, each starting with the newmtl command:

# define a material named 'Colored'
newmtl Colored

The ambient color of the material is declared using Ka. Color definitions are in RGB where each channel's value is between 0 and 1.

# white
Ka 1.000 1.000 1.000

Similarly, the diffuse color is declared using Kd.

# white
Kd 1.000 1.000 1.000

The specular color is declared using Ks, and weighted using the specular exponent Ns.

# black (off)
Ks 0.000 0.000 0.000

# ranges between 0 and 1000
Ns 10.000

Materials can be transparent. This is referred to as being ''dissolved''. Unlike real transparency, the result does not depend upon the thickness of the object. A value of 1.0 for "d" (''dissolve'') is the default and means fully opaque, as does a value of 0.0 for "Tr". Dissolve works on all illumination models.

# some implementations use 'd'
d 0.9
# others use 'Tr' (inverted: Tr = 1 - d)
Tr 0.1

Transparent materials can additionally have a Transmission Filter Color, specified with "Tf".

# Transmission Filter Color (using R G B)
Tf 1.0 0.5 0.5
# Transmission Filter Color (using CIEXYZ) - y and z values are optional and assumed to be equal to x if omitted
Tf xyz 1.0 0.5 0.5
# Transmission Filter Color from spectral curve file (not commonly used)
Tf spectral .rfl

A material can also have an optical density for its surface. This is also known as index of refraction.

# optical density
Ni 1.45000

Values can range from 0.001 to 10. A value of 1.0 means that light does not bend as it passes through an object. Increasing the optical density
increases the amount of bending. Glass has an index of refraction of
about 1.5. Values of less than 1.0 produce bizarre results and are not
recommended.

Multiple illumination models are available, per material. Note that it is not required to set a transparent illumination model in order to achieve transparency with "d" or "Tr", and in modern usage illum models are often not specified, even with transparent materials. The illum models are enumerated as follows:

0. Color on and Ambient off
1. Color on and Ambient on
2. Highlight on
3. Reflection on and Ray trace on
4. Transparency: Glass on, Reflection: Ray trace on
5. Reflection: Fresnel on and Ray trace on
6. Transparency: Refraction on, Reflection: Fresnel off and Ray trace on
7. Transparency: Refraction on, Reflection: Fresnel on and Ray trace on
8. Reflection on and Ray trace off
9. Transparency: Glass on, Reflection: Ray trace off
10. Casts shadows onto invisible surfaces

illum 2

Texture maps

Textured materials use the same properties as above, and additionally define texture maps. Below is an example of a common material file. See the full Wavefront file format reference for more details.

newmtl Textured
Ka 1.000 1.000 1.000
Kd 1.000 1.000 1.000
Ks 0.000 0.000 0.000
d 1.0
illum 2
# the ambient texture map
map_Ka lemur.tga

# the diffuse texture map (most of the time, it will be the same as the
# ambient texture map)
map_Kd lemur.tga

# specular color texture map
map_Ks lemur.tga

# specular highlight component
map_Ns lemur_spec.tga

# the alpha texture map
map_d lemur_alpha.tga

# some implementations use 'map_bump' instead of 'bump' below
map_bump lemur_bump.tga

# bump map (which by default uses luminance channel of the image)
bump lemur_bump.tga

# displacement map
disp lemur_disp.tga

# stencil decal texture (defaults to 'matte' channel of the image)
decal lemur_stencil.tga

Texture map statements may also have option parameters (se
full spec
.

# texture origin (1,1,1)
map_Ka -o 1 1 1 ambient.tga

# spherical reflection map
refl -type sphere clouds.tga

Texture options

-blendu on ,  off                       # set horizontal texture blending (default on)
-blendv on ,  off                       # set vertical texture blending (default on)
-boost float_value                     # boost mip-map sharpness
-mm base_value gain_value              # modify texture map values (default 0 1)
                                       #     base_value = brightness, gain_value = contrast
-o u   [w                           # Origin offset             (default 0 0 0)
-s u   [w                           # Scale                     (default 1 1 1)
-t u   [w                           # Turbulence                (default 0 0 0)
-texres resolution                     # texture resolution to create
-clamp on ,  off                        # only render texels in the clamped 0-1 range (default off)
                                       #   When unclamped, textures are repeated across a surface,
                                       #   when clamped, only texels which fall within the 0-1
                                       #   range are rendered.
-bm mult_value                         # bump multiplier (for bump maps only)
-imfchan r ,  g ,  b ,  m ,  l ,  z         # specifies which channel of the file is used to 
                                       # create a scalar or bump texture. r:red, g:green,
                                       # b:blue, m:matte, l:luminance, z:z-depth.. 
                                       # (the default for bump is 'l' and for decal is 'm')

For example,

# says to use the red channel of bumpmap.tga as the bumpmap
bump -imfchan r bumpmap.tga

For Reflection mapping, reflection maps...

-type sphere                           # specifies a sphere for a "refl" reflection map    
-type cube_top    ,  cube_bottom ,       # when using a cube map, the texture file for each
      cube_front  ,  cube_back   ,       # side of the cube is specified separately
      cube_left   ,  cube_right

Vendor-specific alterations

Because of the ease in parsing the files, and the unofficial spreading of the file format, files may contain vendor specific alterations.

According to the spec, options are supposed to precede the texture filename. However, at least one vendor generates files with options at the end.

# bump multiplier of 0.2
bump texbump.tga -bm 0.2

Physically-based rendering

The creators of the online 3D editing and modeling tool, Clara.io, proposed extending the MTL format to enable specifying physically-based rendering (PBR) maps and parameters. This extension has been subsequently adopted by Blender and TinyObjLoader. The extension PBR maps and parameters are:

Pr/map_Pr     # roughness
Pm/map_Pm     # metallic
Ps/map_Ps     # sheen
Pc            # clearcoat thickness
Pcr           # clearcoat roughness
Ke/map_Ke     # emissive
aniso         # anisotropy
anisor        # anisotropy rotation
norm          # normal map (RGB components represent XYZ components of the surface normal)

Further proposed extensions come from the DirectXMesh toolkit for Microsoft's DirectX engine, allowing the ability to define a model's pre-compiled RMA material.

map_RMA       # RMA material (roughness, metalness, ambient occlusion)
map_ORM       # alternate definition of map_RMA

See also

* glTF
* Object file
* OFF (file format)
* Relocatable Object Module Format
* STL (file format)
* PLY (file format) is an alternative file format offering more flexibility than most stereolithography applications.

References

External links

Appendix B1. Object Files (.obj), Advanced Visualizer ManualMtl Specification

{{DEFAULTSORT:Wavefront .Obj File
CAD file formats
3D graphics file formats