MRUnorientedTriangle.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_UnorientedTriangle	MR_UnorientedTriangle

Functions
MRC_API const MR_std_array_MR_VertId_3 *	MR_UnorientedTriangle_Get_verts (const MR_UnorientedTriangle *_this)
MRC_API void	MR_UnorientedTriangle_Set_verts (MR_UnorientedTriangle *_this, MR_std_array_MR_VertId_3 value)
MRC_API MR_std_array_MR_VertId_3 *	MR_UnorientedTriangle_GetMutable_verts (MR_UnorientedTriangle *_this)
MRC_API MR_UnorientedTriangle *	MR_UnorientedTriangle_ConstructFromAnother (const MR_UnorientedTriangle *_other)
MRC_API const MR_UnorientedTriangle *	MR_UnorientedTriangle_OffsetPtr (const MR_UnorientedTriangle *ptr, ptrdiff_t i)
MRC_API MR_UnorientedTriangle *	MR_UnorientedTriangle_OffsetMutablePtr (MR_UnorientedTriangle *ptr, ptrdiff_t i)
MRC_API MR_UnorientedTriangle *	MR_UnorientedTriangle_Construct (const MR_std_array_MR_VertId_3 *inVs, bool *outFlipped)
MRC_API void	MR_UnorientedTriangle_Destroy (const MR_UnorientedTriangle *_this)
	Destroys a heap-allocated instance of MR_UnorientedTriangle. Does nothing if the pointer is null.
MRC_API void	MR_UnorientedTriangle_DestroyArray (const MR_UnorientedTriangle *_this)
	Destroys a heap-allocated array of MR_UnorientedTriangle. Does nothing if the pointer is null.
MRC_API MR_std_array_MR_VertId_3 *	MR_UnorientedTriangle_ConvertTo_std_array_MR_VertId_3_ref (MR_UnorientedTriangle *_this)
MRC_API const MR_std_array_MR_VertId_3 *	MR_UnorientedTriangle_ConvertTo_const_std_array_MR_VertId_3_ref (const MR_UnorientedTriangle *_this)
MRC_API MR_UnorientedTriangle *	MR_UnorientedTriangle_AssignFromAnother (MR_UnorientedTriangle *_this, const MR_UnorientedTriangle *_other)
MRC_API MR_std_array_MR_VertId_3	MR_UnorientedTriangle_getFlipped (const MR_UnorientedTriangle *_this)
MRC_API MR_VertId *	MR_UnorientedTriangle_index_mut (MR_UnorientedTriangle *_this, MR_uint64_t i)
MRC_API const MR_VertId *	MR_UnorientedTriangle_index (const MR_UnorientedTriangle *_this, MR_uint64_t i)
MRC_API bool	MR_equal_MR_UnorientedTriangle (const MR_UnorientedTriangle *a, const MR_UnorientedTriangle *b)

Typedef Documentation

MR_UnorientedTriangle

typedef struct MR_UnorientedTriangle MR_UnorientedTriangle

describes a triangle as three vertex IDs sorted in a way to quickly find same triangles irrespective of vertex order (clockwise or counterclockwise) Generated from class MR::UnorientedTriangle. Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_equal_MR_UnorientedTriangle()

MRC_API bool MR_equal_MR_UnorientedTriangle	(	const MR_UnorientedTriangle *	a,
		const MR_UnorientedTriangle *	b )

Generated from function MR::operator==. Parameter a can not be null. It is a single object. Parameter b can not be null. It is a single object.

MR_UnorientedTriangle_AssignFromAnother()

MRC_API MR_UnorientedTriangle * MR_UnorientedTriangle_AssignFromAnother	(	MR_UnorientedTriangle *	_this,
		const MR_UnorientedTriangle *	_other )

Generated from method MR::UnorientedTriangle::operator=. Parameter _this can not be null. It is a single object. Parameter _other 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 held previously.

MR_UnorientedTriangle_Construct()

MRC_API MR_UnorientedTriangle * MR_UnorientedTriangle_Construct	(	const MR_std_array_MR_VertId_3 *	inVs,
		bool *	outFlipped )

Generated from constructor MR::UnorientedTriangle::UnorientedTriangle. Parameter inVs can not be null. It is a single object. The reference to the parameter inVs might be preserved in the constructed object. Parameter outFlipped defaults to a null pointer in C++. The reference to the parameter outFlipped might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_UnorientedTriangle_Destroy() to free it when you're done using it.

MR_UnorientedTriangle_ConstructFromAnother()

MRC_API MR_UnorientedTriangle * MR_UnorientedTriangle_ConstructFromAnother

(

const MR_UnorientedTriangle *

_other

)

Generated from constructor MR::UnorientedTriangle::UnorientedTriangle. Parameter _other 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 the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_UnorientedTriangle_Destroy() to free it when you're done using it.

MR_UnorientedTriangle_ConvertTo_const_std_array_MR_VertId_3_ref()

MRC_API const MR_std_array_MR_VertId_3 * MR_UnorientedTriangle_ConvertTo_const_std_array_MR_VertId_3_ref

(

const MR_UnorientedTriangle *

_this

)

Generated from conversion operator MR::UnorientedTriangle::operator const std::array<MR::VertId, 3> &. 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_UnorientedTriangle_ConvertTo_std_array_MR_VertId_3_ref()

MRC_API MR_std_array_MR_VertId_3 * MR_UnorientedTriangle_ConvertTo_std_array_MR_VertId_3_ref

(

MR_UnorientedTriangle *

_this

)

Generated from conversion operator MR::UnorientedTriangle::operator std::array<MR::VertId, 3> &. 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_UnorientedTriangle_Destroy()

MRC_API void MR_UnorientedTriangle_Destroy

(

const MR_UnorientedTriangle *

_this

)

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

MR_UnorientedTriangle_DestroyArray()

MRC_API void MR_UnorientedTriangle_DestroyArray

(

const MR_UnorientedTriangle *

_this

)

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

MR_UnorientedTriangle_Get_verts()

MRC_API const MR_std_array_MR_VertId_3 * MR_UnorientedTriangle_Get_verts

(

const MR_UnorientedTriangle *

_this

)

Returns a pointer to a member variable of class MR::UnorientedTriangle named verts. 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. The reference to this object might be preserved as the return value.

MR_UnorientedTriangle_getFlipped()

MRC_API MR_std_array_MR_VertId_3 MR_UnorientedTriangle_getFlipped

(

const MR_UnorientedTriangle *

_this

)

returns this triangle with the opposite orientation Generated from method MR::UnorientedTriangle::getFlipped. Parameter _this can not be null. It is a single object.

MR_UnorientedTriangle_GetMutable_verts()

MRC_API MR_std_array_MR_VertId_3 * MR_UnorientedTriangle_GetMutable_verts

(

MR_UnorientedTriangle *

_this

)

Returns a mutable pointer to a member variable of class MR::UnorientedTriangle named verts. 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. The reference to this object might be preserved as the return value.

MR_UnorientedTriangle_index()

MRC_API const MR_VertId * MR_UnorientedTriangle_index	(	const MR_UnorientedTriangle *	_this,
		MR_uint64_t	i )

Generated from method MR::UnorientedTriangle::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_UnorientedTriangle_index_mut()

MRC_API MR_VertId * MR_UnorientedTriangle_index_mut	(	MR_UnorientedTriangle *	_this,
		MR_uint64_t	i )

Generated from method MR::UnorientedTriangle::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_UnorientedTriangle_OffsetMutablePtr()

MRC_API MR_UnorientedTriangle * MR_UnorientedTriangle_OffsetMutablePtr	(	MR_UnorientedTriangle *	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_UnorientedTriangle_OffsetPtr()

MRC_API const MR_UnorientedTriangle * MR_UnorientedTriangle_OffsetPtr	(	const MR_UnorientedTriangle *	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_UnorientedTriangle_Set_verts()

MRC_API void MR_UnorientedTriangle_Set_verts	(	MR_UnorientedTriangle *	_this,
		MR_std_array_MR_VertId_3	value )

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