MRLinesLoadSettings.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_VertColors	MR_VertColors
typedef struct MR_std_function_bool_from_float	MR_std_function_bool_from_float
typedef struct MR_LinesLoadSettings	MR_LinesLoadSettings

Functions
MRC_API MR_VertColors *const *	MR_LinesLoadSettings_Get_colors (const MR_LinesLoadSettings *_this)
MRC_API void	MR_LinesLoadSettings_Set_colors (MR_LinesLoadSettings *_this, MR_VertColors *value)
MRC_API MR_VertColors **	MR_LinesLoadSettings_GetMutable_colors (MR_LinesLoadSettings *_this)
MRC_API const MR_std_function_bool_from_float *	MR_LinesLoadSettings_Get_callback (const MR_LinesLoadSettings *_this)
MRC_API void	MR_LinesLoadSettings_Set_callback (MR_LinesLoadSettings *_this, MR_PassBy value_pass_by, MR_std_function_bool_from_float *value)
MRC_API MR_std_function_bool_from_float *	MR_LinesLoadSettings_GetMutable_callback (MR_LinesLoadSettings *_this)
MRC_API const bool *	MR_LinesLoadSettings_Get_telemetrySignal (const MR_LinesLoadSettings *_this)
MRC_API void	MR_LinesLoadSettings_Set_telemetrySignal (MR_LinesLoadSettings *_this, bool value)
MRC_API bool *	MR_LinesLoadSettings_GetMutable_telemetrySignal (MR_LinesLoadSettings *_this)
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_DefaultConstruct (void)
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_DefaultConstructArray (size_t num_elems)
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_ConstructFrom (MR_VertColors *colors, MR_PassBy callback_pass_by, MR_std_function_bool_from_float *callback, bool telemetrySignal)
MRC_API const MR_LinesLoadSettings *	MR_LinesLoadSettings_OffsetPtr (const MR_LinesLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_OffsetMutablePtr (MR_LinesLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_ConstructFromAnother (MR_PassBy _other_pass_by, MR_LinesLoadSettings *_other)
MRC_API void	MR_LinesLoadSettings_Destroy (const MR_LinesLoadSettings *_this)
	Destroys a heap-allocated instance of MR_LinesLoadSettings. Does nothing if the pointer is null.
MRC_API void	MR_LinesLoadSettings_DestroyArray (const MR_LinesLoadSettings *_this)
	Destroys a heap-allocated array of MR_LinesLoadSettings. Does nothing if the pointer is null.
MRC_API MR_LinesLoadSettings *	MR_LinesLoadSettings_AssignFromAnother (MR_LinesLoadSettings *_this, MR_PassBy _other_pass_by, MR_LinesLoadSettings *_other)

Typedef Documentation

MR_LinesLoadSettings

typedef struct MR_LinesLoadSettings MR_LinesLoadSettings

setting for polyline loading from external format, and locations of optional output data Generated from class MR::LinesLoadSettings. 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). optional load artifact: per-vertex color map Returns a pointer to a member variable of class MR::LinesLoadSettings named colors. 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_std_function_bool_from_float

typedef struct MR_std_function_bool_from_float MR_std_function_bool_from_float

MR_VertColors

typedef struct MR_VertColors MR_VertColors

Function Documentation

MR_LinesLoadSettings_AssignFromAnother()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_AssignFromAnother	(	MR_LinesLoadSettings *	_this,
		MR_PassBy	_other_pass_by,
		MR_LinesLoadSettings *	_other )

Generated from method MR::LinesLoadSettings::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_LinesLoadSettings_ConstructFrom()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_ConstructFrom	(	MR_VertColors *	colors,
		MR_PassBy	callback_pass_by,
		MR_std_function_bool_from_float *	callback,
		bool	telemetrySignal )

Constructs MR::LinesLoadSettings elementwise. The reference to the parameter colors might be preserved in the constructed object. The reference to the parameter callback might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_LinesLoadSettings_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_LinesLoadSettings_ConstructFromAnother()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_LinesLoadSettings *	_other )

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

MR_LinesLoadSettings_DefaultConstruct()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_DefaultConstruct

(

void

)

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

MR_LinesLoadSettings_DefaultConstructArray()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_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_LinesLoadSettings_DestroyArray(). Use MR_LinesLoadSettings_OffsetMutablePtr() and MR_LinesLoadSettings_OffsetPtr() to access the array elements.

MR_LinesLoadSettings_Destroy()

MRC_API void MR_LinesLoadSettings_Destroy

(

const MR_LinesLoadSettings *

_this

)

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

MR_LinesLoadSettings_DestroyArray()

MRC_API void MR_LinesLoadSettings_DestroyArray

(

const MR_LinesLoadSettings *

_this

)

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

MR_LinesLoadSettings_Get_callback()

MRC_API const MR_std_function_bool_from_float * MR_LinesLoadSettings_Get_callback

(

const MR_LinesLoadSettings *

_this

)

callback for set progress and stop process Modifies a member variable of class MR::LinesLoadSettings named callback. 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 callback. When this function is called, this object will drop object references it had previously in callback.

MR_LinesLoadSettings_Get_colors()

MRC_API MR_VertColors *const * MR_LinesLoadSettings_Get_colors

(

const MR_LinesLoadSettings *

_this

)

optional load artifact: per-vertex color map Modifies a member variable of class MR::LinesLoadSettings named colors. 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 colors. When this function is called, this object will drop object references it had previously in colors.

MR_LinesLoadSettings_Get_telemetrySignal()

MRC_API const bool * MR_LinesLoadSettings_Get_telemetrySignal

(

const MR_LinesLoadSettings *

_this

)

permit telemetry signal about loading Modifies a member variable of class MR::LinesLoadSettings named telemetrySignal. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in telemetrySignal.

MR_LinesLoadSettings_GetMutable_callback()

MRC_API MR_std_function_bool_from_float * MR_LinesLoadSettings_GetMutable_callback

(

MR_LinesLoadSettings *

_this

)

permit telemetry signal about loading Returns a pointer to a member variable of class MR::LinesLoadSettings named telemetrySignal. 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_LinesLoadSettings_GetMutable_colors()

MRC_API MR_VertColors ** MR_LinesLoadSettings_GetMutable_colors

(

MR_LinesLoadSettings *

_this

)

callback for set progress and stop process Returns a pointer to a member variable of class MR::LinesLoadSettings named callback. 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_LinesLoadSettings_GetMutable_telemetrySignal()

MRC_API bool * MR_LinesLoadSettings_GetMutable_telemetrySignal

(

MR_LinesLoadSettings *

_this

)

MR_LinesLoadSettings_OffsetMutablePtr()

MRC_API MR_LinesLoadSettings * MR_LinesLoadSettings_OffsetMutablePtr	(	MR_LinesLoadSettings *	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_LinesLoadSettings_OffsetPtr()

MRC_API const MR_LinesLoadSettings * MR_LinesLoadSettings_OffsetPtr	(	const MR_LinesLoadSettings *	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_LinesLoadSettings_Set_callback()

MRC_API void MR_LinesLoadSettings_Set_callback	(	MR_LinesLoadSettings *	_this,
		MR_PassBy	value_pass_by,
		MR_std_function_bool_from_float *	value )

callback for set progress and stop process Returns a mutable pointer to a member variable of class MR::LinesLoadSettings named callback. 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_LinesLoadSettings_Set_colors()

MRC_API void MR_LinesLoadSettings_Set_colors	(	MR_LinesLoadSettings *	_this,
		MR_VertColors *	value )

optional load artifact: per-vertex color map Returns a mutable pointer to a member variable of class MR::LinesLoadSettings named colors. 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_LinesLoadSettings_Set_telemetrySignal()

MRC_API void MR_LinesLoadSettings_Set_telemetrySignal	(	MR_LinesLoadSettings *	_this,
		bool	value )

permit telemetry signal about loading Returns a mutable pointer to a member variable of class MR::LinesLoadSettings named telemetrySignal. 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.