MRObjectSaveSettings.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_function_bool_from_float	MR_std_function_bool_from_float
typedef struct MR_std_optional_MR_LengthUnit	MR_std_optional_MR_LengthUnit
typedef struct MR_ObjectSave_Settings	MR_ObjectSave_Settings

Functions
MRC_API const MR_std_optional_MR_LengthUnit *	MR_ObjectSave_Settings_Get_lengthUnit (const MR_ObjectSave_Settings *_this)
MRC_API void	MR_ObjectSave_Settings_Set_lengthUnit (MR_ObjectSave_Settings *_this, const MR_LengthUnit *value)
MRC_API MR_std_optional_MR_LengthUnit *	MR_ObjectSave_Settings_GetMutable_lengthUnit (MR_ObjectSave_Settings *_this)
MRC_API const MR_std_function_bool_from_float *	MR_ObjectSave_Settings_Get_progress (const MR_ObjectSave_Settings *_this)
MRC_API void	MR_ObjectSave_Settings_Set_progress (MR_ObjectSave_Settings *_this, MR_PassBy value_pass_by, MR_std_function_bool_from_float *value)
MRC_API MR_std_function_bool_from_float *	MR_ObjectSave_Settings_GetMutable_progress (MR_ObjectSave_Settings *_this)
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_DefaultConstruct (void)
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_DefaultConstructArray (size_t num_elems)
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_ConstructFrom (const MR_LengthUnit *lengthUnit, MR_PassBy progress_pass_by, MR_std_function_bool_from_float *progress)
MRC_API const MR_ObjectSave_Settings *	MR_ObjectSave_Settings_OffsetPtr (const MR_ObjectSave_Settings *ptr, ptrdiff_t i)
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_OffsetMutablePtr (MR_ObjectSave_Settings *ptr, ptrdiff_t i)
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_ConstructFromAnother (MR_PassBy _other_pass_by, MR_ObjectSave_Settings *_other)
MRC_API void	MR_ObjectSave_Settings_Destroy (const MR_ObjectSave_Settings *_this)
	Destroys a heap-allocated instance of MR_ObjectSave_Settings. Does nothing if the pointer is null.
MRC_API void	MR_ObjectSave_Settings_DestroyArray (const MR_ObjectSave_Settings *_this)
	Destroys a heap-allocated array of MR_ObjectSave_Settings. Does nothing if the pointer is null.
MRC_API MR_ObjectSave_Settings *	MR_ObjectSave_Settings_AssignFromAnother (MR_ObjectSave_Settings *_this, MR_PassBy _other_pass_by, MR_ObjectSave_Settings *_other)

Typedef Documentation

MR_ObjectSave_Settings

typedef struct MR_ObjectSave_Settings MR_ObjectSave_Settings

Generated from class MR::ObjectSave::Settings. 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).

MR_std_function_bool_from_float

typedef struct MR_std_function_bool_from_float MR_std_function_bool_from_float

MR_std_optional_MR_LengthUnit

typedef struct MR_std_optional_MR_LengthUnit MR_std_optional_MR_LengthUnit

Function Documentation

MR_ObjectSave_Settings_AssignFromAnother()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_AssignFromAnother	(	MR_ObjectSave_Settings *	_this,
		MR_PassBy	_other_pass_by,
		MR_ObjectSave_Settings *	_other )

Generated from method MR::ObjectSave::Settings::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 had previously.

MR_ObjectSave_Settings_ConstructFrom()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_ConstructFrom	(	const MR_LengthUnit *	lengthUnit,
		MR_PassBy	progress_pass_by,
		MR_std_function_bool_from_float *	progress )

Constructs MR::ObjectSave::Settings elementwise. Parameter lengthUnit is optional. To keep it empty, pass a null pointer. The reference to the parameter lengthUnit might be preserved in the constructed object. The reference to the parameter progress might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ObjectSave_Settings_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_ObjectSave_Settings_ConstructFromAnother()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_ObjectSave_Settings *	_other )

Generated from constructor MR::ObjectSave::Settings::Settings. 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_ObjectSave_Settings_Destroy() to free it when you're done using it.

MR_ObjectSave_Settings_DefaultConstruct()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_DefaultConstruct

(

void

)

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

MR_ObjectSave_Settings_DefaultConstructArray()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_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_ObjectSave_Settings_DestroyArray(). Use MR_ObjectSave_Settings_OffsetMutablePtr() and MR_ObjectSave_Settings_OffsetPtr() to access the array elements.

MR_ObjectSave_Settings_Destroy()

MRC_API void MR_ObjectSave_Settings_Destroy

(

const MR_ObjectSave_Settings *

_this

)

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

MR_ObjectSave_Settings_DestroyArray()

MRC_API void MR_ObjectSave_Settings_DestroyArray

(

const MR_ObjectSave_Settings *

_this

)

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

MR_ObjectSave_Settings_Get_lengthUnit()

MRC_API const MR_std_optional_MR_LengthUnit * MR_ObjectSave_Settings_Get_lengthUnit

(

const MR_ObjectSave_Settings *

_this

)

units of input coordinates and transformation, to be serialized if the format supports it Returns a pointer to a member variable of class MR::ObjectSave::Settings named lengthUnit. 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.

MR_ObjectSave_Settings_Get_progress()

MRC_API const MR_std_function_bool_from_float * MR_ObjectSave_Settings_Get_progress

(

const MR_ObjectSave_Settings *

_this

)

to report loading progress and allow the user to cancel it Returns a pointer to a member variable of class MR::ObjectSave::Settings named progress. 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.

MR_ObjectSave_Settings_GetMutable_lengthUnit()

MRC_API MR_std_optional_MR_LengthUnit * MR_ObjectSave_Settings_GetMutable_lengthUnit

(

MR_ObjectSave_Settings *

_this

)

units of input coordinates and transformation, to be serialized if the format supports it Returns a mutable pointer to a member variable of class MR::ObjectSave::Settings named lengthUnit. 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.

MR_ObjectSave_Settings_GetMutable_progress()

MRC_API MR_std_function_bool_from_float * MR_ObjectSave_Settings_GetMutable_progress

(

MR_ObjectSave_Settings *

_this

)

to report loading progress and allow the user to cancel it Returns a mutable pointer to a member variable of class MR::ObjectSave::Settings named progress. 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.

MR_ObjectSave_Settings_OffsetMutablePtr()

MRC_API MR_ObjectSave_Settings * MR_ObjectSave_Settings_OffsetMutablePtr	(	MR_ObjectSave_Settings *	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_ObjectSave_Settings_OffsetPtr()

MRC_API const MR_ObjectSave_Settings * MR_ObjectSave_Settings_OffsetPtr	(	const MR_ObjectSave_Settings *	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_ObjectSave_Settings_Set_lengthUnit()

MRC_API void MR_ObjectSave_Settings_Set_lengthUnit	(	MR_ObjectSave_Settings *	_this,
		const MR_LengthUnit *	value )

units of input coordinates and transformation, to be serialized if the format supports it Modifies a member variable of class MR::ObjectSave::Settings named lengthUnit. Parameter _this can not be null. It is a single object. Parameter value is optional. To keep it empty, pass a null pointer. The reference to the parameter value might be preserved in this object in element lengthUnit. When this function is called, this object will drop object references it had previously in lengthUnit.

MR_ObjectSave_Settings_Set_progress()

MRC_API void MR_ObjectSave_Settings_Set_progress	(	MR_ObjectSave_Settings *	_this,
		MR_PassBy	value_pass_by,
		MR_std_function_bool_from_float *	value )

to report loading progress and allow the user to cancel it Modifies a member variable of class MR::ObjectSave::Settings named progress. Parameter _this can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element progress. When this function is called, this object will drop object references it had previously in progress.