MRInTreePathBuilder.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_MeshTopology	MR_MeshTopology
typedef struct MR_UndirectedEdgeBitSet	MR_UndirectedEdgeBitSet
typedef struct MR_std_vector_MR_EdgeId	MR_std_vector_MR_EdgeId
typedef struct MR_InTreePathBuilder	MR_InTreePathBuilder

Functions
MRC_API MR_InTreePathBuilder *	MR_InTreePathBuilder_ConstructFromAnother (MR_PassBy _other_pass_by, MR_InTreePathBuilder *_other)
MRC_API const MR_InTreePathBuilder *	MR_InTreePathBuilder_OffsetPtr (const MR_InTreePathBuilder *ptr, ptrdiff_t i)
MRC_API MR_InTreePathBuilder *	MR_InTreePathBuilder_OffsetMutablePtr (MR_InTreePathBuilder *ptr, ptrdiff_t i)
MRC_API MR_InTreePathBuilder *	MR_InTreePathBuilder_Construct (const MR_MeshTopology *topology, const MR_UndirectedEdgeBitSet *treeEdges)
MRC_API void	MR_InTreePathBuilder_Destroy (const MR_InTreePathBuilder *_this)
	Destroys a heap-allocated instance of MR_InTreePathBuilder. Does nothing if the pointer is null.
MRC_API void	MR_InTreePathBuilder_DestroyArray (const MR_InTreePathBuilder *_this)
	Destroys a heap-allocated array of MR_InTreePathBuilder. Does nothing if the pointer is null.
MRC_API MR_std_vector_MR_EdgeId *	MR_InTreePathBuilder_build (const MR_InTreePathBuilder *_this, MR_VertId start, MR_VertId finish)

Typedef Documentation

MR_InTreePathBuilder

typedef struct MR_InTreePathBuilder MR_InTreePathBuilder

given a spanning tree of edges in the mesh (or forest in case of several connected components), prepares to build quickly a path along tree edges between any two vertices Generated from class MR::InTreePathBuilder. Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_MeshTopology

typedef struct MR_MeshTopology MR_MeshTopology

MR_std_vector_MR_EdgeId

typedef struct MR_std_vector_MR_EdgeId MR_std_vector_MR_EdgeId

MR_UndirectedEdgeBitSet

typedef struct MR_UndirectedEdgeBitSet MR_UndirectedEdgeBitSet

Function Documentation

MR_InTreePathBuilder_build()

MRC_API MR_std_vector_MR_EdgeId * MR_InTreePathBuilder_build	(	const MR_InTreePathBuilder *	_this,
		MR_VertId	start,
		MR_VertId	finish )

finds the path in tree from start vertex to finish vertex Generated from method MR::InTreePathBuilder::build. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_MR_EdgeId_Destroy() to free it when you're done using it.

MR_InTreePathBuilder_Construct()

MRC_API MR_InTreePathBuilder * MR_InTreePathBuilder_Construct	(	const MR_MeshTopology *	topology,
		const MR_UndirectedEdgeBitSet *	treeEdges )

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

MR_InTreePathBuilder_ConstructFromAnother()

MRC_API MR_InTreePathBuilder * MR_InTreePathBuilder_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_InTreePathBuilder *	_other )

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

MR_InTreePathBuilder_Destroy()

MRC_API void MR_InTreePathBuilder_Destroy

(

const MR_InTreePathBuilder *

_this

)

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

MR_InTreePathBuilder_DestroyArray()

MRC_API void MR_InTreePathBuilder_DestroyArray

(

const MR_InTreePathBuilder *

_this

)

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

MR_InTreePathBuilder_OffsetMutablePtr()

MRC_API MR_InTreePathBuilder * MR_InTreePathBuilder_OffsetMutablePtr	(	MR_InTreePathBuilder *	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_InTreePathBuilder_OffsetPtr()

MRC_API const MR_InTreePathBuilder * MR_InTreePathBuilder_OffsetPtr	(	const MR_InTreePathBuilder *	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.