MRCurve.h File Reference

#include <MRCMesh/MRVector3.h>
#include <MRCMisc/exports.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_CurvePoint	MR_CurvePoint

Functions
MRC_API const MR_Vector3f *	MR_CurvePoint_Get_pos (const MR_CurvePoint *_this)
MRC_API void	MR_CurvePoint_Set_pos (MR_CurvePoint *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_CurvePoint_GetMutable_pos (MR_CurvePoint *_this)
MRC_API const MR_Vector3f *	MR_CurvePoint_Get_dir (const MR_CurvePoint *_this)
MRC_API void	MR_CurvePoint_Set_dir (MR_CurvePoint *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_CurvePoint_GetMutable_dir (MR_CurvePoint *_this)
MRC_API const MR_Vector3f *	MR_CurvePoint_Get_snorm (const MR_CurvePoint *_this)
MRC_API void	MR_CurvePoint_Set_snorm (MR_CurvePoint *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_CurvePoint_GetMutable_snorm (MR_CurvePoint *_this)
MRC_API MR_CurvePoint *	MR_CurvePoint_DefaultConstruct (void)
MRC_API MR_CurvePoint *	MR_CurvePoint_DefaultConstructArray (size_t num_elems)
MRC_API MR_CurvePoint *	MR_CurvePoint_ConstructFrom (MR_Vector3f pos, MR_Vector3f dir, MR_Vector3f snorm)
MRC_API const MR_CurvePoint *	MR_CurvePoint_OffsetPtr (const MR_CurvePoint *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_CurvePoint *	MR_CurvePoint_OffsetMutablePtr (MR_CurvePoint *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_CurvePoint *	MR_CurvePoint_ConstructFromAnother (const MR_CurvePoint *_other)
MRC_API void	MR_CurvePoint_Destroy (const MR_CurvePoint *_this)
	Destroys a heap-allocated instance of MR_CurvePoint. Does nothing if the pointer is null.
MRC_API void	MR_CurvePoint_DestroyArray (const MR_CurvePoint *_this)
	Destroys a heap-allocated array of MR_CurvePoint. Does nothing if the pointer is null.
MRC_API MR_CurvePoint *	MR_CurvePoint_AssignFromAnother (MR_CurvePoint *_this, const MR_CurvePoint *_other)

Typedef Documentation

MR_CurvePoint

typedef struct MR_CurvePoint MR_CurvePoint

Generated from class MR::CurvePoint. 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). position on the curve Returns a pointer to a member variable of class MR::CurvePoint named pos. 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.

Function Documentation

MR_CurvePoint_AssignFromAnother()

MRC_API MR_CurvePoint * MR_CurvePoint_AssignFromAnother	(	MR_CurvePoint *	_this,
		const MR_CurvePoint *	_other )

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

MRC_API MR_CurvePoint * MR_CurvePoint_ConstructFrom	(	MR_Vector3f	pos,
		MR_Vector3f	dir,
		MR_Vector3f	snorm )

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

MR_CurvePoint_ConstructFromAnother()

MRC_API MR_CurvePoint * MR_CurvePoint_ConstructFromAnother

(

const MR_CurvePoint *

_other

)

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

MR_CurvePoint_DefaultConstruct()

MRC_API MR_CurvePoint * MR_CurvePoint_DefaultConstruct

(

void

)

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

MR_CurvePoint_DefaultConstructArray()

MRC_API MR_CurvePoint * MR_CurvePoint_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_CurvePoint_DestroyArray(). Use MR_CurvePoint_OffsetMutablePtr() and MR_CurvePoint_OffsetPtr() to access the array elements.

MR_CurvePoint_Destroy()

MRC_API void MR_CurvePoint_Destroy

(

const MR_CurvePoint *

_this

)

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

MR_CurvePoint_DestroyArray()

MRC_API void MR_CurvePoint_DestroyArray

(

const MR_CurvePoint *

_this

)

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

MR_CurvePoint_Get_dir()

MRC_API const MR_Vector3f * MR_CurvePoint_Get_dir

(

const MR_CurvePoint *

_this

)

direction along the curve Modifies a member variable of class MR::CurvePoint named dir. Parameter _this can not be null. It is a single object.

MR_CurvePoint_Get_pos()

MRC_API const MR_Vector3f * MR_CurvePoint_Get_pos

(

const MR_CurvePoint *

_this

)

position on the curve Modifies a member variable of class MR::CurvePoint named pos. Parameter _this can not be null. It is a single object.

MR_CurvePoint_Get_snorm()

MRC_API const MR_Vector3f * MR_CurvePoint_Get_snorm

(

const MR_CurvePoint *

_this

)

the normal of the surface where the curve is located Modifies a member variable of class MR::CurvePoint named snorm. Parameter _this can not be null. It is a single object.

MR_CurvePoint_GetMutable_dir()

MRC_API MR_Vector3f * MR_CurvePoint_GetMutable_dir

(

MR_CurvePoint *

_this

)

the normal of the surface where the curve is located Returns a pointer to a member variable of class MR::CurvePoint named snorm. 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_CurvePoint_GetMutable_pos()

MRC_API MR_Vector3f * MR_CurvePoint_GetMutable_pos

(

MR_CurvePoint *

_this

)

direction along the curve Returns a pointer to a member variable of class MR::CurvePoint named dir. 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_CurvePoint_GetMutable_snorm()

MRC_API MR_Vector3f * MR_CurvePoint_GetMutable_snorm

(

MR_CurvePoint *

_this

)

MR_CurvePoint_OffsetMutablePtr()

MRC_API MR_CurvePoint * MR_CurvePoint_OffsetMutablePtr	(	MR_CurvePoint *	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_CurvePoint_OffsetPtr()

MRC_API const MR_CurvePoint * MR_CurvePoint_OffsetPtr	(	const MR_CurvePoint *	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_CurvePoint_Set_dir()

MRC_API void MR_CurvePoint_Set_dir	(	MR_CurvePoint *	_this,
		MR_Vector3f	value )

direction along the curve Returns a mutable pointer to a member variable of class MR::CurvePoint named dir. 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_CurvePoint_Set_pos()

MRC_API void MR_CurvePoint_Set_pos	(	MR_CurvePoint *	_this,
		MR_Vector3f	value )

position on the curve Returns a mutable pointer to a member variable of class MR::CurvePoint named pos. 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_CurvePoint_Set_snorm()

MRC_API void MR_CurvePoint_Set_snorm	(	MR_CurvePoint *	_this,
		MR_Vector3f	value )

the normal of the surface where the curve is located Returns a mutable pointer to a member variable of class MR::CurvePoint named snorm. 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.