MREdgeIterator.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_IteratorRange_MR_UndirectedEdgeIterator	MR_IteratorRange_MR_UndirectedEdgeIterator
	simple alternative to boost/iterator_range Generated from class MR::IteratorRange<MR::UndirectedEdgeIterator>. Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).
typedef struct MR_UndirectedEdgeIterator	MR_UndirectedEdgeIterator

Functions
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_DefaultConstruct (void)
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_DefaultConstructArray (size_t num_elems)
MRC_API const MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_OffsetPtr (const MR_UndirectedEdgeIterator *ptr, ptrdiff_t i)
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_OffsetMutablePtr (MR_UndirectedEdgeIterator *ptr, ptrdiff_t i)
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_ConstructFromAnother (const MR_UndirectedEdgeIterator *_other)
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_Construct (const MR_MeshTopology *topology)
MRC_API void	MR_UndirectedEdgeIterator_Destroy (const MR_UndirectedEdgeIterator *_this)
	Destroys a heap-allocated instance of MR_UndirectedEdgeIterator. Does nothing if the pointer is null.
MRC_API void	MR_UndirectedEdgeIterator_DestroyArray (const MR_UndirectedEdgeIterator *_this)
	Destroys a heap-allocated array of MR_UndirectedEdgeIterator. Does nothing if the pointer is null.
MRC_API MR_UndirectedEdgeIterator *	MR_UndirectedEdgeIterator_AssignFromAnother (MR_UndirectedEdgeIterator *_this, const MR_UndirectedEdgeIterator *_other)
MRC_API MR_UndirectedEdgeIterator *	MR_incr_MR_UndirectedEdgeIterator (MR_UndirectedEdgeIterator *_this)
MRC_API MR_UndirectedEdgeId	MR_deref_MR_UndirectedEdgeIterator (const MR_UndirectedEdgeIterator *_this)
MRC_API bool	MR_equal_MR_UndirectedEdgeIterator (const MR_UndirectedEdgeIterator *a, const MR_UndirectedEdgeIterator *b)
MRC_API bool	MR_not_equal_MR_UndirectedEdgeIterator (const MR_UndirectedEdgeIterator *a, const MR_UndirectedEdgeIterator *b)
MRC_API MR_IteratorRange_MR_UndirectedEdgeIterator *	MR_undirectedEdges_MR_MeshTopology (const MR_MeshTopology *topology)

Typedef Documentation

MR_IteratorRange_MR_UndirectedEdgeIterator

typedef struct MR_IteratorRange_MR_UndirectedEdgeIterator MR_IteratorRange_MR_UndirectedEdgeIterator

simple alternative to boost/iterator_range Generated from class MR::IteratorRange<MR::UndirectedEdgeIterator>. Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_UndirectedEdgeIterator

typedef struct MR_UndirectedEdgeIterator MR_UndirectedEdgeIterator

Generated from class MR::UndirectedEdgeIterator. 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).

Function Documentation

MR_deref_MR_UndirectedEdgeIterator()

MRC_API MR_UndirectedEdgeId MR_deref_MR_UndirectedEdgeIterator

(

const MR_UndirectedEdgeIterator *

_this

)

Generated from method MR::UndirectedEdgeIterator::operator*. Parameter _this can not be null. It is a single object. The reference to this object might be preserved in the return value.

MR_equal_MR_UndirectedEdgeIterator()

MRC_API bool MR_equal_MR_UndirectedEdgeIterator	(	const MR_UndirectedEdgeIterator *	a,
		const MR_UndirectedEdgeIterator *	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_incr_MR_UndirectedEdgeIterator()

MRC_API MR_UndirectedEdgeIterator * MR_incr_MR_UndirectedEdgeIterator

(

MR_UndirectedEdgeIterator *

_this

)

Generated from method MR::UndirectedEdgeIterator::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_not_equal_MR_UndirectedEdgeIterator()

MRC_API bool MR_not_equal_MR_UndirectedEdgeIterator	(	const MR_UndirectedEdgeIterator *	a,
		const MR_UndirectedEdgeIterator *	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_UndirectedEdgeIterator_AssignFromAnother()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_AssignFromAnother	(	MR_UndirectedEdgeIterator *	_this,
		const MR_UndirectedEdgeIterator *	_other )

Generated from method MR::UndirectedEdgeIterator::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_UndirectedEdgeIterator_Construct()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_Construct

(

const MR_MeshTopology *

topology

)

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

MR_UndirectedEdgeIterator_ConstructFromAnother()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_ConstructFromAnother

(

const MR_UndirectedEdgeIterator *

_other

)

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

MR_UndirectedEdgeIterator_DefaultConstruct()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_DefaultConstruct

(

void

)

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

MR_UndirectedEdgeIterator_DefaultConstructArray()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_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_UndirectedEdgeIterator_DestroyArray(). Use MR_UndirectedEdgeIterator_OffsetMutablePtr() and MR_UndirectedEdgeIterator_OffsetPtr() to access the array elements.

MR_UndirectedEdgeIterator_Destroy()

MRC_API void MR_UndirectedEdgeIterator_Destroy

(

const MR_UndirectedEdgeIterator *

_this

)

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

MR_UndirectedEdgeIterator_DestroyArray()

MRC_API void MR_UndirectedEdgeIterator_DestroyArray

(

const MR_UndirectedEdgeIterator *

_this

)

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

MR_UndirectedEdgeIterator_OffsetMutablePtr()

MRC_API MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_OffsetMutablePtr	(	MR_UndirectedEdgeIterator *	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_UndirectedEdgeIterator_OffsetPtr()

MRC_API const MR_UndirectedEdgeIterator * MR_UndirectedEdgeIterator_OffsetPtr	(	const MR_UndirectedEdgeIterator *	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_undirectedEdges_MR_MeshTopology()

MRC_API MR_IteratorRange_MR_UndirectedEdgeIterator * MR_undirectedEdges_MR_MeshTopology

(

const MR_MeshTopology *

topology

)

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