MRMeshOrPointsObject.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_MeshOrPoints	MR_MeshOrPoints
typedef struct MR_ObjectMesh	MR_ObjectMesh
typedef struct MR_ObjectPoints	MR_ObjectPoints
typedef struct MR_std_shared_ptr_MR_ObjectMesh	MR_std_shared_ptr_MR_ObjectMesh
typedef struct MR_std_shared_ptr_MR_ObjectPoints	MR_std_shared_ptr_MR_ObjectPoints
typedef struct MR_std_shared_ptr_MR_VisualObject	MR_std_shared_ptr_MR_VisualObject
typedef struct MR_MeshOrPointsObject	MR_MeshOrPointsObject

Functions
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_DefaultConstruct (void)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_DefaultConstructArray (size_t num_elems)
MRC_API const MR_MeshOrPointsObject *	MR_MeshOrPointsObject_OffsetPtr (const MR_MeshOrPointsObject *ptr, ptrdiff_t i)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_OffsetMutablePtr (MR_MeshOrPointsObject *ptr, ptrdiff_t i)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_ConstructFromAnother (MR_PassBy _other_pass_by, MR_MeshOrPointsObject *_other)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_VisualObject (MR_PassBy vo_pass_by, MR_std_shared_ptr_MR_VisualObject *vo)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectMesh (MR_PassBy om_pass_by, MR_std_shared_ptr_MR_ObjectMesh *om)
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectPoints (MR_PassBy op_pass_by, MR_std_shared_ptr_MR_ObjectPoints *op)
MRC_API void	MR_MeshOrPointsObject_Destroy (const MR_MeshOrPointsObject *_this)
	Destroys a heap-allocated instance of MR_MeshOrPointsObject. Does nothing if the pointer is null.
MRC_API void	MR_MeshOrPointsObject_DestroyArray (const MR_MeshOrPointsObject *_this)
	Destroys a heap-allocated array of MR_MeshOrPointsObject. Does nothing if the pointer is null.
MRC_API MR_MeshOrPointsObject *	MR_MeshOrPointsObject_AssignFromAnother (MR_MeshOrPointsObject *_this, MR_PassBy _other_pass_by, MR_MeshOrPointsObject *_other)
MRC_API void	MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectMesh (MR_MeshOrPointsObject *_this, MR_PassBy om_pass_by, MR_std_shared_ptr_MR_ObjectMesh *om)
MRC_API MR_ObjectMesh *	MR_MeshOrPointsObject_asObjectMesh (const MR_MeshOrPointsObject *_this)
MRC_API void	MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectPoints (MR_MeshOrPointsObject *_this, MR_PassBy op_pass_by, MR_std_shared_ptr_MR_ObjectPoints *op)
MRC_API MR_ObjectPoints *	MR_MeshOrPointsObject_asObjectPoints (const MR_MeshOrPointsObject *_this)
MRC_API void	MR_MeshOrPointsObject_reset (MR_MeshOrPointsObject *_this)
MRC_API const MR_std_shared_ptr_MR_VisualObject *	MR_MeshOrPointsObject_arrow (const MR_MeshOrPointsObject *_this)
MRC_API const MR_std_shared_ptr_MR_VisualObject *	MR_MeshOrPointsObject_get (const MR_MeshOrPointsObject *_this)
MRC_API bool	MR_equal_MR_MeshOrPointsObject_std_shared_ptr_MR_VisualObject (const MR_MeshOrPointsObject *_this, MR_PassBy other_pass_by, MR_std_shared_ptr_MR_VisualObject *other)
MRC_API MR_MeshOrPoints *	MR_MeshOrPointsObject_meshOrPoints (const MR_MeshOrPointsObject *_this)

Typedef Documentation

MR_MeshOrPoints

typedef struct MR_MeshOrPoints MR_MeshOrPoints

MR_MeshOrPointsObject

typedef struct MR_MeshOrPointsObject MR_MeshOrPointsObject

This class can hold either ObjectMesh or ObjectPoint It is used for convenient storage and operation with any of them Generated from class MR::MeshOrPointsObject. 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_ObjectMesh

typedef struct MR_ObjectMesh MR_ObjectMesh

MR_ObjectPoints

typedef struct MR_ObjectPoints MR_ObjectPoints

MR_std_shared_ptr_MR_ObjectMesh

typedef struct MR_std_shared_ptr_MR_ObjectMesh MR_std_shared_ptr_MR_ObjectMesh

MR_std_shared_ptr_MR_ObjectPoints

typedef struct MR_std_shared_ptr_MR_ObjectPoints MR_std_shared_ptr_MR_ObjectPoints

MR_std_shared_ptr_MR_VisualObject

typedef struct MR_std_shared_ptr_MR_VisualObject MR_std_shared_ptr_MR_VisualObject

Function Documentation

MR_equal_MR_MeshOrPointsObject_std_shared_ptr_MR_VisualObject()

MRC_API bool MR_equal_MR_MeshOrPointsObject_std_shared_ptr_MR_VisualObject	(	const MR_MeshOrPointsObject *	_this,
		MR_PassBy	other_pass_by,
		MR_std_shared_ptr_MR_VisualObject *	other )

Generated from method MR::MeshOrPointsObject::operator==. Parameter _this can not be null. It is a single object.

MR_MeshOrPointsObject_arrow()

MRC_API const MR_std_shared_ptr_MR_VisualObject * MR_MeshOrPointsObject_arrow

(

const MR_MeshOrPointsObject *

_this

)

Generated from method MR::MeshOrPointsObject::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_MeshOrPointsObject_asObjectMesh()

MRC_API MR_ObjectMesh * MR_MeshOrPointsObject_asObjectMesh

(

const MR_MeshOrPointsObject *

_this

)

if holding ObjectMesh, return pointer to it, otherwise return nullptr Generated from method MR::MeshOrPointsObject::asObjectMesh. Parameter _this can not be null. It is a single object.

MR_MeshOrPointsObject_asObjectPoints()

MRC_API MR_ObjectPoints * MR_MeshOrPointsObject_asObjectPoints

(

const MR_MeshOrPointsObject *

_this

)

if holding ObjectPoints, return pointer to it, otherwise return nullptr Generated from method MR::MeshOrPointsObject::asObjectPoints. Parameter _this can not be null. It is a single object.

MR_MeshOrPointsObject_AssignFromAnother()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_AssignFromAnother	(	MR_MeshOrPointsObject *	_this,
		MR_PassBy	_other_pass_by,
		MR_MeshOrPointsObject *	_other )

Generated from method MR::MeshOrPointsObject::operator=. Parameter _this 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_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectMesh()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectMesh	(	MR_PassBy	om_pass_by,
		MR_std_shared_ptr_MR_ObjectMesh *	om )

Generated from constructor MR::MeshOrPointsObject::MeshOrPointsObject. The reference to the parameter om might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_MeshOrPointsObject_Destroy() to free it when you're done using it.

MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectPoints()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_ObjectPoints	(	MR_PassBy	op_pass_by,
		MR_std_shared_ptr_MR_ObjectPoints *	op )

Generated from constructor MR::MeshOrPointsObject::MeshOrPointsObject. The reference to the parameter op might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_MeshOrPointsObject_Destroy() to free it when you're done using it.

MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_VisualObject()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_Construct_std_shared_ptr_MR_VisualObject	(	MR_PassBy	vo_pass_by,
		MR_std_shared_ptr_MR_VisualObject *	vo )

construct, automatically detecting the object type (ObjectMesh or ObjectPoint) if set an another type, will be reset Generated from constructor MR::MeshOrPointsObject::MeshOrPointsObject. The reference to the parameter vo might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_MeshOrPointsObject_Destroy() to free it when you're done using it.

MR_MeshOrPointsObject_ConstructFromAnother()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_MeshOrPointsObject *	_other )

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

MR_MeshOrPointsObject_DefaultConstruct()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_DefaultConstruct

(

void

)

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

MR_MeshOrPointsObject_DefaultConstructArray()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_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_MeshOrPointsObject_DestroyArray(). Use MR_MeshOrPointsObject_OffsetMutablePtr() and MR_MeshOrPointsObject_OffsetPtr() to access the array elements.

MR_MeshOrPointsObject_Destroy()

MRC_API void MR_MeshOrPointsObject_Destroy

(

const MR_MeshOrPointsObject *

_this

)

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

MR_MeshOrPointsObject_DestroyArray()

MRC_API void MR_MeshOrPointsObject_DestroyArray

(

const MR_MeshOrPointsObject *

_this

)

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

MR_MeshOrPointsObject_get()

MRC_API const MR_std_shared_ptr_MR_VisualObject * MR_MeshOrPointsObject_get

(

const MR_MeshOrPointsObject *

_this

)

Generated from method MR::MeshOrPointsObject::get. 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_MeshOrPointsObject_meshOrPoints()

MRC_API MR_MeshOrPoints * MR_MeshOrPointsObject_meshOrPoints

(

const MR_MeshOrPointsObject *

_this

)

get class that hold either mesh part or point cloud Generated from method MR::MeshOrPointsObject::meshOrPoints. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_MeshOrPoints_Destroy() to free it when you're done using it.

MR_MeshOrPointsObject_OffsetMutablePtr()

MRC_API MR_MeshOrPointsObject * MR_MeshOrPointsObject_OffsetMutablePtr	(	MR_MeshOrPointsObject *	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_MeshOrPointsObject_OffsetPtr()

MRC_API const MR_MeshOrPointsObject * MR_MeshOrPointsObject_OffsetPtr	(	const MR_MeshOrPointsObject *	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_MeshOrPointsObject_reset()

MRC_API void MR_MeshOrPointsObject_reset

(

MR_MeshOrPointsObject *

_this

)

Generated from method MR::MeshOrPointsObject::reset. Parameter _this can not be null. It is a single object.

MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectMesh()

MRC_API void MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectMesh	(	MR_MeshOrPointsObject *	_this,
		MR_PassBy	om_pass_by,
		MR_std_shared_ptr_MR_ObjectMesh *	om )

set to hold ObjectMesh Generated from method MR::MeshOrPointsObject::set. Parameter _this can not be null. It is a single object.

MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectPoints()

MRC_API void MR_MeshOrPointsObject_set_std_shared_ptr_MR_ObjectPoints	(	MR_MeshOrPointsObject *	_this,
		MR_PassBy	op_pass_by,
		MR_std_shared_ptr_MR_ObjectPoints *	op )

set to hold ObjectPoints Generated from method MR::MeshOrPointsObject::set. Parameter _this can not be null. It is a single object.