MRObjectSave.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>

Go to the source code of this file.

Typedefs
typedef struct MR_Object	MR_Object
typedef struct MR_ObjectSave_Settings	MR_ObjectSave_Settings
typedef struct MR_expected_void_std_string	MR_expected_void_std_string
typedef struct MR_std_function_void_from_const_std_filesystem_path_ref	MR_std_function_void_from_const_std_filesystem_path_ref

Functions
MRC_API MR_expected_void_std_string *	MR_ObjectSave_toAnySupportedSceneFormat (const MR_Object *object, const char *file, const char *file_end, const MR_ObjectSave_Settings *settings)
MRC_API MR_expected_void_std_string *	MR_ObjectSave_toAnySupportedFormat (const MR_Object *object, const char *file, const char *file_end, const MR_ObjectSave_Settings *settings)
MRC_API MR_expected_void_std_string *	MR_serializeObjectTree_4 (const MR_Object *object, const char *path, const char *path_end, MR_PassBy preCompress_pass_by, MR_std_function_void_from_const_std_filesystem_path_ref *preCompress, const MR_ObjectSave_Settings *settings)
	saves object subtree in given scene file (zip/mru)
MRC_API MR_expected_void_std_string *	MR_serializeObjectTree_3 (const MR_Object *object, const char *path, const char *path_end, const MR_ObjectSave_Settings *settings)

Typedef Documentation

MR_expected_void_std_string

typedef struct MR_expected_void_std_string MR_expected_void_std_string

MR_Object

typedef struct MR_Object MR_Object

MR_ObjectSave_Settings

typedef struct MR_ObjectSave_Settings MR_ObjectSave_Settings

MR_std_function_void_from_const_std_filesystem_path_ref

typedef struct MR_std_function_void_from_const_std_filesystem_path_ref MR_std_function_void_from_const_std_filesystem_path_ref

Function Documentation

MR_ObjectSave_toAnySupportedFormat()

MRC_API MR_expected_void_std_string * MR_ObjectSave_toAnySupportedFormat	(	const MR_Object *	object,
		const char *	file,
		const char *	file_end,
		const MR_ObjectSave_Settings *	settings )

save a scene object to a given file if the file format is scene-capable, saves all the object's entities otherwise, saves only merged entities of the corresponding type (mesh, polyline, point cloud, etc.) Generated from function MR::ObjectSave::toAnySupportedFormat. Parameter object can not be null. It is a single object. Parameter file is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.

MR_ObjectSave_toAnySupportedSceneFormat()

MRC_API MR_expected_void_std_string * MR_ObjectSave_toAnySupportedSceneFormat	(	const MR_Object *	object,
		const char *	file,
		const char *	file_end,
		const MR_ObjectSave_Settings *	settings )

save an object tree to a given file file format must be scene-capable Generated from function MR::ObjectSave::toAnySupportedSceneFormat. Parameter object can not be null. It is a single object. Parameter file is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.

MR_serializeObjectTree_3()

MRC_API MR_expected_void_std_string * MR_serializeObjectTree_3	(	const MR_Object *	object,
		const char *	path,
		const char *	path_end,
		const MR_ObjectSave_Settings *	settings )

Generated from function MR::serializeObjectTree. Parameter object can not be null. It is a single object. Parameter path is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.

MR_serializeObjectTree_4()

MRC_API MR_expected_void_std_string * MR_serializeObjectTree_4	(	const MR_Object *	object,
		const char *	path,
		const char *	path_end,
		MR_PassBy	preCompress_pass_by,
		MR_std_function_void_from_const_std_filesystem_path_ref *	preCompress,
		const MR_ObjectSave_Settings *	settings )

saves object subtree in given scene file (zip/mru)

format specification: children are saved under folder with name of their parent object all objects parameters are saved in one JSON file in the root folder

if preCompress is set, it is called before compression saving is controlled with Object::serializeModel_ and Object::serializeFields_ Generated from function MR::serializeObjectTree. Parameter object can not be null. It is a single object. Parameter path is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.