MRSymbolMesh.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRVector2.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_TextMeshAlignParams MR_TextMeshAlignParams; // Defined in `#include <MRCSymbolMesh/MRAlignTextToMesh.h>`.
typedef struct MR_expected_MR_Mesh_std_string MR_expected_MR_Mesh_std_string; // Defined in `#include <MRCMisc/expected_MR_Mesh_std_string.h>`.
typedef struct MR_expected_std_vector_std_vector_MR_Vector2f_std_string MR_expected_std_vector_std_vector_MR_Vector2f_std_string; // Defined in `#include <MRCMisc/expected_std_vector_std_vector_MR_Vector2f_std_string.h>`.
typedef struct MR_std_filesystem_path MR_std_filesystem_path; // Defined in `#include <MRCMisc/std_filesystem_path.h>`.
typedef struct MR_std_string MR_std_string; // Defined in `#include <MRCMisc/std_string.h>`.
 
 
typedef enum MR_AlignType
{
    MR_AlignType_Left = 0,
    MR_AlignType_Center = 1,
    MR_AlignType_Right = 2,
} MR_AlignType;
 
typedef struct MR_SymbolMeshParams MR_SymbolMeshParams;
 
// max font size with 128 << 6 FT_F26Dot6 font size
MRC_API const float *MR_SymbolMeshParams_Get_MaxGeneratedFontHeight(void);
 
// Text that will be made mesh
MRC_API const MR_std_string *MR_SymbolMeshParams_Get_text(const MR_SymbolMeshParams *_this);
 
// Text that will be made mesh
MRC_API void MR_SymbolMeshParams_Set_text(MR_SymbolMeshParams *_this, const char *value, const char *value_end);
 
// Text that will be made mesh
MRC_API MR_std_string *MR_SymbolMeshParams_GetMutable_text(MR_SymbolMeshParams *_this);
 
// Detailization of Bezier curves on font glyphs
MRC_API const int32_t *MR_SymbolMeshParams_Get_fontDetalization(const MR_SymbolMeshParams *_this);
 
// Detailization of Bezier curves on font glyphs
MRC_API void MR_SymbolMeshParams_Set_fontDetalization(MR_SymbolMeshParams *_this, int32_t value);
 
// Detailization of Bezier curves on font glyphs
MRC_API int32_t *MR_SymbolMeshParams_GetMutable_fontDetalization(MR_SymbolMeshParams *_this);
 
// Additional offset between symbols
// X: In symbol size: 1.0f adds one "space", 0.5 adds half "space".
// Y: In symbol size: 1.0f adds one base height, 0.5 adds half base height
MRC_API const MR_Vector2f *MR_SymbolMeshParams_Get_symbolsDistanceAdditionalOffset(const MR_SymbolMeshParams *_this);
 
// Additional offset between symbols
// X: In symbol size: 1.0f adds one "space", 0.5 adds half "space".
// Y: In symbol size: 1.0f adds one base height, 0.5 adds half base height
MRC_API void MR_SymbolMeshParams_Set_symbolsDistanceAdditionalOffset(MR_SymbolMeshParams *_this, MR_Vector2f value);
 
// Additional offset between symbols
// X: In symbol size: 1.0f adds one "space", 0.5 adds half "space".
// Y: In symbol size: 1.0f adds one base height, 0.5 adds half base height
MRC_API MR_Vector2f *MR_SymbolMeshParams_GetMutable_symbolsDistanceAdditionalOffset(MR_SymbolMeshParams *_this);
 
// Symbols thickness will be modified by this value (newThickness = modifier*baseSymbolHeight + defaultThickness)
// note: changing this to non-zero values cause costly calculations
MRC_API const float *MR_SymbolMeshParams_Get_symbolsThicknessOffsetModifier(const MR_SymbolMeshParams *_this);
 
// Symbols thickness will be modified by this value (newThickness = modifier*baseSymbolHeight + defaultThickness)
// note: changing this to non-zero values cause costly calculations
MRC_API void MR_SymbolMeshParams_Set_symbolsThicknessOffsetModifier(MR_SymbolMeshParams *_this, float value);
 
// Symbols thickness will be modified by this value (newThickness = modifier*baseSymbolHeight + defaultThickness)
// note: changing this to non-zero values cause costly calculations
MRC_API float *MR_SymbolMeshParams_GetMutable_symbolsThicknessOffsetModifier(MR_SymbolMeshParams *_this);
 
// alignment of the text inside bbox
MRC_API const MR_AlignType *MR_SymbolMeshParams_Get_align(const MR_SymbolMeshParams *_this);
 
// alignment of the text inside bbox
MRC_API void MR_SymbolMeshParams_Set_align(MR_SymbolMeshParams *_this, MR_AlignType value);
 
// alignment of the text inside bbox
MRC_API MR_AlignType *MR_SymbolMeshParams_GetMutable_align(MR_SymbolMeshParams *_this);
 
// Path to font file
MRC_API const MR_std_filesystem_path *MR_SymbolMeshParams_Get_pathToFontFile(const MR_SymbolMeshParams *_this);
 
// Path to font file
MRC_API void MR_SymbolMeshParams_Set_pathToFontFile(MR_SymbolMeshParams *_this, const char *value, const char *value_end);
 
// Path to font file
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, int32_t 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);
 
MRC_API void MR_SymbolMeshParams_DestroyArray(const MR_SymbolMeshParams *_this);
 
MRC_API MR_SymbolMeshParams *MR_SymbolMeshParams_AssignFromAnother(MR_SymbolMeshParams *_this, MR_PassBy _other_pass_by, MR_SymbolMeshParams *_other);
 
// converts text string into set of contours
MRC_API MR_expected_std_vector_std_vector_MR_Vector2f_std_string *MR_createSymbolContours(const MR_SymbolMeshParams *params);
 
// converts text string into Z-facing symbol mesh
MRC_API MR_expected_MR_Mesh_std_string *MR_createSymbolsMesh(const MR_SymbolMeshParams *params);
 
#ifdef __cplusplus
} // extern "C"
#endif