MRAlignTextToMesh.h File Reference

#include <MRCMesh/MRVector2.h>
#include <MRCMesh/MRVector3.h>
#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_Mesh	MR_Mesh
typedef struct MR_MeshTriPoint	MR_MeshTriPoint
typedef struct MR_SymbolMeshParams	MR_SymbolMeshParams
typedef struct MR_expected_MR_Mesh_std_string	MR_expected_MR_Mesh_std_string
typedef struct MR_TextMeshAlignParams	MR_TextMeshAlignParams

Functions
MRC_API const MR_MeshTriPoint *	MR_TextMeshAlignParams_Get_startPoint (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_startPoint (MR_TextMeshAlignParams *_this, const MR_MeshTriPoint *value)
MRC_API MR_MeshTriPoint *	MR_TextMeshAlignParams_GetMutable_startPoint (MR_TextMeshAlignParams *_this)
MRC_API const MR_Vector2f *	MR_TextMeshAlignParams_Get_pivotPoint (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_pivotPoint (MR_TextMeshAlignParams *_this, MR_Vector2f value)
MRC_API MR_Vector2f *	MR_TextMeshAlignParams_GetMutable_pivotPoint (MR_TextMeshAlignParams *_this)
MRC_API const MR_Vector3f *	MR_TextMeshAlignParams_Get_direction (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_direction (MR_TextMeshAlignParams *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_TextMeshAlignParams_GetMutable_direction (MR_TextMeshAlignParams *_this)
MRC_API const MR_Vector3f *const *	MR_TextMeshAlignParams_Get_textNormal (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_textNormal (MR_TextMeshAlignParams *_this, const MR_Vector3f *value)
MRC_API const MR_Vector3f **	MR_TextMeshAlignParams_GetMutable_textNormal (MR_TextMeshAlignParams *_this)
MRC_API const float *	MR_TextMeshAlignParams_Get_fontHeight (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_fontHeight (MR_TextMeshAlignParams *_this, float value)
MRC_API float *	MR_TextMeshAlignParams_GetMutable_fontHeight (MR_TextMeshAlignParams *_this)
MRC_API const float *	MR_TextMeshAlignParams_Get_surfaceOffset (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_surfaceOffset (MR_TextMeshAlignParams *_this, float value)
MRC_API float *	MR_TextMeshAlignParams_GetMutable_surfaceOffset (MR_TextMeshAlignParams *_this)
MRC_API const float *	MR_TextMeshAlignParams_Get_textMaximumMovement (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_textMaximumMovement (MR_TextMeshAlignParams *_this, float value)
MRC_API float *	MR_TextMeshAlignParams_GetMutable_textMaximumMovement (MR_TextMeshAlignParams *_this)
MRC_API const bool *	MR_TextMeshAlignParams_Get_fontBasedSizeCalc (const MR_TextMeshAlignParams *_this)
MRC_API void	MR_TextMeshAlignParams_Set_fontBasedSizeCalc (MR_TextMeshAlignParams *_this, bool value)
MRC_API bool *	MR_TextMeshAlignParams_GetMutable_fontBasedSizeCalc (MR_TextMeshAlignParams *_this)
MRC_API MR_TextMeshAlignParams *	MR_TextMeshAlignParams_DefaultConstruct (void)
MRC_API MR_TextMeshAlignParams *	MR_TextMeshAlignParams_DefaultConstructArray (size_t num_elems)
MRC_API const MR_TextMeshAlignParams *	MR_TextMeshAlignParams_OffsetPtr (const MR_TextMeshAlignParams *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_TextMeshAlignParams *	MR_TextMeshAlignParams_OffsetMutablePtr (MR_TextMeshAlignParams *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 const MR_SymbolMeshParams *	MR_TextMeshAlignParams_UpcastTo_MR_SymbolMeshParams (const MR_TextMeshAlignParams *object)
MRC_API MR_SymbolMeshParams *	MR_TextMeshAlignParams_MutableUpcastTo_MR_SymbolMeshParams (MR_TextMeshAlignParams *object)
	Upcasts an instance of MR::TextMeshAlignParams to its base class MR::SymbolMeshParams.
MRC_API MR_TextMeshAlignParams *	MR_TextMeshAlignParams_ConstructFromAnother (MR_PassBy _other_pass_by, MR_TextMeshAlignParams *_other)
MRC_API void	MR_TextMeshAlignParams_Destroy (const MR_TextMeshAlignParams *_this)
	Destroys a heap-allocated instance of MR_TextMeshAlignParams. Does nothing if the pointer is null.
MRC_API void	MR_TextMeshAlignParams_DestroyArray (const MR_TextMeshAlignParams *_this)
	Destroys a heap-allocated array of MR_TextMeshAlignParams. Does nothing if the pointer is null.
MRC_API MR_TextMeshAlignParams *	MR_TextMeshAlignParams_AssignFromAnother (MR_TextMeshAlignParams *_this, MR_PassBy _other_pass_by, MR_TextMeshAlignParams *_other)
MRC_API MR_expected_MR_Mesh_std_string *	MR_alignTextToMesh (const MR_Mesh *mesh, const MR_TextMeshAlignParams *params)

Typedef Documentation

MR_expected_MR_Mesh_std_string

typedef struct MR_expected_MR_Mesh_std_string MR_expected_MR_Mesh_std_string

MR_Mesh

typedef struct MR_Mesh MR_Mesh

MR_MeshTriPoint

typedef struct MR_MeshTriPoint MR_MeshTriPoint

MR_SymbolMeshParams

typedef struct MR_SymbolMeshParams MR_SymbolMeshParams

MR_TextMeshAlignParams

typedef struct MR_TextMeshAlignParams MR_TextMeshAlignParams

Generated from class MR::TextMeshAlignParams. Base classes: Direct: (non-virtual) MR::SymbolMeshParams

Function Documentation

MR_alignTextToMesh()

MRC_API MR_expected_MR_Mesh_std_string * MR_alignTextToMesh	(	const MR_Mesh *	mesh,
		const MR_TextMeshAlignParams *	params )

Generated from function MR::alignTextToMesh. Parameter mesh can not be null. It is a single object. 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_TextMeshAlignParams_AssignFromAnother()

MRC_API MR_TextMeshAlignParams * MR_TextMeshAlignParams_AssignFromAnother	(	MR_TextMeshAlignParams *	_this,
		MR_PassBy	_other_pass_by,
		MR_TextMeshAlignParams *	_other )

Generated from a method of class MR::TextMeshAlignParams 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_TextMeshAlignParams_ConstructFromAnother()

MRC_API MR_TextMeshAlignParams * MR_TextMeshAlignParams_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_TextMeshAlignParams *	_other )

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

MR_TextMeshAlignParams_DefaultConstruct()

MRC_API MR_TextMeshAlignParams * MR_TextMeshAlignParams_DefaultConstruct

(

void

)

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

MR_TextMeshAlignParams_DefaultConstructArray()

MRC_API MR_TextMeshAlignParams * MR_TextMeshAlignParams_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_TextMeshAlignParams_DestroyArray(). Use MR_TextMeshAlignParams_OffsetMutablePtr() and MR_TextMeshAlignParams_OffsetPtr() to access the array elements.

MR_TextMeshAlignParams_Destroy()

MRC_API void MR_TextMeshAlignParams_Destroy

(

const MR_TextMeshAlignParams *

_this

)

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

MR_TextMeshAlignParams_DestroyArray()

MRC_API void MR_TextMeshAlignParams_DestroyArray

(

const MR_TextMeshAlignParams *

_this

)

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

MR_TextMeshAlignParams_Get_direction()

MRC_API const MR_Vector3f * MR_TextMeshAlignParams_Get_direction

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named direction. 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_TextMeshAlignParams_Get_fontBasedSizeCalc()

MRC_API const bool * MR_TextMeshAlignParams_Get_fontBasedSizeCalc

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named fontBasedSizeCalc. 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_TextMeshAlignParams_Get_fontHeight()

MRC_API const float * MR_TextMeshAlignParams_Get_fontHeight

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named fontHeight. 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_TextMeshAlignParams_Get_pivotPoint()

MRC_API const MR_Vector2f * MR_TextMeshAlignParams_Get_pivotPoint

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named pivotPoint. 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_TextMeshAlignParams_Get_startPoint()

MRC_API const MR_MeshTriPoint * MR_TextMeshAlignParams_Get_startPoint

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named startPoint. 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_TextMeshAlignParams_Get_surfaceOffset()

MRC_API const float * MR_TextMeshAlignParams_Get_surfaceOffset

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named surfaceOffset. 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_TextMeshAlignParams_Get_textMaximumMovement()

MRC_API const float * MR_TextMeshAlignParams_Get_textMaximumMovement

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named textMaximumMovement. 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_TextMeshAlignParams_Get_textNormal()

MRC_API const MR_Vector3f *const * MR_TextMeshAlignParams_Get_textNormal

(

const MR_TextMeshAlignParams *

_this

)

Returns a pointer to a member variable of class MR::TextMeshAlignParams named textNormal. 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_TextMeshAlignParams_GetMutable_direction()

MRC_API MR_Vector3f * MR_TextMeshAlignParams_GetMutable_direction

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named direction. 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_TextMeshAlignParams_GetMutable_fontBasedSizeCalc()

MRC_API bool * MR_TextMeshAlignParams_GetMutable_fontBasedSizeCalc

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named fontBasedSizeCalc. 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_TextMeshAlignParams_GetMutable_fontHeight()

MRC_API float * MR_TextMeshAlignParams_GetMutable_fontHeight

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named fontHeight. 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_TextMeshAlignParams_GetMutable_pivotPoint()

MRC_API MR_Vector2f * MR_TextMeshAlignParams_GetMutable_pivotPoint

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named pivotPoint. 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_TextMeshAlignParams_GetMutable_startPoint()

MRC_API MR_MeshTriPoint * MR_TextMeshAlignParams_GetMutable_startPoint

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named startPoint. 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_TextMeshAlignParams_GetMutable_surfaceOffset()

MRC_API float * MR_TextMeshAlignParams_GetMutable_surfaceOffset

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named surfaceOffset. 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_TextMeshAlignParams_GetMutable_textMaximumMovement()

MRC_API float * MR_TextMeshAlignParams_GetMutable_textMaximumMovement

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named textMaximumMovement. 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_TextMeshAlignParams_GetMutable_textNormal()

MRC_API const MR_Vector3f ** MR_TextMeshAlignParams_GetMutable_textNormal

(

MR_TextMeshAlignParams *

_this

)

Returns a mutable pointer to a member variable of class MR::TextMeshAlignParams named textNormal. 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_TextMeshAlignParams_MutableUpcastTo_MR_SymbolMeshParams()

MRC_API MR_SymbolMeshParams * MR_TextMeshAlignParams_MutableUpcastTo_MR_SymbolMeshParams

(

MR_TextMeshAlignParams *

object

)

Upcasts an instance of MR::TextMeshAlignParams to its base class MR::SymbolMeshParams.

MR_TextMeshAlignParams_OffsetMutablePtr()

MRC_API MR_TextMeshAlignParams * MR_TextMeshAlignParams_OffsetMutablePtr	(	MR_TextMeshAlignParams *	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_TextMeshAlignParams_OffsetPtr()

MRC_API const MR_TextMeshAlignParams * MR_TextMeshAlignParams_OffsetPtr	(	const MR_TextMeshAlignParams *	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_TextMeshAlignParams_Set_direction()

MRC_API void MR_TextMeshAlignParams_Set_direction	(	MR_TextMeshAlignParams *	_this,
		MR_Vector3f	value )

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

MR_TextMeshAlignParams_Set_fontBasedSizeCalc()

MRC_API void MR_TextMeshAlignParams_Set_fontBasedSizeCalc	(	MR_TextMeshAlignParams *	_this,
		bool	value )

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

MR_TextMeshAlignParams_Set_fontHeight()

MRC_API void MR_TextMeshAlignParams_Set_fontHeight	(	MR_TextMeshAlignParams *	_this,
		float	value )

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

MR_TextMeshAlignParams_Set_pivotPoint()

MRC_API void MR_TextMeshAlignParams_Set_pivotPoint	(	MR_TextMeshAlignParams *	_this,
		MR_Vector2f	value )

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

MR_TextMeshAlignParams_Set_startPoint()

MRC_API void MR_TextMeshAlignParams_Set_startPoint	(	MR_TextMeshAlignParams *	_this,
		const MR_MeshTriPoint *	value )

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

MR_TextMeshAlignParams_Set_surfaceOffset()

MRC_API void MR_TextMeshAlignParams_Set_surfaceOffset	(	MR_TextMeshAlignParams *	_this,
		float	value )

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

MR_TextMeshAlignParams_Set_textMaximumMovement()

MRC_API void MR_TextMeshAlignParams_Set_textMaximumMovement	(	MR_TextMeshAlignParams *	_this,
		float	value )

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

MR_TextMeshAlignParams_Set_textNormal()

MRC_API void MR_TextMeshAlignParams_Set_textNormal	(	MR_TextMeshAlignParams *	_this,
		const MR_Vector3f *	value )

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

MR_TextMeshAlignParams_UpcastTo_MR_SymbolMeshParams()

MRC_API const MR_SymbolMeshParams * MR_TextMeshAlignParams_UpcastTo_MR_SymbolMeshParams

(

const MR_TextMeshAlignParams *

object

)

Upcasts an instance of MR::TextMeshAlignParams to its base class MR::SymbolMeshParams. This version is acting on mutable pointers.