 | |
Assimp | |
AssimpImporter can import 3D models from many 3D file formats into SceneNode objects for Ab4d.SharpEngine rendering engine.
Inheritance HierarchyNamespace: Ab4d.SharpEngine.Assimp
Assembly: Ab4d.SharpEngine.Assimp (in Ab4d.SharpEngine.Assimp.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
SyntaxC#
public class AssimpImporter : IDisposable
The AssimpImporter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AssimpImporter(IBitmapIO) | Constructor that only takes an optional bitmapIO and will not create the textures immediately. Also no cache is used to read and store the textures. |
| AssimpImporter(AssimpConverterTextureLoaderDelegate) | Constructor that takes a custom texture loader delegate |
| AssimpImporter(IBitmapIO, Scene) | Constructor with optional Scene object that when specified is used to cache the loaded textures. When Scene.GpuDevice is initialized, then the textures are immediately created. Otherwise the textures are created when materials with textures are initialized. |
| AssimpImporter(IBitmapIO, VulkanDevice) | Constructor with optional gpuDevice object that when specified is used to create and cache the loaded textures. When gpuDevice is null, then the textures are created when materials with textures are initialized. |
Properties| Name | Description | |
|---|---|---|
 | AssimpConverter | Gets the AssimpConverter that was used to convert Assimp scene into SceneNode objects. |
| AssimpPostProcessSteps | Gets or sets Assimp PostProcessSteps (see assimp documentation for more information). Default value is FlipUVs | GenerateSmoothNormals | Triangulate. |
| AssimpVersion | Gets the version of the native Assimp library. |
| AssimpVersionString | Gets the version string of the native Assimp library in the form "major.minor.patch" |
| GenerateUniqueModelNames | When true (by default) then unique object names are generated, e.g. when the objects from Assimp scene have the same name, the "__2", "__3", "__4", etc. suffixes added to the name (the first object does not have changed name). |
| GitCommitHash | Gets the Git commit hash that was generated from the latest source code commit. Returns zero when Assimp library was complied from a zip file from GitHub's releases. |
| IsDisposed | Gets or sets a Boolean that specifies if this instance of DXAssimpImporter has been disposed. |
| IsVerboseLoggingEnabled | Gets or sets a Boolean that specifies if verbose logging is enabled. |
| LoggerCallback | Gets or sets a logger callback action that takes two strings (message and data). |
| NamedObjects | Gets a dictionary that can be used to get a 3D object by its name (key = name, value = object) |
| NativeAssimpScene | Gets native ImportedAssimpFile that contains then native AssimpScene object that was created when the file was read. To preserve the native Assimp scene first set PreserveNativeResourcesAfterImporting to true. When no scene was imported or when the native Assimp scene is not preserved, then this property is null. |
| PreserveNativeResourcesAfterImporting | When true then native Assimp scene is preserved and can be accessed by NativeAssimpScene property. |
| ResolveResourceFunc | ResolveResourceFunc sets a Func that takes a string (resource name) and returns a Stream. This can be used to read additional resources (materials and textures). The returned stream is automatically closed after it is used. |
| SupportedImporterFormats | Gets an array of AssimpImporterDesc that provide detailed information on supported import file formats. |
| SupportedImportFileExtensions | Gets an array of supported file extensions for importing (file extension are written without star and dot as prefix, g.e. "fxb", "obj", etc.) |
Methods| Name | Description | |
|---|---|---|
| Dispose | Disposes all unmanaged and managed resources. After calling Dispose, user cannot call any methods on this instance of AssimpImporter. |
| DisposeNativeAssimpScene | Disposes the native assimp scene that was previously importer when PreserveNativeResourcesAfterImporting was true. If PreserveNativeResourcesAfterImporting was false, then the native assimp scene is automatically disposed after importing. |
| Import(String, String) | Import method reads 3D models from the specified file and returns a GroupNode with imported 3D models. When PreserveNativeResourcesAfterImporting is true (false by default) then the native scene is stored into NativeAssimpScene property. |
| Import(Byte, String, String) | Import method reads 3D models from the specified byte array and returns a GroupNode with imported 3D models. When PreserveNativeResourcesAfterImporting is true (false by default) then the native scene is stored into NativeAssimpScene property. To read additional resources that are used by the imported file (for example textures), set the ResolveResourceFunc. |
| Import(Stream, String, String) | Import method reads 3D models from the specified file stream and returns a GroupNode with imported 3D models. When PreserveNativeResourcesAfterImporting is true (false by default) then the native scene is stored into NativeAssimpScene property. To read additional resources that are used by the imported file (for example textures), set the ResolveResourceFunc. |
| ImportFileToNativeAssimpScene(String) |
ImportFileToNativeAssimpScene reads the specified file and returns ImportedAssimpFile with native Assimp's Scene object.
Assimp's Scene object can be manually converted into SceneNodes by using AssimpConverter class.
This method does not change the NativeAssimpScene property. |
| ImportFileToNativeAssimpScene(Byte, String) |
ImportFileToNativeAssimpScene reads the specified byte array and returns ImportedAssimpFile with native Assimp's Scene object.
Assimp's Scene object can be manually converted into SceneNodes by using AssimpConverter class.
This method does not change the NativeAssimpScene property. |
| IsImportFormatSupported | Checks if the file extension (e.g. ".dae" or ".obj") is supported for import. |
See Also