MRAddNoise.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_Mesh	MR_Mesh
typedef struct MR_VertBitSet	MR_VertBitSet
typedef struct MR_VertCoords	MR_VertCoords
typedef struct MR_expected_void_std_string	MR_expected_void_std_string
typedef struct MR_std_function_bool_from_float	MR_std_function_bool_from_float
typedef struct MR_NoiseSettings	MR_NoiseSettings
	Generated from class MR::NoiseSettings.

Functions
MRC_API const float *	MR_NoiseSettings_Get_sigma (const MR_NoiseSettings *_this)
MRC_API void	MR_NoiseSettings_Set_sigma (MR_NoiseSettings *_this, float value)
MRC_API float *	MR_NoiseSettings_GetMutable_sigma (MR_NoiseSettings *_this)
MRC_API const unsigned int *	MR_NoiseSettings_Get_seed (const MR_NoiseSettings *_this)
MRC_API void	MR_NoiseSettings_Set_seed (MR_NoiseSettings *_this, unsigned int value)
MRC_API unsigned int *	MR_NoiseSettings_GetMutable_seed (MR_NoiseSettings *_this)
MRC_API const MR_std_function_bool_from_float *	MR_NoiseSettings_Get_callback (const MR_NoiseSettings *_this)
MRC_API void	MR_NoiseSettings_Set_callback (MR_NoiseSettings *_this, MR_PassBy value_pass_by, MR_std_function_bool_from_float *value)
MRC_API MR_std_function_bool_from_float *	MR_NoiseSettings_GetMutable_callback (MR_NoiseSettings *_this)
MRC_API MR_NoiseSettings *	MR_NoiseSettings_DefaultConstruct (void)
MRC_API MR_NoiseSettings *	MR_NoiseSettings_DefaultConstructArray (size_t num_elems)
MRC_API MR_NoiseSettings *	MR_NoiseSettings_ConstructFrom (float sigma, unsigned int seed, MR_PassBy callback_pass_by, MR_std_function_bool_from_float *callback)
MRC_API const MR_NoiseSettings *	MR_NoiseSettings_OffsetPtr (const MR_NoiseSettings *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.
MRC_API MR_NoiseSettings *	MR_NoiseSettings_OffsetMutablePtr (MR_NoiseSettings *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.
MRC_API MR_NoiseSettings *	MR_NoiseSettings_ConstructFromAnother (MR_PassBy _other_pass_by, MR_NoiseSettings *_other)
MRC_API void	MR_NoiseSettings_Destroy (const MR_NoiseSettings *_this)
	Destroys a heap-allocated instance of MR_NoiseSettings. Does nothing if the pointer is null.
MRC_API void	MR_NoiseSettings_DestroyArray (const MR_NoiseSettings *_this)
	Destroys a heap-allocated array of MR_NoiseSettings. Does nothing if the pointer is null.
MRC_API MR_NoiseSettings *	MR_NoiseSettings_AssignFromAnother (MR_NoiseSettings *_this, MR_PassBy _other_pass_by, MR_NoiseSettings *_other)
MRC_API MR_expected_void_std_string *	MR_addNoise_MR_VertCoords (MR_VertCoords *points, const MR_VertBitSet *validVerts, MR_PassBy settings_pass_by, MR_NoiseSettings *settings)
MRC_API MR_expected_void_std_string *	MR_addNoise_MR_Mesh (MR_Mesh *mesh, const MR_VertBitSet *region, const MR_NoiseSettings *settings)

Typedef Documentation

MR_expected_void_std_string

typedef struct MR_expected_void_std_string MR_expected_void_std_string

MR_Mesh

typedef struct MR_Mesh MR_Mesh

MR_NoiseSettings

typedef struct MR_NoiseSettings MR_NoiseSettings

Generated from class MR::NoiseSettings.

MR_std_function_bool_from_float

typedef struct MR_std_function_bool_from_float MR_std_function_bool_from_float

MR_VertBitSet

typedef struct MR_VertBitSet MR_VertBitSet

MR_VertCoords

typedef struct MR_VertCoords MR_VertCoords

Function Documentation

MR_addNoise_MR_Mesh()

MRC_API MR_expected_void_std_string * MR_addNoise_MR_Mesh	(	MR_Mesh *	mesh,
		const MR_VertBitSet *	region,
		const MR_NoiseSettings *	settings )

Generated from function MR::addNoise. Parameter mesh can not be null. It is a single object. Parameter region defaults to a null pointer in C++. 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_addNoise_MR_VertCoords()

MRC_API MR_expected_void_std_string * MR_addNoise_MR_VertCoords	(	MR_VertCoords *	points,
		const MR_VertBitSet *	validVerts,
		MR_PassBy	settings_pass_by,
		MR_NoiseSettings *	settings )

Generated from function MR::addNoise. Parameter points can not be null. It is a single object. Parameter validVerts can not be null. It is a single object. 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_NoiseSettings_AssignFromAnother()

MRC_API MR_NoiseSettings * MR_NoiseSettings_AssignFromAnother	(	MR_NoiseSettings *	_this,
		MR_PassBy	_other_pass_by,
		MR_NoiseSettings *	_other )

Generated from a method of class MR::NoiseSettings named operator=. 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_NoiseSettings_ConstructFrom()

MRC_API MR_NoiseSettings * MR_NoiseSettings_ConstructFrom	(	float	sigma,
		unsigned int	seed,
		MR_PassBy	callback_pass_by,
		MR_std_function_bool_from_float *	callback )

Constructs MR::NoiseSettings elementwise. Never returns null. Returns an instance allocated on the heap! Must call MR_NoiseSettings_Destroy() to free it when you're done using it.

MR_NoiseSettings_ConstructFromAnother()

MRC_API MR_NoiseSettings * MR_NoiseSettings_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_NoiseSettings *	_other )

Generated from a constructor of class MR::NoiseSettings. Never returns null. Returns an instance allocated on the heap! Must call MR_NoiseSettings_Destroy() to free it when you're done using it.

MR_NoiseSettings_DefaultConstruct()

MRC_API MR_NoiseSettings * MR_NoiseSettings_DefaultConstruct

(

void

)

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

MR_NoiseSettings_DefaultConstructArray()

MRC_API MR_NoiseSettings * MR_NoiseSettings_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_NoiseSettings_DestroyArray(). Use MR_NoiseSettings_OffsetMutablePtr() and MR_NoiseSettings_OffsetPtr() to access the array elements.

MR_NoiseSettings_Destroy()

MRC_API void MR_NoiseSettings_Destroy

(

const MR_NoiseSettings *

_this

)

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

MR_NoiseSettings_DestroyArray()

MRC_API void MR_NoiseSettings_DestroyArray

(

const MR_NoiseSettings *

_this

)

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

MR_NoiseSettings_Get_callback()

MRC_API const MR_std_function_bool_from_float * MR_NoiseSettings_Get_callback

(

const MR_NoiseSettings *

_this

)

Returns a pointer to a member variable of class MR::NoiseSettings 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_NoiseSettings_Get_seed()

MRC_API const unsigned int * MR_NoiseSettings_Get_seed

(

const MR_NoiseSettings *

_this

)

Returns a pointer to a member variable of class MR::NoiseSettings named seed. 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_NoiseSettings_Get_sigma()

MRC_API const float * MR_NoiseSettings_Get_sigma

(

const MR_NoiseSettings *

_this

)

Returns a pointer to a member variable of class MR::NoiseSettings named sigma. 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_NoiseSettings_GetMutable_callback()

MRC_API MR_std_function_bool_from_float * MR_NoiseSettings_GetMutable_callback

(

MR_NoiseSettings *

_this

)

Returns a mutable pointer to a member variable of class MR::NoiseSettings 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_NoiseSettings_GetMutable_seed()

MRC_API unsigned int * MR_NoiseSettings_GetMutable_seed

(

MR_NoiseSettings *

_this

)

Returns a mutable pointer to a member variable of class MR::NoiseSettings named seed. 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_NoiseSettings_GetMutable_sigma()

MRC_API float * MR_NoiseSettings_GetMutable_sigma

(

MR_NoiseSettings *

_this

)

Returns a mutable pointer to a member variable of class MR::NoiseSettings named sigma. 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_NoiseSettings_OffsetMutablePtr()

MRC_API MR_NoiseSettings * MR_NoiseSettings_OffsetMutablePtr	(	MR_NoiseSettings *	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.

MR_NoiseSettings_OffsetPtr()

MRC_API const MR_NoiseSettings * MR_NoiseSettings_OffsetPtr	(	const MR_NoiseSettings *	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.

MR_NoiseSettings_Set_callback()

MRC_API void MR_NoiseSettings_Set_callback	(	MR_NoiseSettings *	_this,
		MR_PassBy	value_pass_by,
		MR_std_function_bool_from_float *	value )

Modifies a member variable of class MR::NoiseSettings named callback. Parameter _this can not be null. It is a single object.

MR_NoiseSettings_Set_seed()

MRC_API void MR_NoiseSettings_Set_seed	(	MR_NoiseSettings *	_this,
		unsigned int	value )

Modifies a member variable of class MR::NoiseSettings named seed. Parameter _this can not be null. It is a single object.

MR_NoiseSettings_Set_sigma()

MRC_API void MR_NoiseSettings_Set_sigma	(	MR_NoiseSettings *	_this,
		float	value )

Modifies a member variable of class MR::NoiseSettings named sigma. Parameter _this can not be null. It is a single object.