MRSymbolMesh.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_TextMeshAlignParams	MR_TextMeshAlignParams
typedef struct MR_expected_MR_Mesh_std_string	MR_expected_MR_Mesh_std_string
typedef struct MR_expected_std_vector_std_vector_MR_Vector2f_std_string	MR_expected_std_vector_std_vector_MR_Vector2f_std_string
typedef struct MR_std_filesystem_path	MR_std_filesystem_path
typedef struct MR_std_string	MR_std_string
typedef enum MR_AlignType	MR_AlignType
typedef struct MR_SymbolMeshParams	MR_SymbolMeshParams

Enumerations
enum	MR_AlignType { MR_AlignType_Left = 0 , MR_AlignType_Center = 1 , MR_AlignType_Right = 2 }

Functions
MRC_API const float *	MR_SymbolMeshParams_Get_MaxGeneratedFontHeight (void)
MRC_API const MR_std_string *	MR_SymbolMeshParams_Get_text (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_text (MR_SymbolMeshParams *_this, const char *value, const char *value_end)
MRC_API MR_std_string *	MR_SymbolMeshParams_GetMutable_text (MR_SymbolMeshParams *_this)
MRC_API const int *	MR_SymbolMeshParams_Get_fontDetalization (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_fontDetalization (MR_SymbolMeshParams *_this, int value)
MRC_API int *	MR_SymbolMeshParams_GetMutable_fontDetalization (MR_SymbolMeshParams *_this)
MRC_API const MR_Vector2f *	MR_SymbolMeshParams_Get_symbolsDistanceAdditionalOffset (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_symbolsDistanceAdditionalOffset (MR_SymbolMeshParams *_this, MR_Vector2f value)
MRC_API MR_Vector2f *	MR_SymbolMeshParams_GetMutable_symbolsDistanceAdditionalOffset (MR_SymbolMeshParams *_this)
MRC_API const float *	MR_SymbolMeshParams_Get_symbolsThicknessOffsetModifier (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_symbolsThicknessOffsetModifier (MR_SymbolMeshParams *_this, float value)
MRC_API float *	MR_SymbolMeshParams_GetMutable_symbolsThicknessOffsetModifier (MR_SymbolMeshParams *_this)
MRC_API const MR_AlignType *	MR_SymbolMeshParams_Get_align (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_align (MR_SymbolMeshParams *_this, MR_AlignType value)
MRC_API MR_AlignType *	MR_SymbolMeshParams_GetMutable_align (MR_SymbolMeshParams *_this)
MRC_API const MR_std_filesystem_path *	MR_SymbolMeshParams_Get_pathToFontFile (const MR_SymbolMeshParams *_this)
MRC_API void	MR_SymbolMeshParams_Set_pathToFontFile (MR_SymbolMeshParams *_this, const char *value, const char *value_end)
MRC_API MR_std_filesystem_path *	MR_SymbolMeshParams_GetMutable_pathToFontFile (MR_SymbolMeshParams *_this)
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_DefaultConstruct (void)
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_DefaultConstructArray (size_t num_elems)
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_ConstructFrom (const char *text, const char *text_end, int fontDetalization, MR_Vector2f symbolsDistanceAdditionalOffset, float symbolsThicknessOffsetModifier, MR_AlignType align, const char *pathToFontFile, const char *pathToFontFile_end)
MRC_API const MR_SymbolMeshParams *	MR_SymbolMeshParams_OffsetPtr (const MR_SymbolMeshParams *ptr, ptrdiff_t i)
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_OffsetMutablePtr (MR_SymbolMeshParams *ptr, ptrdiff_t i)
MRC_API const MR_TextMeshAlignParams *	MR_SymbolMeshParams_StaticDowncastTo_MR_TextMeshAlignParams (const MR_SymbolMeshParams *object)
MRC_API MR_TextMeshAlignParams *	MR_SymbolMeshParams_MutableStaticDowncastTo_MR_TextMeshAlignParams (MR_SymbolMeshParams *object)
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_ConstructFromAnother (MR_PassBy _other_pass_by, MR_SymbolMeshParams *_other)
MRC_API void	MR_SymbolMeshParams_Destroy (const MR_SymbolMeshParams *_this)
	Destroys a heap-allocated instance of MR_SymbolMeshParams. Does nothing if the pointer is null.
MRC_API void	MR_SymbolMeshParams_DestroyArray (const MR_SymbolMeshParams *_this)
	Destroys a heap-allocated array of MR_SymbolMeshParams. Does nothing if the pointer is null.
MRC_API MR_SymbolMeshParams *	MR_SymbolMeshParams_AssignFromAnother (MR_SymbolMeshParams *_this, MR_PassBy _other_pass_by, MR_SymbolMeshParams *_other)
MRC_API MR_expected_std_vector_std_vector_MR_Vector2f_std_string *	MR_createSymbolContours (const MR_SymbolMeshParams *params)
MRC_API MR_expected_MR_Mesh_std_string *	MR_createSymbolsMesh (const MR_SymbolMeshParams *params)

Typedef Documentation

MR_AlignType

typedef enum MR_AlignType MR_AlignType

MR_expected_MR_Mesh_std_string

typedef struct MR_expected_MR_Mesh_std_string MR_expected_MR_Mesh_std_string

MR_expected_std_vector_std_vector_MR_Vector2f_std_string

typedef struct MR_expected_std_vector_std_vector_MR_Vector2f_std_string MR_expected_std_vector_std_vector_MR_Vector2f_std_string

MR_std_filesystem_path

typedef struct MR_std_filesystem_path MR_std_filesystem_path

MR_std_string

typedef struct MR_std_string MR_std_string

MR_SymbolMeshParams

typedef struct MR_SymbolMeshParams MR_SymbolMeshParams

Generated from class MR::SymbolMeshParams. Derived classes: Direct: (non-virtual) MR::TextMeshAlignParams 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_TextMeshAlignParams

typedef struct MR_TextMeshAlignParams MR_TextMeshAlignParams

Enumeration Type Documentation

MR_AlignType

enum MR_AlignType

Enumerator
MR_AlignType_Left
MR_AlignType_Center
MR_AlignType_Right

Function Documentation

MR_createSymbolContours()

MRC_API MR_expected_std_vector_std_vector_MR_Vector2f_std_string * MR_createSymbolContours

(

const MR_SymbolMeshParams *

params

)

Generated from function MR::createSymbolContours. Parameter params can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_std_vector_std_vector_MR_Vector2f_std_string_Destroy() to free it when you're done using it.

MR_createSymbolsMesh()

MRC_API MR_expected_MR_Mesh_std_string * MR_createSymbolsMesh

(

const MR_SymbolMeshParams *

params

)

Generated from function MR::createSymbolsMesh. Parameter params can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_MR_Mesh_std_string_Destroy() to free it when you're done using it.

MR_SymbolMeshParams_AssignFromAnother()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_AssignFromAnother	(	MR_SymbolMeshParams *	_this,
		MR_PassBy	_other_pass_by,
		MR_SymbolMeshParams *	_other )

Generated from method MR::SymbolMeshParams::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_SymbolMeshParams_ConstructFrom()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_ConstructFrom	(	const char *	text,
		const char *	text_end,
		int	fontDetalization,
		MR_Vector2f	symbolsDistanceAdditionalOffset,
		float	symbolsThicknessOffsetModifier,
		MR_AlignType	align,
		const char *	pathToFontFile,
		const char *	pathToFontFile_end )

Constructs MR::SymbolMeshParams elementwise. Parameter text can not be null. If text_end is null, then text is assumed to be null-terminated. The reference to the parameter text might be preserved in the constructed object. The reference to the parameter symbolsDistanceAdditionalOffset might be preserved in the constructed object. The reference to the parameter align might be preserved in the constructed object. Parameter pathToFontFile is a UTF-8 encoded filesystem path. The reference to the parameter pathToFontFile might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_SymbolMeshParams_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_SymbolMeshParams_ConstructFromAnother()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_SymbolMeshParams *	_other )

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

MR_SymbolMeshParams_DefaultConstruct()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_DefaultConstruct

(

void

)

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

MR_SymbolMeshParams_DefaultConstructArray()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_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_SymbolMeshParams_DestroyArray(). Use MR_SymbolMeshParams_OffsetMutablePtr() and MR_SymbolMeshParams_OffsetPtr() to access the array elements.

MR_SymbolMeshParams_Destroy()

MRC_API void MR_SymbolMeshParams_Destroy

(

const MR_SymbolMeshParams *

_this

)

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

MR_SymbolMeshParams_DestroyArray()

MRC_API void MR_SymbolMeshParams_DestroyArray

(

const MR_SymbolMeshParams *

_this

)

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

MR_SymbolMeshParams_Get_align()

MRC_API const MR_AlignType * MR_SymbolMeshParams_Get_align

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named align. 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_SymbolMeshParams_Get_fontDetalization()

MRC_API const int * MR_SymbolMeshParams_Get_fontDetalization

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named fontDetalization. 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_SymbolMeshParams_Get_MaxGeneratedFontHeight()

MRC_API const float * MR_SymbolMeshParams_Get_MaxGeneratedFontHeight

(

void

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named MaxGeneratedFontHeight. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_SymbolMeshParams_Get_pathToFontFile()

MRC_API const MR_std_filesystem_path * MR_SymbolMeshParams_Get_pathToFontFile

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named pathToFontFile. 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_SymbolMeshParams_Get_symbolsDistanceAdditionalOffset()

MRC_API const MR_Vector2f * MR_SymbolMeshParams_Get_symbolsDistanceAdditionalOffset

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named symbolsDistanceAdditionalOffset. 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_SymbolMeshParams_Get_symbolsThicknessOffsetModifier()

MRC_API const float * MR_SymbolMeshParams_Get_symbolsThicknessOffsetModifier

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named symbolsThicknessOffsetModifier. 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_SymbolMeshParams_Get_text()

MRC_API const MR_std_string * MR_SymbolMeshParams_Get_text

(

const MR_SymbolMeshParams *

_this

)

Returns a pointer to a member variable of class MR::SymbolMeshParams named text. 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_SymbolMeshParams_GetMutable_align()

MRC_API MR_AlignType * MR_SymbolMeshParams_GetMutable_align

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named align. 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_SymbolMeshParams_GetMutable_fontDetalization()

MRC_API int * MR_SymbolMeshParams_GetMutable_fontDetalization

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named fontDetalization. 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_SymbolMeshParams_GetMutable_pathToFontFile()

MRC_API MR_std_filesystem_path * MR_SymbolMeshParams_GetMutable_pathToFontFile

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named pathToFontFile. 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_SymbolMeshParams_GetMutable_symbolsDistanceAdditionalOffset()

MRC_API MR_Vector2f * MR_SymbolMeshParams_GetMutable_symbolsDistanceAdditionalOffset

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named symbolsDistanceAdditionalOffset. 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_SymbolMeshParams_GetMutable_symbolsThicknessOffsetModifier()

MRC_API float * MR_SymbolMeshParams_GetMutable_symbolsThicknessOffsetModifier

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named symbolsThicknessOffsetModifier. 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_SymbolMeshParams_GetMutable_text()

MRC_API MR_std_string * MR_SymbolMeshParams_GetMutable_text

(

MR_SymbolMeshParams *

_this

)

Returns a mutable pointer to a member variable of class MR::SymbolMeshParams named text. 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_SymbolMeshParams_MutableStaticDowncastTo_MR_TextMeshAlignParams()

MRC_API MR_TextMeshAlignParams * MR_SymbolMeshParams_MutableStaticDowncastTo_MR_TextMeshAlignParams

(

MR_SymbolMeshParams *

object

)

Downcasts an instance of MR::SymbolMeshParams to a derived class MR::TextMeshAlignParams. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise.

MR_SymbolMeshParams_OffsetMutablePtr()

MRC_API MR_SymbolMeshParams * MR_SymbolMeshParams_OffsetMutablePtr	(	MR_SymbolMeshParams *	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_SymbolMeshParams_OffsetPtr()

MRC_API const MR_SymbolMeshParams * MR_SymbolMeshParams_OffsetPtr	(	const MR_SymbolMeshParams *	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_SymbolMeshParams_Set_align()

MRC_API void MR_SymbolMeshParams_Set_align	(	MR_SymbolMeshParams *	_this,
		MR_AlignType	value )

Modifies a member variable of class MR::SymbolMeshParams named align. 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 align. When this function is called, this object will drop object references it had previously in align.

MR_SymbolMeshParams_Set_fontDetalization()

MRC_API void MR_SymbolMeshParams_Set_fontDetalization	(	MR_SymbolMeshParams *	_this,
		int	value )

Modifies a member variable of class MR::SymbolMeshParams named fontDetalization. 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 fontDetalization.

MR_SymbolMeshParams_Set_pathToFontFile()

MRC_API void MR_SymbolMeshParams_Set_pathToFontFile	(	MR_SymbolMeshParams *	_this,
		const char *	value,
		const char *	value_end )

Modifies a member variable of class MR::SymbolMeshParams named pathToFontFile. Parameter _this can not be null. It is a single object. Parameter value is a UTF-8 encoded filesystem path. The reference to the parameter value might be preserved in this object in element pathToFontFile. When this function is called, this object will drop object references it had previously in pathToFontFile.

MR_SymbolMeshParams_Set_symbolsDistanceAdditionalOffset()

MRC_API void MR_SymbolMeshParams_Set_symbolsDistanceAdditionalOffset	(	MR_SymbolMeshParams *	_this,
		MR_Vector2f	value )

Modifies a member variable of class MR::SymbolMeshParams named symbolsDistanceAdditionalOffset. 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 symbolsDistanceAdditionalOffset. When this function is called, this object will drop object references it had previously in symbolsDistanceAdditionalOffset.

MR_SymbolMeshParams_Set_symbolsThicknessOffsetModifier()

MRC_API void MR_SymbolMeshParams_Set_symbolsThicknessOffsetModifier	(	MR_SymbolMeshParams *	_this,
		float	value )

Modifies a member variable of class MR::SymbolMeshParams named symbolsThicknessOffsetModifier. 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 symbolsThicknessOffsetModifier.

MR_SymbolMeshParams_Set_text()

MRC_API void MR_SymbolMeshParams_Set_text	(	MR_SymbolMeshParams *	_this,
		const char *	value,
		const char *	value_end )

Modifies a member variable of class MR::SymbolMeshParams named text. 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 text. When this function is called, this object will drop object references it had previously in text.

MR_SymbolMeshParams_StaticDowncastTo_MR_TextMeshAlignParams()

MRC_API const MR_TextMeshAlignParams * MR_SymbolMeshParams_StaticDowncastTo_MR_TextMeshAlignParams

(

const MR_SymbolMeshParams *

object

)

Downcasts an instance of MR::SymbolMeshParams to a derived class MR::TextMeshAlignParams. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise. This version is acting on mutable pointers.