MRPointOnFace.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_istream	MR_std_istream
typedef struct MR_std_ostream	MR_std_ostream
typedef struct MR_PointOnFace	MR_PointOnFace

Functions
MRC_API const MR_FaceId *	MR_PointOnFace_Get_face (const MR_PointOnFace *_this)
MRC_API void	MR_PointOnFace_Set_face (MR_PointOnFace *_this, MR_FaceId value)
MRC_API MR_FaceId *	MR_PointOnFace_GetMutable_face (MR_PointOnFace *_this)
MRC_API const MR_Vector3f *	MR_PointOnFace_Get_point (const MR_PointOnFace *_this)
MRC_API void	MR_PointOnFace_Set_point (MR_PointOnFace *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_PointOnFace_GetMutable_point (MR_PointOnFace *_this)
MRC_API MR_PointOnFace *	MR_PointOnFace_DefaultConstruct (void)
MRC_API MR_PointOnFace *	MR_PointOnFace_DefaultConstructArray (size_t num_elems)
MRC_API MR_PointOnFace *	MR_PointOnFace_ConstructFrom (MR_FaceId face, MR_Vector3f point)
MRC_API const MR_PointOnFace *	MR_PointOnFace_OffsetPtr (const MR_PointOnFace *ptr, ptrdiff_t i)
MRC_API MR_PointOnFace *	MR_PointOnFace_OffsetMutablePtr (MR_PointOnFace *ptr, ptrdiff_t i)
MRC_API MR_PointOnFace *	MR_PointOnFace_ConstructFromAnother (const MR_PointOnFace *_other)
MRC_API void	MR_PointOnFace_Destroy (const MR_PointOnFace *_this)
	Destroys a heap-allocated instance of MR_PointOnFace. Does nothing if the pointer is null.
MRC_API void	MR_PointOnFace_DestroyArray (const MR_PointOnFace *_this)
	Destroys a heap-allocated array of MR_PointOnFace. Does nothing if the pointer is null.
MRC_API bool	MR_PointOnFace_ConvertTo_bool (const MR_PointOnFace *_this)
MRC_API MR_PointOnFace *	MR_PointOnFace_AssignFromAnother (MR_PointOnFace *_this, const MR_PointOnFace *_other)
MRC_API bool	MR_PointOnFace_valid (const MR_PointOnFace *_this)
MRC_API MR_std_ostream *	MR_print_MR_PointOnFace (MR_std_ostream *s, const MR_PointOnFace *pof)
MRC_API MR_std_istream *	MR_input_MR_PointOnFace (MR_std_istream *s, MR_PointOnFace *pof)

Typedef Documentation

MR_PointOnFace

typedef struct MR_PointOnFace MR_PointOnFace

a point located on some mesh's face Generated from class MR::PointOnFace. 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_std_istream

typedef struct MR_std_istream MR_std_istream

MR_std_ostream

typedef struct MR_std_ostream MR_std_ostream

Function Documentation

MR_input_MR_PointOnFace()

MRC_API MR_std_istream * MR_input_MR_PointOnFace	(	MR_std_istream *	s,
		MR_PointOnFace *	pof )

Generated from function MR::operator>>. Parameter s can not be null. It is a single object. Parameter pof 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_PointOnFace_AssignFromAnother()

MRC_API MR_PointOnFace * MR_PointOnFace_AssignFromAnother	(	MR_PointOnFace *	_this,
		const MR_PointOnFace *	_other )

Generated from method MR::PointOnFace::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 had previously.

MR_PointOnFace_ConstructFrom()

MRC_API MR_PointOnFace * MR_PointOnFace_ConstructFrom	(	MR_FaceId	face,
		MR_Vector3f	point )

Constructs MR::PointOnFace elementwise. The reference to the parameter face might be preserved in the constructed object. The reference to the parameter point might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_PointOnFace_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_PointOnFace_ConstructFromAnother()

MRC_API MR_PointOnFace * MR_PointOnFace_ConstructFromAnother

(

const MR_PointOnFace *

_other

)

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

MR_PointOnFace_ConvertTo_bool()

MRC_API bool MR_PointOnFace_ConvertTo_bool

(

const MR_PointOnFace *

_this

)

Generated from conversion operator MR::PointOnFace::operator bool. Parameter _this can not be null. It is a single object.

MR_PointOnFace_DefaultConstruct()

MRC_API MR_PointOnFace * MR_PointOnFace_DefaultConstruct

(

void

)

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

MR_PointOnFace_DefaultConstructArray()

MRC_API MR_PointOnFace * MR_PointOnFace_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_PointOnFace_DestroyArray(). Use MR_PointOnFace_OffsetMutablePtr() and MR_PointOnFace_OffsetPtr() to access the array elements.

MR_PointOnFace_Destroy()

MRC_API void MR_PointOnFace_Destroy

(

const MR_PointOnFace *

_this

)

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

MR_PointOnFace_DestroyArray()

MRC_API void MR_PointOnFace_DestroyArray

(

const MR_PointOnFace *

_this

)

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

MR_PointOnFace_Get_face()

MRC_API const MR_FaceId * MR_PointOnFace_Get_face

(

const MR_PointOnFace *

_this

)

mesh's face containing the point Returns a pointer to a member variable of class MR::PointOnFace named face. 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_PointOnFace_Get_point()

MRC_API const MR_Vector3f * MR_PointOnFace_Get_point

(

const MR_PointOnFace *

_this

)

a point of the mesh's face Returns a pointer to a member variable of class MR::PointOnFace named point. 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_PointOnFace_GetMutable_face()

MRC_API MR_FaceId * MR_PointOnFace_GetMutable_face

(

MR_PointOnFace *

_this

)

mesh's face containing the point Returns a mutable pointer to a member variable of class MR::PointOnFace named face. 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_PointOnFace_GetMutable_point()

MRC_API MR_Vector3f * MR_PointOnFace_GetMutable_point

(

MR_PointOnFace *

_this

)

a point of the mesh's face Returns a mutable pointer to a member variable of class MR::PointOnFace named point. 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_PointOnFace_OffsetMutablePtr()

MRC_API MR_PointOnFace * MR_PointOnFace_OffsetMutablePtr	(	MR_PointOnFace *	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_PointOnFace_OffsetPtr()

MRC_API const MR_PointOnFace * MR_PointOnFace_OffsetPtr	(	const MR_PointOnFace *	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_PointOnFace_Set_face()

MRC_API void MR_PointOnFace_Set_face	(	MR_PointOnFace *	_this,
		MR_FaceId	value )

mesh's face containing the point Modifies a member variable of class MR::PointOnFace named face. 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 face. When this function is called, this object will drop object references it had previously in face.

MR_PointOnFace_Set_point()

MRC_API void MR_PointOnFace_Set_point	(	MR_PointOnFace *	_this,
		MR_Vector3f	value )

a point of the mesh's face Modifies a member variable of class MR::PointOnFace named point. 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 point. When this function is called, this object will drop object references it had previously in point.

MR_PointOnFace_valid()

MRC_API bool MR_PointOnFace_valid

(

const MR_PointOnFace *

_this

)

check for validity, otherwise the point is not defined Generated from method MR::PointOnFace::valid. Parameter _this can not be null. It is a single object.

MR_print_MR_PointOnFace()

MRC_API MR_std_ostream * MR_print_MR_PointOnFace	(	MR_std_ostream *	s,
		const MR_PointOnFace *	pof )

Generated from function MR::operator<<. Parameter s can not be null. It is a single object. Parameter pof can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.