MRMultiScanLoad.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_PointsLoad_MultiScanLoadSettings	MR_PointsLoad_MultiScanLoadSettings

Functions
MRC_API const MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_Get_posePrefix (const MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API void	MR_PointsLoad_MultiScanLoadSettings_Set_posePrefix (MR_PointsLoad_MultiScanLoadSettings *_this, const char *value, const char *value_end)
MRC_API MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_GetMutable_posePrefix (MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API const MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_Get_poseExt (const MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API void	MR_PointsLoad_MultiScanLoadSettings_Set_poseExt (MR_PointsLoad_MultiScanLoadSettings *_this, const char *value, const char *value_end)
MRC_API MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_GetMutable_poseExt (MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API const MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_Get_scanPrefix (const MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API void	MR_PointsLoad_MultiScanLoadSettings_Set_scanPrefix (MR_PointsLoad_MultiScanLoadSettings *_this, const char *value, const char *value_end)
MRC_API MR_std_string *	MR_PointsLoad_MultiScanLoadSettings_GetMutable_scanPrefix (MR_PointsLoad_MultiScanLoadSettings *_this)
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_DefaultConstruct (void)
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_DefaultConstructArray (size_t num_elems)
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_ConstructFrom (const char *posePrefix, const char *posePrefix_end, const char *poseExt, const char *poseExt_end, const char *scanPrefix, const char *scanPrefix_end)
MRC_API const MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_OffsetPtr (const MR_PointsLoad_MultiScanLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_OffsetMutablePtr (MR_PointsLoad_MultiScanLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_ConstructFromAnother (MR_PassBy _other_pass_by, MR_PointsLoad_MultiScanLoadSettings *_other)
MRC_API void	MR_PointsLoad_MultiScanLoadSettings_Destroy (const MR_PointsLoad_MultiScanLoadSettings *_this)
	Destroys a heap-allocated instance of MR_PointsLoad_MultiScanLoadSettings. Does nothing if the pointer is null.
MRC_API void	MR_PointsLoad_MultiScanLoadSettings_DestroyArray (const MR_PointsLoad_MultiScanLoadSettings *_this)
	Destroys a heap-allocated array of MR_PointsLoad_MultiScanLoadSettings. Does nothing if the pointer is null.
MRC_API MR_PointsLoad_MultiScanLoadSettings *	MR_PointsLoad_MultiScanLoadSettings_AssignFromAnother (MR_PointsLoad_MultiScanLoadSettings *_this, MR_PassBy _other_pass_by, MR_PointsLoad_MultiScanLoadSettings *_other)
MRC_API MR_expected_MR_PointCloud_std_string *	MR_PointsLoad_fromMultiScanFolder (const char *folder, const char *folder_end, const MR_PointsLoad_MultiScanLoadSettings *settings, const MR_std_function_bool_from_float *callback)

Typedef Documentation

MR_PointsLoad_MultiScanLoadSettings

typedef struct MR_PointsLoad_MultiScanLoadSettings MR_PointsLoad_MultiScanLoadSettings

parameters of fromMultiScanFolder Generated from class MR::PointsLoad::MultiScanLoadSettings. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_PointsLoad_fromMultiScanFolder()

MRC_API MR_expected_MR_PointCloud_std_string * MR_PointsLoad_fromMultiScanFolder	(	const char *	folder,
		const char *	folder_end,
		const MR_PointsLoad_MultiScanLoadSettings *	settings,
		const MR_std_function_bool_from_float *	callback )

loads and merges a point cloud from a folder with the results of a multi-scan capture: the folder is expected to contain pairs of files named <posePrefix>NNN<poseExt> and <scanPrefix>NNN.ply with matching indices NNN (the number of pairs is arbitrary); each transformation file stores a 4x4 row-major rigid transformation, which is applied to the points (and normals) loaded from the .ply file with the same index;

Returns

the union of all transformed points from all found pairs, expressed in the common coordinate frame Generated from function MR::PointsLoad::fromMultiScanFolder. Parameter folder 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. Parameter callback is a single object. Parameter callback 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_MR_PointCloud_std_string_Destroy() to free it when you're done using it.

MR_PointsLoad_MultiScanLoadSettings_AssignFromAnother()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_AssignFromAnother	(	MR_PointsLoad_MultiScanLoadSettings *	_this,
		MR_PassBy	_other_pass_by,
		MR_PointsLoad_MultiScanLoadSettings *	_other )

Generated from method MR::PointsLoad::MultiScanLoadSettings::operator=. Parameter _this can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it held previously.

MR_PointsLoad_MultiScanLoadSettings_ConstructFrom()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_ConstructFrom	(	const char *	posePrefix,
		const char *	posePrefix_end,
		const char *	poseExt,
		const char *	poseExt_end,
		const char *	scanPrefix,
		const char *	scanPrefix_end )

Constructs MR::PointsLoad::MultiScanLoadSettings elementwise. Parameter posePrefix can not be null. If posePrefix_end is null, then posePrefix is assumed to be null-terminated. The reference to the parameter posePrefix might be preserved in the constructed object. Parameter poseExt can not be null. If poseExt_end is null, then poseExt is assumed to be null-terminated. The reference to the parameter poseExt might be preserved in the constructed object. Parameter scanPrefix can not be null. If scanPrefix_end is null, then scanPrefix is assumed to be null-terminated. The reference to the parameter scanPrefix might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_PointsLoad_MultiScanLoadSettings_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.

MR_PointsLoad_MultiScanLoadSettings_ConstructFromAnother()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_PointsLoad_MultiScanLoadSettings *	_other )

Generated from constructor MR::PointsLoad::MultiScanLoadSettings::MultiScanLoadSettings. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_PointsLoad_MultiScanLoadSettings_Destroy() to free it when you're done using it.

MR_PointsLoad_MultiScanLoadSettings_DefaultConstruct()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_PointsLoad_MultiScanLoadSettings_Destroy() to free it when you're done using it.

MR_PointsLoad_MultiScanLoadSettings_DefaultConstructArray()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_PointsLoad_MultiScanLoadSettings_DestroyArray(). Use MR_PointsLoad_MultiScanLoadSettings_OffsetMutablePtr() and MR_PointsLoad_MultiScanLoadSettings_OffsetPtr() to access the array elements.

MR_PointsLoad_MultiScanLoadSettings_Destroy()

MRC_API void MR_PointsLoad_MultiScanLoadSettings_Destroy

(

const MR_PointsLoad_MultiScanLoadSettings *

_this

)

Destroys a heap-allocated instance of MR_PointsLoad_MultiScanLoadSettings. Does nothing if the pointer is null.

MR_PointsLoad_MultiScanLoadSettings_DestroyArray()

MRC_API void MR_PointsLoad_MultiScanLoadSettings_DestroyArray

(

const MR_PointsLoad_MultiScanLoadSettings *

_this

)

Destroys a heap-allocated array of MR_PointsLoad_MultiScanLoadSettings. Does nothing if the pointer is null.

MR_PointsLoad_MultiScanLoadSettings_Get_poseExt()

MRC_API const MR_std_string * MR_PointsLoad_MultiScanLoadSettings_Get_poseExt

(

const MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name extension of the transformation files, each storing a 4x4 row-major transformation Returns a pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named poseExt. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_Get_posePrefix()

MRC_API const MR_std_string * MR_PointsLoad_MultiScanLoadSettings_Get_posePrefix

(

const MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name prefix (before the numeric index) of the transformation files Returns a pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named posePrefix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_Get_scanPrefix()

MRC_API const MR_std_string * MR_PointsLoad_MultiScanLoadSettings_Get_scanPrefix

(

const MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name prefix (before the numeric index) of the .ply files, each storing the points of one scan Returns a pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named scanPrefix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_GetMutable_poseExt()

MRC_API MR_std_string * MR_PointsLoad_MultiScanLoadSettings_GetMutable_poseExt

(

MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name extension of the transformation files, each storing a 4x4 row-major transformation Returns a mutable pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named poseExt. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_GetMutable_posePrefix()

MRC_API MR_std_string * MR_PointsLoad_MultiScanLoadSettings_GetMutable_posePrefix

(

MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name prefix (before the numeric index) of the transformation files Returns a mutable pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named posePrefix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_GetMutable_scanPrefix()

MRC_API MR_std_string * MR_PointsLoad_MultiScanLoadSettings_GetMutable_scanPrefix

(

MR_PointsLoad_MultiScanLoadSettings *

_this

)

file name prefix (before the numeric index) of the .ply files, each storing the points of one scan Returns a mutable pointer to a member variable of class MR::PointsLoad::MultiScanLoadSettings named scanPrefix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

MR_PointsLoad_MultiScanLoadSettings_OffsetMutablePtr()

MRC_API MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_OffsetMutablePtr	(	MR_PointsLoad_MultiScanLoadSettings *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_PointsLoad_MultiScanLoadSettings_OffsetPtr()

MRC_API const MR_PointsLoad_MultiScanLoadSettings * MR_PointsLoad_MultiScanLoadSettings_OffsetPtr	(	const MR_PointsLoad_MultiScanLoadSettings *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_PointsLoad_MultiScanLoadSettings_Set_poseExt()

MRC_API void MR_PointsLoad_MultiScanLoadSettings_Set_poseExt	(	MR_PointsLoad_MultiScanLoadSettings *	_this,
		const char *	value,
		const char *	value_end )

file name extension of the transformation files, each storing a 4x4 row-major transformation Modifies a member variable of class MR::PointsLoad::MultiScanLoadSettings named poseExt. Parameter _this can not be null. It is a single object. Parameter value can not be null. If value_end is null, then value is assumed to be null-terminated. The reference to the parameter value might be preserved in this object in element poseExt. When this function is called, this object will drop object references it held previously in poseExt.

MR_PointsLoad_MultiScanLoadSettings_Set_posePrefix()

MRC_API void MR_PointsLoad_MultiScanLoadSettings_Set_posePrefix	(	MR_PointsLoad_MultiScanLoadSettings *	_this,
		const char *	value,
		const char *	value_end )

file name prefix (before the numeric index) of the transformation files Modifies a member variable of class MR::PointsLoad::MultiScanLoadSettings named posePrefix. Parameter _this can not be null. It is a single object. Parameter value can not be null. If value_end is null, then value is assumed to be null-terminated. The reference to the parameter value might be preserved in this object in element posePrefix. When this function is called, this object will drop object references it held previously in posePrefix.

MR_PointsLoad_MultiScanLoadSettings_Set_scanPrefix()

MRC_API void MR_PointsLoad_MultiScanLoadSettings_Set_scanPrefix	(	MR_PointsLoad_MultiScanLoadSettings *	_this,
		const char *	value,
		const char *	value_end )

file name prefix (before the numeric index) of the .ply files, each storing the points of one scan Modifies a member variable of class MR::PointsLoad::MultiScanLoadSettings named scanPrefix. Parameter _this can not be null. It is a single object. Parameter value can not be null. If value_end is null, then value is assumed to be null-terminated. The reference to the parameter value might be preserved in this object in element scanPrefix. When this function is called, this object will drop object references it held previously in scanPrefix.