MRPointOnObject.h File Reference

#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_PointOnFace	MR_PointOnFace
typedef struct MR_VisualObject	MR_VisualObject
typedef struct MR_std_optional_MR_Vector3f	MR_std_optional_MR_Vector3f
typedef struct MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId	MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId
typedef struct MR_PointOnObject	MR_PointOnObject

Functions
MRC_API const MR_Vector3f *	MR_PointOnObject_Get_point (const MR_PointOnObject *_this)
MRC_API void	MR_PointOnObject_Set_point (MR_PointOnObject *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_PointOnObject_GetMutable_point (MR_PointOnObject *_this)
MRC_API const float *	MR_PointOnObject_Get_zBuffer (const MR_PointOnObject *_this)
MRC_API void	MR_PointOnObject_Set_zBuffer (MR_PointOnObject *_this, float value)
MRC_API float *	MR_PointOnObject_GetMutable_zBuffer (MR_PointOnObject *_this)
MRC_API MR_PointOnObject *	MR_PointOnObject_DefaultConstruct (void)
MRC_API MR_PointOnObject *	MR_PointOnObject_DefaultConstructArray (size_t num_elems)
MRC_API const MR_PointOnObject *	MR_PointOnObject_OffsetPtr (const MR_PointOnObject *ptr, ptrdiff_t i)
MRC_API MR_PointOnObject *	MR_PointOnObject_OffsetMutablePtr (MR_PointOnObject *ptr, ptrdiff_t i)
MRC_API MR_PointOnObject *	MR_PointOnObject_ConstructFromAnother (const MR_PointOnObject *_other)
MRC_API void	MR_PointOnObject_Destroy (const MR_PointOnObject *_this)
	Destroys a heap-allocated instance of MR_PointOnObject. Does nothing if the pointer is null.
MRC_API void	MR_PointOnObject_DestroyArray (const MR_PointOnObject *_this)
	Destroys a heap-allocated array of MR_PointOnObject. Does nothing if the pointer is null.
MRC_API MR_PointOnFace *	MR_PointOnObject_ConvertTo_MR_PointOnFace (const MR_PointOnObject *_this)
MRC_API MR_PointOnObject *	MR_PointOnObject_AssignFromAnother (MR_PointOnObject *_this, const MR_PointOnObject *_other)
MRC_API MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId *	MR_pointOnObjectToPickedPoint (const MR_VisualObject *object, const MR_PointOnObject *pos)
MRC_API MR_std_optional_MR_Vector3f *	MR_getPickedPointPosition (const MR_VisualObject *object, const MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId *point)
MRC_API MR_std_optional_MR_Vector3f *	MR_getPickedPointNormal (const MR_VisualObject *object, const MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId *point, const bool *interpolated)

Typedef Documentation

MR_PointOnFace

typedef struct MR_PointOnFace MR_PointOnFace

MR_PointOnObject

typedef struct MR_PointOnObject MR_PointOnObject

Generated from class MR::PointOnObject. 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_optional_MR_Vector3f

typedef struct MR_std_optional_MR_Vector3f MR_std_optional_MR_Vector3f

MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId

typedef struct MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId

MR_VisualObject

typedef struct MR_VisualObject MR_VisualObject

Function Documentation

MR_getPickedPointNormal()

MRC_API MR_std_optional_MR_Vector3f * MR_getPickedPointNormal	(	const MR_VisualObject *	object,
		const MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId *	point,
		const bool *	interpolated )

Returns object normal in local coordinates at given point,

Parameters

interpolated

if true returns interpolated normal for mesh object, otherwise returns flat normal returns std::nullopt if object or point is invalid, or if it is ObjectLines or ObjectPoints without normals Generated from function MR::getPickedPointNormal. Parameter object can not be null. It is a single object. Parameter point can not be null. It is a single object. Parameter interpolated has a default argument: true, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_Vector3f_Destroy() to free it when you're done using it.

MR_getPickedPointPosition()

MRC_API MR_std_optional_MR_Vector3f * MR_getPickedPointPosition	(	const MR_VisualObject *	object,
		const MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId *	point )

Converts given point into local coordinates of its object, returns std::nullopt if object or point is invalid, or if it does not present in the object's topology Generated from function MR::getPickedPointPosition. Parameter object can not be null. It is a single object. Parameter point can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_Vector3f_Destroy() to free it when you're done using it.

MR_PointOnObject_AssignFromAnother()

MRC_API MR_PointOnObject * MR_PointOnObject_AssignFromAnother	(	MR_PointOnObject *	_this,
		const MR_PointOnObject *	_other )

Generated from method MR::PointOnObject::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_PointOnObject_ConstructFromAnother()

MRC_API MR_PointOnObject * MR_PointOnObject_ConstructFromAnother

(

const MR_PointOnObject *

_other

)

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

MR_PointOnObject_ConvertTo_MR_PointOnFace()

MRC_API MR_PointOnFace * MR_PointOnObject_ConvertTo_MR_PointOnFace

(

const MR_PointOnObject *

_this

)

Generated from conversion operator MR::PointOnObject::operator MR::PointOnFace. Parameter _this can not be null. It is a single 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_PointOnObject_DefaultConstruct()

MRC_API MR_PointOnObject * MR_PointOnObject_DefaultConstruct

(

void

)

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

MR_PointOnObject_DefaultConstructArray()

MRC_API MR_PointOnObject * MR_PointOnObject_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_PointOnObject_DestroyArray(). Use MR_PointOnObject_OffsetMutablePtr() and MR_PointOnObject_OffsetPtr() to access the array elements.

MR_PointOnObject_Destroy()

MRC_API void MR_PointOnObject_Destroy

(

const MR_PointOnObject *

_this

)

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

MR_PointOnObject_DestroyArray()

MRC_API void MR_PointOnObject_DestroyArray

(

const MR_PointOnObject *

_this

)

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

MR_PointOnObject_Get_point()

MRC_API const MR_Vector3f * MR_PointOnObject_Get_point

(

const MR_PointOnObject *

_this

)

3D location on the object in local coordinates Returns a pointer to a member variable of class MR::PointOnObject 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_PointOnObject_Get_zBuffer()

MRC_API const float * MR_PointOnObject_Get_zBuffer

(

const MR_PointOnObject *

_this

)

z buffer value Returns a pointer to a member variable of class MR::PointOnObject named zBuffer. 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_PointOnObject_GetMutable_point()

MRC_API MR_Vector3f * MR_PointOnObject_GetMutable_point

(

MR_PointOnObject *

_this

)

3D location on the object in local coordinates Returns a mutable pointer to a member variable of class MR::PointOnObject 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_PointOnObject_GetMutable_zBuffer()

MRC_API float * MR_PointOnObject_GetMutable_zBuffer

(

MR_PointOnObject *

_this

)

z buffer value Returns a mutable pointer to a member variable of class MR::PointOnObject named zBuffer. 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_PointOnObject_OffsetMutablePtr()

MRC_API MR_PointOnObject * MR_PointOnObject_OffsetMutablePtr	(	MR_PointOnObject *	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_PointOnObject_OffsetPtr()

MRC_API const MR_PointOnObject * MR_PointOnObject_OffsetPtr	(	const MR_PointOnObject *	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_PointOnObject_Set_point()

MRC_API void MR_PointOnObject_Set_point	(	MR_PointOnObject *	_this,
		MR_Vector3f	value )

3D location on the object in local coordinates Modifies a member variable of class MR::PointOnObject 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_PointOnObject_Set_zBuffer()

MRC_API void MR_PointOnObject_Set_zBuffer	(	MR_PointOnObject *	_this,
		float	value )

z buffer value Modifies a member variable of class MR::PointOnObject named zBuffer. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in zBuffer.

MR_pointOnObjectToPickedPoint()

MRC_API MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId * MR_pointOnObjectToPickedPoint	(	const MR_VisualObject *	object,
		const MR_PointOnObject *	pos )

Converts PointOnObject coordinates depending on the object type to the PickedPoint variant Generated from function MR::pointOnObjectToPickedPoint. Parameter pos can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_variant_std_monostate_MR_MeshTriPoint_MR_EdgePoint_MR_VertId_Destroy() to free it when you're done using it.