Assimp  v4.1. (December 2018)
Assimp::AMFImporter Class Reference

Inherits Assimp::BaseImporter.

Public Member Functions

 AMFImporter () AI_NO_EXCEPT
 Default constructor. More...
 
 AMFImporter (const AMFImporter &pScene)=delete
 
bool CanRead (const std::string &pFile, IOSystem *pIOHandler, bool pCheckSig) const
 Returns whether the class can handle the format of the given file. More...
 
void GetExtensionList (std::set< std::string > &pExtensionList)
 
const aiImporterDescGetInfo () const
 Called by #Importer::GetImporterInfo to get a description of some loader features. More...
 
void InternReadFile (const std::string &pFile, aiScene *pScene, IOSystem *pIOHandler)
 Imports the given file into the given scene structure. More...
 
AMFImporteroperator= (const AMFImporter &pScene)=delete
 
void ParseFile (const std::string &pFile, IOSystem *pIOHandler)
 Parse AMF file and fill scene graph. More...
 
 ~AMFImporter ()
 Default destructor. More...
 
- Public Member Functions inherited from Assimp::BaseImporter
 BaseImporter () AI_NO_EXCEPT
 Constructor to be privately used by Importer. More...
 
virtual const ImporterUnitsGetApplicationUnits ()
 
const std::string & GetErrorText () const
 Returns the error description of the last error that occurred. More...
 
void GetExtensionList (std::set< std::string > &extensions)
 Called by #Importer::GetExtensionList for each loaded importer. More...
 
virtual double GetFileScale () const
 
aiSceneReadFile (Importer *pImp, const std::string &pFile, IOSystem *pIOHandler)
 Imports the given file and returns the imported data. More...
 
virtual void SetApplicationUnits (const ImporterUnits &unit)
 
virtual void SetFileScale (double scale)
 Will be called only by scale process when scaling is requested. More...
 
virtual void SetupProperties (const Importer *pImp)
 Called prior to ReadFile(). More...
 
virtual ~BaseImporter ()
 Destructor, private as well. More...
 

Additional Inherited Members

- Public Types inherited from Assimp::BaseImporter
enum  ImporterUnits {
  M, MM, CM, INCHES,
  FEET
}
 
enum  TextFileMode { ALLOW_EMPTY, FORBID_EMPTY }
 Enum to define, if empty files are ok or not. More...
 
- Static Public Member Functions inherited from Assimp::BaseImporter
static bool CheckMagicToken (IOSystem *pIOHandler, const std::string &pFile, const void *magic, unsigned int num, unsigned int offset=0, unsigned int size=4)
 Check whether a file starts with one or more magic tokens. More...
 
static void ConvertToUTF8 (std::vector< char > &data)
 An utility for all text file loaders. More...
 
static void ConvertUTF8toISO8859_1 (std::string &data)
 An utility for all text file loaders. More...
 
template<typename T >
static AI_FORCE_INLINE void CopyVector (std::vector< T > &vec, T *&out, unsigned int &outLength)
 Utility function to move a std::vector into a aiScene array. More...
 
static std::string GetExtension (const std::string &pFile)
 Extract file extension from a string. More...
 
static bool SearchFileHeaderForToken (IOSystem *pIOSystem, const std::string &file, const char **tokens, unsigned int numTokens, unsigned int searchBytes=200, bool tokensSol=false, bool noAlphaBeforeTokens=false)
 A utility for CanRead(). More...
 
static bool SimpleExtensionCheck (const std::string &pFile, const char *ext0, const char *ext1=NULL, const char *ext2=NULL)
 Check whether a file has a specific file extension. More...
 
static void TextFileToBuffer (IOStream *stream, std::vector< char > &data, TextFileMode mode=FORBID_EMPTY)
 Utility for text file loaders which copies the contents of the file into a memory buffer and converts it to our UTF8 representation. More...
 
- Public Attributes inherited from Assimp::BaseImporter
std::map< ImporterUnits, double > importerUnits
 Assimp Importer unit conversions available if you need another measurment unit add it below. More...
 
- Protected Attributes inherited from Assimp::BaseImporter
ImporterUnits applicationUnits = ImporterUnits::M
 
double fileScale = 1.0
 
double importerScale = 1.0
 
std::string m_ErrorText
 Error description in case there was one. More...
 
ProgressHandlerm_progress
 Currently set progress handler. More...
 

Detailed Description

Class that holding scene graph which include: geometry, metadata, materials etc.

Implementing features.

Limitations.

  1. When for texture mapping used set of source textures (r, g, b, a) not only one then attribute "tiled" for all set will be true if it true in any of source textures. Example. Triangle use for texture mapping three textures. Two of them has "tiled" set to false and one - set to true. In scene all three textures will be tiled.

Unsupported features:

  1. Node <composite>, formulas in <composite> and <color>. For implementing this feature can be used expression parser "muParser" like in project "amf_tools".
  2. Attribute "profile" in node <color>.
  3. Curved geometry: <edge>, <normal> and children nodes of them.
  4. Attributes: "unit" and "version" in <amf> read but do nothing.
  5. <metadata> stored only for root node <amf>.
  6. Color averaging of vertices for which <triangle>'s set different colors.

Supported nodes: General: <amf>; <constellation>; <instance> and children <deltax>, <deltay>, <deltaz>, <rx>, <ry>, <rz>; <metadata>;

Geometry: <object>; <mesh>; <vertices>; <vertex>; <coordinates> and children <x>, <y>, <z>; <volume>; <triangle> and children <v1>, <v2>, <v3>;

Material: <color> and children <r>, <g>, , ; <texture>; <material>; two variants of texture coordinates: new - <texmap> and children <utex1>, <utex2>, <utex3>, <vtex1>, <vtex2>, <vtex3> old - <map> and children <u1>, <u2>, <u3>, <v1>, <v2>, <v3>

Constructor & Destructor Documentation

◆ AMFImporter() [1/2]

Assimp::AMFImporter::AMFImporter ( )
inline

Default constructor.

◆ ~AMFImporter()

Assimp::AMFImporter::~AMFImporter ( )

Default destructor.

◆ AMFImporter() [2/2]

Assimp::AMFImporter::AMFImporter ( const AMFImporter pScene)
delete

Member Function Documentation

◆ CanRead()

bool Assimp::AMFImporter::CanRead ( const std::string &  pFile,
IOSystem pIOHandler,
bool  checkSig 
) const
virtual

Returns whether the class can handle the format of the given file.

The implementation should be as quick as possible. A check for the file extension is enough. If no suitable loader is found with this strategy, CanRead() is called again, the 'checkSig' parameter set to true this time. Now the implementation is expected to perform a full check of the file structure, possibly searching the first bytes of the file for magic identifiers or keywords.

Parameters
pFilePath and file name of the file to be examined.
pIOHandlerThe IO handler to use for accessing any file.
checkSigSet to true if this method is called a second time. This time, the implementation may take more time to examine the contents of the file to be loaded for magic bytes, keywords, etc to be able to load files with unknown/not existent file extensions.
Returns
true if the class can read this file, false if not.

Implements Assimp::BaseImporter.

◆ GetExtensionList()

void Assimp::AMFImporter::GetExtensionList ( std::set< std::string > &  pExtensionList)

◆ GetInfo()

const aiImporterDesc * Assimp::AMFImporter::GetInfo ( ) const
virtual

Called by #Importer::GetImporterInfo to get a description of some loader features.

Importers must provide this information.

Implements Assimp::BaseImporter.

◆ InternReadFile()

void Assimp::AMFImporter::InternReadFile ( const std::string &  pFile,
aiScene pScene,
IOSystem pIOHandler 
)
virtual

Imports the given file into the given scene structure.

The function is expected to throw an ImportErrorException if there is an error. If it terminates normally, the data in aiScene is expected to be correct. Override this function to implement the actual importing.
The output scene must meet the following requirements:

  • At least a root node must be there, even if its only purpose is to reference one mesh.
  • aiMesh::mPrimitiveTypes may be 0. The types of primitives in the mesh are determined automatically in this case.
  • the vertex data is stored in a pseudo-indexed "verbose" format. In fact this means that every vertex that is referenced by a face is unique. Or the other way round: a vertex index may not occur twice in a single aiMesh.
  • aiAnimation::mDuration may be -1. Assimp determines the length of the animation automatically in this case as the length of the longest animation channel.
  • aiMesh::mBitangents may be NULL if tangents and normals are given. In this case bitangents are computed as the cross product between normal and tangent.
  • There needn't be a material. If none is there a default material is generated. However, it is recommended practice for loaders to generate a default material for yourself that matches the default material setting for the file format better than Assimp's generic default material. Note that default materials should be named AI_DEFAULT_MATERIAL_NAME if they're just color-shaded or AI_DEFAULT_TEXTURED_MATERIAL_NAME if they define a (dummy) texture.

If the AI_SCENE_FLAGS_INCOMPLETE-Flag is not set:

  • at least one mesh must be there
  • there may be no meshes with 0 vertices or faces

This won't be checked (except by the validation step): Assimp will crash if one of the conditions is not met!

Parameters
pFilePath of the file to be imported.
pSceneThe scene object to hold the imported data. NULL is not a valid parameter.
pIOHandlerThe IO handler to use for any file access. NULL is not a valid parameter.

Implements Assimp::BaseImporter.

◆ operator=()

AMFImporter& Assimp::AMFImporter::operator= ( const AMFImporter pScene)
delete

◆ ParseFile()

void Assimp::AMFImporter::ParseFile ( const std::string &  pFile,
IOSystem pIOHandler 
)

Parse AMF file and fill scene graph.

The function has no return value. Result can be found by analyzing the generated graph. Also exception can be thrown if trouble will found.

Parameters
[in]pFile- name of file to be parsed.
[in]pIOHandler- pointer to IO helper object.

The documentation for this class was generated from the following files: