Unigine.Importer Class

class MyCustomImporter : public Unigine::Importer
{
public:
	MyCustomImporter();
	virtual ~MyCustomImporter();

/*...*/

// overrides of event functions
protected:
	virtual bool onInit(const ImportScenePtr &scene, const char *filepath) override;
	virtual bool onImport(const char *output_path) override;
	virtual bool onImportTexture(const Unigine::ImportProcessor &processor, const Unigine::ImportTexturePtr &import_texture) override;
	virtual bool onImportMaterial(const Unigine::ImportProcessor &processor, const Unigine::MaterialPtr &material, const Unigine::ImportMaterial &import_material) override;
	virtual bool onImportMesh(const Unigine::ImportProcessor &processor, const Unigine::MeshPtr &mesh, const Unigine::ImportMesh &import_mesh) override;
	virtual bool onImportLight(const Unigine::ImportProcessor &processor, const Unigine::LightPtr &light, const Unigine::ImportLight &import_light) override;
	virtual bool onImportCamera(const Unigine::ImportProcessor &processor, const Unigine::PlayerPtr &camera, const Unigine::ImportCamera &import_camera);
	virtual bool onImportNode(const Unigine::ImportProcessor &processor, const Unigine::NodePtr &node, const Unigine::ImportNode &import_node) override;
	virtual bool onImportNodeChild(const ImportProcessorPtr &processor, const Unigine::NodePtr &node_parent, const ImportNodePtr &import_node_parent, const Unigine::NodePtr &node_child, const ImportNodePtr &import_node_child) override;
	virtual bool onImportAnimation(const Unigine::ImportProcessor &processor, const Unigine::MeshAnimationPtr &animation, const Unigine::ImportMesh &import_mesh, const Unigine::ImportAnimation &import_animation) override;

private:
	ImportScene *import_scene();
	void import_textures(const Unigine::ImportScene &scene);
	void import_materials(const Unigine::ImportScene &scene);
	void import_animations(const Unigine::ImportScene &scene);

	void process_node(const Unigine::ImportScene &import_scene, const Unigine::ImportNode &parent, fbx::FbxNode *fbx_node);
	void process_mesh(const Unigine::ImportScene &import_scene, const Unigine::ImportNode &node, fbx::FbxNode *fbx_node, fbx::FbxMesh *fbx_mesh);
	void process_light(const Unigine::ImportScene &import_scene, const Unigine::ImportNode &node, fbx::FbxNode *fbx_node, fbx::FbxLight *fbx_light);
	void process_camera(const Unigine::ImportScene &import_scene, const Unigine::ImportNode &node, fbx::FbxNode *fbx_node, fbx::FbxCamera *fbx_camera);

/*...*/

};

Importer Class

Enums

Axis#

Axis.

Name	Description
None = -1	Axis none.
X = None + 1	X axis.
NX = X + 1	Negative X axis.
Y = NX + 1	Y axis.
NY = Y + 1	Negative Y axis.
Z = NY + 1	Z axis.
NZ = Z + 1	Negative Z axis.

Properties

string AnimationsProcessor#

string LightsProcessor#

string MeshesProcessor#

string NodesProcessor#

string CamerasProcessor#

string MaterialsProcessor#

string OutputFilepath#

string TexturesProcessor#

Members

---

Importer ( ) #

Constructor. Creates an empty importer.

Importer GetImporter ( ) #

Returns the importer itself.

Return value

Importer itself.

bool ContainsParameter ( string name ) #

Returns a value indicating whether the list of import parameters includes a parameter with a given name.

Arguments

• string name - Parameter name.

Return value

true if the list of import parameters includes a parameter with a given name; otherwise, false.

void SetParameterInt ( string name, int v ) #

Sets a new value for the specified integer parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the integer parameter.
• int v - New value to be set.

int GetParameterInt ( string name ) #

Returns the current value of the specified integer parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the integer parameter.

Return value

Value of the integer parameter.

void SetParameterFloat ( string name, float v ) #

Sets a new value for the specified float parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the float parameter.
• float v - New value to be set.

float GetParameterFloat ( string name ) #

Returns the current value of the specified float parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the float parameter.

Return value

Value of the float parameter.

void SetParameterDouble ( string name, double v ) #

Sets a new value for the specified double parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the double parameter.
• double v - New value to be set.

double GetParameterDouble ( string name ) #

Returns the current value of the specified double parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the double parameter.

Return value

Value of the double parameter.

void SetParameterString ( string name, string v ) #

Sets a new value for the specified string parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the string parameter.
• string v - New value to be set.

string GetParameterString ( string name ) #

Returns the current value of the specified string parameter. There are built-in parameters that can also be used in custom importers.

Arguments

• string name - Name of the string parameter.

Return value

Value of the string parameter.

bool AddPreProcessor ( string type_name ) #

Adds an import pre-processor with a given type name. There are built-in pre-processors that can also be added to custom importers.

Arguments

• string type_name - Pre-processor type name.

Return value

true if the specified import pre-processor is successfully added; otherwise, false.

void RemovePreProcessor ( string type_name ) #

Removes an import pre-processor with a given type name. There are built-in pre-processors that can also be added to custom importers.

Arguments

• string type_name - Pre-processor type name.

bool HasPreProcessor ( string type_name ) #

Returns a value indicating if an import pre-processor with a given type name is used by the importer. There are built-in pre-processors that can also be added to custom importers.

Arguments

• string type_name - Pre-processor type name.

Return value

true if an import pre-processor with a given type name is used by the importer; otherwise, false.

bool AddPostProcessor ( string type_name ) #

Adds an import post-processor with a given type name. There are built-in post-processors that can also be added to custom importers.

Arguments

• string type_name - Post-processor type name to check.

void RemovePostProcessor ( string type_name ) #

Removes an import post-processor with a given type name. There are built-in post-processors that can also be added to custom importers.

Arguments

• string type_name - Post-processor type name.

bool HasPostProcessor ( string type_name ) #

Returns a value indicating if an import post-processor with a given type name is used by the importer. There are built-in post-processors that can also be added to custom importers.

Arguments

• string type_name - Post-processor type name to check.

Return value

true if an import post-processor with a given type name is used by the importer; otherwise, false.

ImportScene GetScene ( ) #

Returns the imported scene.

Return value

Instance of the ImportScene class.

bool Init ( string filepath, int flags = ~0 ) #

Initializes the importer for the specified file using the given flags. Import flags specify which scene components are to be imported.

Arguments

• string filepath - Path to a file to be imported.
• int flags - Set of import flags. Any combination of IMPORT_* flags, or ~0 to set all of them.

Return value

true if the importer was initialized successfully; otherwise, 0.

bool Import ( string output_path ) #

Imports the contents of the input file to the specified output path.

Arguments

• string output_path - Output path.

Return value

true if the contents of the input file are successfully imported to the specified output path; otherwise, false.

string GetSourceFilepath ( ) #

Returns the path to the source file.

Return value

Source file path.

int GetFlags ( ) #

Returns the current set of import flags (IMPORT_*) resulting output file path for imported scene component(s). In case if a set of files were generated the path to resulting *.node file will be returned.

bool ComputeBoundBox ( ImportMesh import_mesh ) #

Computes a bound box for the specified mesh.

Arguments

• ImportMesh import_mesh - Imported mesh for which a bound box is to be calculated.

Return value

true if a bound box for the specified mesh is successfully calculated; otherwise, false.

bool Preprocess ( ) #

Starts execution of all added pre-processors.

Return value

true if the pre-processing is completed successfully.

Node ConvertNode ( ImportProcessor processor, ImportNode root_node ) #

Converts metadata stored in an instance of the ImportNode class to UNIGINE's node (node hierarchy).

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• ImportNode root_node - Instance of the ImportNode class representing the root node of the imported hierarchy.

Return value

Resulting UNIGINE's node instance that stores the specified imported node (node hierarchy).

bool ImportTexture ( ImportProcessor processor, ImportTexture import_texture ) #

Imports the specified texture and uses the specified processor to process and save the generated texture to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• ImportTexture import_texture - Instance of the ImportTexture class.

Return value

true if the specified texture was successfully imported; otherwise, false.

bool ImportMaterial ( ImportProcessor processor, Material material, ImportMaterial import_material ) #

Imports the specified material and uses the specified processor to process and save the generated material to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• Material material - Target UNIGINE's material instance to store the specified imported material.
• ImportMaterial import_material - Instance of the ImportMaterial class.

Return value

true if the specified material was successfully imported; otherwise, false.

bool ImportMesh ( ImportProcessor processor, Mesh mesh, ImportMesh import_mesh ) #

Imports the specified mesh and uses the specified processor to process and save the generated mesh to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• Mesh mesh - Target UNIGINE's mesh instance to store the specified imported mesh.
• ImportMesh import_mesh - Instance of the ImportMesh class.

Return value

true if the specified mesh was successfully imported; otherwise, false.

Light ImportLight ( ImportProcessor processor, ImportLight import_light ) #

Imports the specified light and uses the specified processor to process and save the generated light to a corresponding *.node file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• ImportLight import_light - Instance of the ImportLight class.

Return value

UNIGINE's light instance that stores the specified imported light source.

Player ImportCamera ( ImportProcessor processor, ImportCamera import_camera ) #

Imports the specified camera and uses the specified processor to process and save the generated player to a corresponding *.node file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• ImportCamera import_camera - Instance of the ImportCamera class.

Return value

UNIGINE's player instance that stores the specified imported camera.

bool ImportAnimation ( ImportProcessor processor, MeshAnimation animation, ImportAnimation import_animation ) #

Imports the specified mesh animation and uses the specified processor to process and save the generated mesh animation to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• MeshAnimation animation - Target UNIGINE's mesh animation instance to store the specified imported mesh animation.
• ImportAnimation import_animation - Instance of the ImportAnimation class.

Return value

true if the specified animation was successfully imported; otherwise, false.

bool ImportAnimation ( ImportProcessor processor, MeshAnimation animation, ImportMesh import_mesh, ImportAnimation import_animation ) #

Imports the specified mesh animation and uses the specified processor to process and save the generated mesh animation to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• MeshAnimation animation - Target UNIGINE's mesh animation instance to store the specified imported mesh animation.
• ImportMesh import_mesh - Instance of the ImportMesh class.
• ImportAnimation import_animation - Instance of the ImportAnimation class.

Return value

true if the specified animation was successfully imported; otherwise, false.

bool CheckSupportedAnimation ( ImportMesh import_mesh, ImportAnimation import_animation ) #

Returns a value indicating if importing of the specified animation of the specified imported mesh is supported.

Arguments

• ImportMesh import_mesh - Instance of the ImportMesh class.
• ImportAnimation import_animation - Instance of the ImportAnimation class.

Return value

true if importing of the specified animation of the specified imported mesh is supported; otherwise, false.

Node ImportNode ( ImportProcessor processor, ImportNode import_node ) #

Imports the specified node and uses the specified processor to process and save the generated node to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• ImportNode import_node - Instance of the ImportNode class.

Return value

Target UNIGINE's node instance to store the specified imported node.

bool ImportNodeChild ( ImportProcessor processor, Node node_parent, ImportNode import_node_parent, Node node_child, ImportNode import_node_child ) #

Imports the specified parent node with the specified child node and uses the specified processor to process and save generated nodes to a corresponding file in the output directory specified in the Import() method.

Arguments

• ImportProcessor processor - Import processor to be used for this import operation.
• Node node_parent - Target UNIGINE's node instance to store the specified imported parent node.
• ImportNode import_node_parent - Instance of the ImportNode class for the parent node.
• Node node_child - Target UNIGINE's node instance to store the specified imported child node.
• ImportNode import_node_child - Instance of the ImportNode class for the child node.

Return value

true if the specified parent node along with the specified child node were successfully imported; otherwise, false.

bool Postprocess ( ) #

Starts execution of all added post-processors. Post-processors can be used to manage files generated in the process of import.

Return value

true if the post-processing is completed successfully.

bool GetBasis ( Importer.Axis up_axis, Importer.Axis front_axis, out dmat4 ret ) #

Returns the transformation matrix for the basis specified by axes.

Arguments

• Importer.Axis up_axis - Up axis of the basis.
• Importer.Axis front_axis - Front axis of the basis.
• out dmat4 ret - Transformation matrix for the basis specified by axes.

Return value

true the transformation matrix for the basis was successfully calculated; otherwise, false.

bool OnComputeBoundBox ( ImportMesh import_mesh ) #

Extendable method for custom bound box computation.

Arguments

• ImportMesh import_mesh - Imported mesh for which a bound box is to be calculated.

Return value

true if a bound box for the specified mesh was successfully calculated; otherwise, false.

bool OnInit ( ImportScene import_scene, string filepath ) #

Builds and initializes the imported scene based on the data contained in the specified input file.

Arguments

• ImportScene import_scene - Imported scene (built from the data contained in the specified input file).
• string filepath - Path to an input file to be imported.

Return value

true if the scene is successfully initialized using the data from the specified input file; otherwise, false.

bool OnImport ( string output_path ) #

Import event handler function. This function is called each time when the Import() function is called. You can specify your custom actions to be performed on scene import.

Arguments

• string output_path - Output path to be used to store generated file(s) with imported data.

Return value

true if import operation for the specified output path was successful; otherwise, false.

bool OnImportTexture ( ImportProcessor processor, ImportTexture import_texture ) #

Texture import event handler function. This function is called each time when the ImportTexture() function is called. You can specify your custom actions to be performed on texture import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• ImportTexture import_texture - Instance of the ImportTexture class.

Return value

true if the specified texture was successfully imported; otherwise, false.

bool OnImportMaterial ( ImportProcessor processor, Material material, ImportMaterial import_material ) #

Material import event handler function. This function is called each time when the ImportMaterial() function is called. You can specify your custom actions to be performed on material import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• Material material - Target UNIGINE's material instance to store the specified imported material.
• ImportMaterial import_material - Instance of the ImportMaterial class.

Return value

true if the specified material was successfully imported; otherwise, false.

Light OnImportLight ( ImportProcessor processor, ImportLight import_light ) #

Light import event handler function. This function is called each time when the ImportLight() function is called. You can specify your custom actions to be performed on light import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• ImportLight import_light - Instance of the ImportLight class.

Return value

UNIGINE's light instance that stores the specified imported light.

Player OnImportCamera ( ImportProcessor processor, ImportCamera import_camera ) #

Camera import event handler function. This function is called each time when the ImportCamera() function is called. You can specify your custom actions to be performed on camera import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• ImportCamera import_camera - Instance of the ImportCamera class.

Return value

UNIGINE's player instance that stores the specified imported camera.

bool OnImportMesh ( ImportProcessor processor, Mesh mesh, ImportMesh import_mesh ) #

Mesh import event handler function. This function is called each time when the ImportMesh() function is called. You can specify your custom actions to be performed on mesh import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• Mesh mesh - Target UNIGINE's mesh instance to store the specified imported mesh animation.
• ImportMesh import_mesh - Instance of the ImportMesh class.

Return value

true if the specified mesh was successfully imported; otherwise, false.

Node OnImportNode ( ImportProcessor processor, ImportNode import_node ) #

Node import event handler function. This function is called each time when the ImportNode() function is called. You can specify your custom actions to be performed on node import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• ImportNode import_node - Instance of the ImportNode class.

Return value

UNIGINE's node instance that stores the specified imported node.

bool OnImportNodeChild ( ImportProcessor processor, Node node_parent, ImportNode import_node_parent, Node node_child, ImportNode import_node_child ) #

Node import event handler function. This function is called each time when the ImportNodeChild() function is called. You can specify your custom actions to be performed on importing and processing node hierarchies (e.g. assigning properties to node children).

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• Node node_parent - Target UNIGINE's node instance to store the specified imported parent node.
• ImportNode import_node_parent - Instance of the ImportNode class for the parent node.
• Node node_child - Target UNIGINE's node instance to store the specified imported child node.
• ImportNode import_node_child - Instance of the ImportNode class for the child node.

Return value

true if the specified parent node and its child node animation were successfully imported; otherwise, false.

bool OnImportAnimation ( ImportProcessor processor, MeshAnimation animation, ImportAnimation import_animation ) #

Animation import event handler function. This function is called each time when the ImportAnimation() function is called. You can specify your custom actions to be performed on animation import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• MeshAnimation animation - Target UNIGINE's mesh animation instance to store the specified imported mesh animation.
• ImportAnimation import_animation - ImportAnimation structure pointer. The metadata for the animation that needs to be imported.

Return value

true if the specified mesh animation was successfully imported; otherwise, false.

bool OnImportAnimation ( ImportProcessor processor, MeshAnimation animation, ImportMesh import_mesh, ImportAnimation import_animation ) #

Animation import event handler function. This function is called each time when the ImportAnimation() function is called. You can specify your custom actions to be performed on animation import.

Arguments

• ImportProcessor processor - Import processor used for this import operation.
• MeshAnimation animation - Target UNIGINE's mesh animation instance to store the specified imported mesh animation.
• ImportMesh import_mesh - ImportMesh structure pointer. The metadata for the mesh that needs to be imported.
• ImportAnimation import_animation - ImportAnimation structure pointer. The metadata for the animation that needs to be imported.

Return value

true if the specified mesh animation was successfully imported; otherwise, false.

bool OnCheckSupportedAnimation ( ImportMesh import_mesh, ImportAnimation import_animation ) #

Animation import support check event handler function. This function is called each time when the CheckSupportedAnimation() function is called. You can specify your custom actions to be performed on animation import.

Arguments

• ImportMesh import_mesh - ImportMesh structure pointer. The metadata for the mesh that needs to be imported.
• ImportAnimation import_animation - ImportAnimation structure pointer. The metadata for the animation that needs to be imported.

Return value

true if importing of the specified mesh animation is supported; otherwise, false.