<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Assimp: assimp - Open Asset Import Library</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Assimp
 <span id="projectnumber">v3.1.1 (June 2014)</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">assimp - Open Asset Import Library </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="image">
<img src="dragonsplash.png" />
</div>
<h1><a class="anchor" id="intro"></a>
Introduction</h1>
<p>assimp is a library to load and process geometric scenes from various data formats. It is tailored at typical game scenarios by supporting a node hierarchy, static or skinned meshes, materials, bone animations and potential texture data. The library is <em>not</em> designed for speed, it is primarily useful for importing assets from various sources once and storing it in a engine-specific format for easy and fast every-day-loading. assimp is also able to apply various post processing steps to the imported data such as conversion to indexed meshes, calculation of normals or tangents/bitangents or conversion from right-handed to left-handed coordinate systems.</p>
<p>assimp currently supports the following file formats (note that some loaders lack some features of their formats because some file formats contain data not supported by assimp, some stuff would require so much conversion work that it has not been implemented yet and some (most ...) formats lack proper specifications): </p><hr/>
<p> <br />
<code> <b>Collada</b> ( <em>*.dae;*.xml</em> )<br />
<b>Blender</b> ( <em>*.blend</em> ) <sup>3</sup><br />
<b>Biovision BVH </b> ( <em>*.bvh</em> ) <br />
<b>3D Studio Max 3DS</b> ( <em>*.3ds</em> ) <br />
<b>3D Studio Max ASE</b> ( <em>*.ase</em> ) <br />
<b>Wavefront Object</b> ( <em>*.obj</em> ) <br />
<b>Stanford Polygon Library</b> ( <em>*.ply</em> ) <br />
<b>AutoCAD DXF</b> ( <em>*.dxf</em> ) <br />
<b>IFC-STEP</b> ( <em>*.ifc</em> )<br />
<b>Neutral File Format</b> ( <em>*.nff</em> ) <br />
<b>Sense8 WorldToolkit</b> ( <em>*.nff</em> ) <br />
<b>Valve Model</b> ( <em>*.smd,*.vta</em> ) <sup>3</sup> <br />
<b>Quake I</b> ( <em>*.mdl</em> ) <br />
<b>Quake II</b> ( <em>*.md2</em> ) <br />
<b>Quake III</b> ( <em>*.md3</em> ) <br />
<b>Quake 3 BSP</b> ( <em>*.pk3</em> ) <sup>1</sup> <br />
<b>RtCW</b> ( <em>*.mdc</em> )<br />
<b>Doom 3</b> ( <em>*.md5mesh;*.md5anim;*.md5camera</em> ) <br />
<b>DirectX X </b> ( <em>*.x</em> ). <br />
<b>Quick3D </b> ( <em>*.q3o;<em>q3s</em> ). <br />
<b>Raw Triangles </b> ( <em></em>.raw</em> ). <br />
<b>AC3D </b> ( <em>*.ac</em> ). <br />
<b>Stereolithography </b> ( <em>*.stl</em> ). <br />
<b>Autodesk DXF </b> ( <em>*.dxf</em> ). <br />
<b>Irrlicht Mesh </b> ( <em>*.irrmesh;*.xml</em> ). <br />
<b>Irrlicht Scene </b> ( <em>*.irr;*.xml</em> ). <br />
<b>Object File Format </b> ( <em>*.off</em> ). <br />
<b>Terragen Terrain </b> ( <em>*.ter</em> ) <br />
<b>3D GameStudio Model </b> ( <em>*.mdl</em> ) <br />
<b>3D GameStudio Terrain</b> ( <em>*.hmp</em> )<br />
<b>Ogre</b> (<em>*.mesh.xml, *.skeleton.xml, *.material</em>)<sup>3</sup> <br />
<b>Milkshape 3D</b> ( <em>*.ms3d</em> )<br />
<b>LightWave Model</b> ( <em>*.lwo</em> )<br />
<b>LightWave Scene</b> ( <em>*.lws</em> )<br />
<b>Modo Model</b> ( <em>*.lxo</em> )<br />
<b>CharacterStudio Motion</b> ( <em>*.csm</em> )<br />
<b>Stanford Ply</b> ( <em>*.ply</em> )<br />
<b>TrueSpace</b> ( <em>*.cob, *.scn</em> )<sup>2</sup><br />
<br />
</code> See the <a class="el" href="importer_notes.html">Importer Notes Page </a> for informations, what a specific importer can do and what not. Note that although this paper claims to be the official documentation, <a href="http://assimp.sourceforge.net/main_features_formats.html">http://assimp.sourceforge.net/main_features_formats.html</a> <br />
is usually the most up-to-date list of file formats supported by the library. <br />
</p>
<p><sup>1</sup>: Experimental loaders<br />
<sup>2</sup>: Indicates very limited support - many of the format's features don't map to <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs. ">Assimp</a>'s data structures.<br />
<sup>3</sup>: These formats support animations, but assimp doesn't yet support them (or they're buggy)<br />
<br />
</p><hr/>
<p>assimp is independent of the Operating System by nature, providing a C++ interface for easy integration with game engines and a C interface to allow bindings to other programming languages. At the moment the library runs on any little-endian platform including X86/Windows/Linux/Mac and X64/Windows/Linux/Mac. Special attention was paid to keep the library as free as possible from dependencies.</p>
<p>Big endian systems such as PPC-Macs or PPC-Linux systems are not officially supported at the moment. However, most formats handle the required endian conversion correctly, so large parts of the library should work.</p>
<p>The assimp linker library and viewer application are provided under the BSD 3-clause license. This basically means that you are free to use it in open- or closed-source projects, for commercial or non-commercial purposes as you like as long as you retain the license informations and take own responsibility for what you do with it. For details see the LICENSE file.</p>
<p>You can find test models for almost all formats in the <assimp_root>/test/models directory. Beware, they're <em>free</em>, but not all of them are <em>open-source</em>. If there's an accompagning '<file>.txt' file don't forget to read it.</p>
<h1><a class="anchor" id="main_install"></a>
Installation</h1>
<p>assimp can be used in two ways: linking against the pre-built libraries or building the library on your own. The former option is the easiest, but the assimp distribution contains pre-built libraries only for Visual C++ 2005 and 2008. For other compilers you'll have to build assimp for yourself. Which is hopefully as hassle-free as the other way, but needs a bit more work. Both ways are described at the <a class="el" href="install.html">Installation page. </a></p>
<h1><a class="anchor" id="main_usage"></a>
Usage</h1>
<p>When you're done integrating the library into your IDE / project, you can now start using it. There are two separate interfaces by which you can access the library: a C++ interface and a C interface using flat functions. While the former is easier to handle, the latter also forms a point where other programming languages can connect to. Upto the moment, though, there are no bindings for any other language provided. Have a look at the <a class="el" href="usage.html">Usage page </a> for a detailed explanation and code examples.</p>
<h1><a class="anchor" id="main_data"></a>
Data Structures</h1>
<p>When the importer successfully completed its job, the imported data is returned in an aiScene structure. This is the root point from where you can access all the various data types that a scene/model file can possibly contain. The <a class="el" href="data.html">Data Structures page </a> describes how to interpret this data.</p>
<h1><a class="anchor" id="ext"></a>
Extending the library</h1>
<p>There are many 3d file formats in the world, and we're happy to support as many as possible. If you need support for a particular file format, why not implement it yourself and add it to the library? Writing importer plugins for assimp is considerably easy, as the whole postprocessing infrastructure is available and does much of the work for you. See the <a class="el" href="extend.html">Extending the library </a> page for more information.</p>
<h1><a class="anchor" id="main_support"></a>
Support & Feedback</h1>
<p>If you have any questions/comments/suggestions/bug reports you're welcome to post them in our <a href="https://sourceforge.net/forum/forum.php?forum_id=817653">forums</a>. Alternatively there's a mailing list, <a href="https://sourceforge.net/mailarchive/forum.php?forum_name=assimp-discussions">assimp-discussions</a>. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Oct 18 2014 15:01:15 for Assimp by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
c91ba918b10a34cc02eba8d949866683
>
files
>
236
