MRSegmPoint.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_SegmPointd	MR_SegmPointd
	encodes a point inside a line segment using relative distance in [0,1] Generated from class MR::SegmPointd. 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).

Functions
MRC_API const float *	MR_SegmPointf_Get_eps (void)
MRC_API const float *	MR_SegmPointf_Get_a (const MR_SegmPointf *_this)
MRC_API void	MR_SegmPointf_Set_a (MR_SegmPointf *_this, float value)
MRC_API float *	MR_SegmPointf_GetMutable_a (MR_SegmPointf *_this)
MRC_API MR_SegmPointf *	MR_SegmPointf_DefaultConstruct (void)
MRC_API MR_SegmPointf *	MR_SegmPointf_DefaultConstructArray (size_t num_elems)
MRC_API const MR_SegmPointf *	MR_SegmPointf_OffsetPtr (const MR_SegmPointf *ptr, ptrdiff_t i)
MRC_API MR_SegmPointf *	MR_SegmPointf_OffsetMutablePtr (MR_SegmPointf *ptr, ptrdiff_t i)
MRC_API MR_SegmPointf *	MR_SegmPointf_ConstructFromAnother (const MR_SegmPointf *_other)
MRC_API MR_SegmPointf *	MR_SegmPointf_Construct (float a)
MRC_API void	MR_SegmPointf_Destroy (const MR_SegmPointf *_this)
	Destroys a heap-allocated instance of MR_SegmPointf. Does nothing if the pointer is null.
MRC_API void	MR_SegmPointf_DestroyArray (const MR_SegmPointf *_this)
	Destroys a heap-allocated array of MR_SegmPointf. Does nothing if the pointer is null.
MRC_API float	MR_SegmPointf_ConvertTo_float (const MR_SegmPointf *_this)
MRC_API float *	MR_SegmPointf_ConvertTo_float_ref (MR_SegmPointf *_this)
MRC_API MR_SegmPointf *	MR_SegmPointf_AssignFromAnother (MR_SegmPointf *_this, const MR_SegmPointf *_other)
MRC_API int	MR_SegmPointf_inVertex (const MR_SegmPointf *_this)
MRC_API MR_SegmPointf *	MR_SegmPointf_sym (const MR_SegmPointf *_this)
MRC_API bool	MR_equal_MR_SegmPointf (const MR_SegmPointf *_this, const MR_SegmPointf *rhs)
MRC_API bool	MR_equal_MR_SegmPointf_float (const MR_SegmPointf *_this, float rhs)
MRC_API const double *	MR_SegmPointd_Get_eps (void)
MRC_API const double *	MR_SegmPointd_Get_a (const MR_SegmPointd *_this)
MRC_API void	MR_SegmPointd_Set_a (MR_SegmPointd *_this, double value)
MRC_API double *	MR_SegmPointd_GetMutable_a (MR_SegmPointd *_this)
MRC_API MR_SegmPointd *	MR_SegmPointd_DefaultConstruct (void)
MRC_API MR_SegmPointd *	MR_SegmPointd_DefaultConstructArray (size_t num_elems)
MRC_API const MR_SegmPointd *	MR_SegmPointd_OffsetPtr (const MR_SegmPointd *ptr, ptrdiff_t i)
MRC_API MR_SegmPointd *	MR_SegmPointd_OffsetMutablePtr (MR_SegmPointd *ptr, ptrdiff_t i)
MRC_API MR_SegmPointd *	MR_SegmPointd_ConstructFromAnother (const MR_SegmPointd *_other)
MRC_API MR_SegmPointd *	MR_SegmPointd_Construct (double a)
MRC_API void	MR_SegmPointd_Destroy (const MR_SegmPointd *_this)
	Destroys a heap-allocated instance of MR_SegmPointd. Does nothing if the pointer is null.
MRC_API void	MR_SegmPointd_DestroyArray (const MR_SegmPointd *_this)
	Destroys a heap-allocated array of MR_SegmPointd. Does nothing if the pointer is null.
MRC_API double	MR_SegmPointd_ConvertTo_double (const MR_SegmPointd *_this)
MRC_API double *	MR_SegmPointd_ConvertTo_double_ref (MR_SegmPointd *_this)
MRC_API MR_SegmPointd *	MR_SegmPointd_AssignFromAnother (MR_SegmPointd *_this, const MR_SegmPointd *_other)
MRC_API int	MR_SegmPointd_inVertex (const MR_SegmPointd *_this)
MRC_API MR_SegmPointd *	MR_SegmPointd_sym (const MR_SegmPointd *_this)
MRC_API bool	MR_equal_MR_SegmPointd (const MR_SegmPointd *_this, const MR_SegmPointd *rhs)
MRC_API bool	MR_equal_MR_SegmPointd_double (const MR_SegmPointd *_this, double rhs)

Typedef Documentation

MR_SegmPointd

typedef struct MR_SegmPointd MR_SegmPointd

encodes a point inside a line segment using relative distance in [0,1] Generated from class MR::SegmPointd. 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_equal_MR_SegmPointd()

MRC_API bool MR_equal_MR_SegmPointd	(	const MR_SegmPointd *	_this,
		const MR_SegmPointd *	rhs )

returns true if two points have equal (a) representation Generated from method MR::SegmPointd::operator==. Parameter _this can not be null. It is a single object. Parameter rhs can not be null. It is a single object.

MR_equal_MR_SegmPointd_double()

MRC_API bool MR_equal_MR_SegmPointd_double	(	const MR_SegmPointd *	_this,
		double	rhs )

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

MR_equal_MR_SegmPointf()

MRC_API bool MR_equal_MR_SegmPointf	(	const MR_SegmPointf *	_this,
		const MR_SegmPointf *	rhs )

returns true if two points have equal (a) representation Generated from method MR::SegmPointf::operator==. Parameter _this can not be null. It is a single object. Parameter rhs can not be null. It is a single object.

MR_equal_MR_SegmPointf_float()

MRC_API bool MR_equal_MR_SegmPointf_float	(	const MR_SegmPointf *	_this,
		float	rhs )

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

MR_SegmPointd_AssignFromAnother()

MRC_API MR_SegmPointd * MR_SegmPointd_AssignFromAnother	(	MR_SegmPointd *	_this,
		const MR_SegmPointd *	_other )

Generated from method MR::SegmPointd::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_SegmPointd_Construct()

MRC_API MR_SegmPointd * MR_SegmPointd_Construct

(

double

a

)

Generated from constructor MR::SegmPointd::SegmPointd. Never returns null. Returns an instance allocated on the heap! Must call MR_SegmPointd_Destroy() to free it when you're done using it.

MR_SegmPointd_ConstructFromAnother()

MRC_API MR_SegmPointd * MR_SegmPointd_ConstructFromAnother

(

const MR_SegmPointd *

_other

)

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

MR_SegmPointd_ConvertTo_double()

MRC_API double MR_SegmPointd_ConvertTo_double

(

const MR_SegmPointd *

_this

)

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

MR_SegmPointd_ConvertTo_double_ref()

MRC_API double * MR_SegmPointd_ConvertTo_double_ref

(

MR_SegmPointd *

_this

)

Generated from conversion operator MR::SegmPointd::operator double &. 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_SegmPointd_DefaultConstruct()

MRC_API MR_SegmPointd * MR_SegmPointd_DefaultConstruct

(

void

)

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

MR_SegmPointd_DefaultConstructArray()

MRC_API MR_SegmPointd * MR_SegmPointd_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_SegmPointd_DestroyArray(). Use MR_SegmPointd_OffsetMutablePtr() and MR_SegmPointd_OffsetPtr() to access the array elements.

MR_SegmPointd_Destroy()

MRC_API void MR_SegmPointd_Destroy

(

const MR_SegmPointd *

_this

)

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

MR_SegmPointd_DestroyArray()

MRC_API void MR_SegmPointd_DestroyArray

(

const MR_SegmPointd *

_this

)

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

MR_SegmPointd_Get_a()

MRC_API const double * MR_SegmPointd_Get_a

(

const MR_SegmPointd *

_this

)

a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Modifies a member variable of class MR::SegmPointd named a. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in a.

MR_SegmPointd_Get_eps()

MRC_API const double * MR_SegmPointd_Get_eps

(

void

)

Returns a pointer to a member variable of class MR::SegmPointd named eps. The returned pointer will never be null. It is non-owning, do NOT destroy it. a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Returns a pointer to a member variable of class MR::SegmPointd named a. 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. The reference to this object might be preserved as the return value.

MR_SegmPointd_GetMutable_a()

MRC_API double * MR_SegmPointd_GetMutable_a

(

MR_SegmPointd *

_this

)

MR_SegmPointd_inVertex()

MRC_API int MR_SegmPointd_inVertex

(

const MR_SegmPointd *

_this

)

returns [0,1] if the point is in a vertex or -1 otherwise Generated from method MR::SegmPointd::inVertex. Parameter _this can not be null. It is a single object.

MR_SegmPointd_OffsetMutablePtr()

MRC_API MR_SegmPointd * MR_SegmPointd_OffsetMutablePtr	(	MR_SegmPointd *	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_SegmPointd_OffsetPtr()

MRC_API const MR_SegmPointd * MR_SegmPointd_OffsetPtr	(	const MR_SegmPointd *	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_SegmPointd_Set_a()

MRC_API void MR_SegmPointd_Set_a	(	MR_SegmPointd *	_this,
		double	value )

a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Returns a mutable pointer to a member variable of class MR::SegmPointd named a. 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. The reference to this object might be preserved as the return value.

MR_SegmPointd_sym()

MRC_API MR_SegmPointd * MR_SegmPointd_sym

(

const MR_SegmPointd *

_this

)

represents the same point relative to oppositely directed segment Generated from method MR::SegmPointd::sym. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_SegmPointd_Destroy() to free it when you're done using it.

MR_SegmPointf_AssignFromAnother()

MRC_API MR_SegmPointf * MR_SegmPointf_AssignFromAnother	(	MR_SegmPointf *	_this,
		const MR_SegmPointf *	_other )

Generated from method MR::SegmPointf::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_SegmPointf_Construct()

MRC_API MR_SegmPointf * MR_SegmPointf_Construct

(

float

a

)

Generated from constructor MR::SegmPointf::SegmPointf. Never returns null. Returns an instance allocated on the heap! Must call MR_SegmPointf_Destroy() to free it when you're done using it.

MR_SegmPointf_ConstructFromAnother()

MRC_API MR_SegmPointf * MR_SegmPointf_ConstructFromAnother

(

const MR_SegmPointf *

_other

)

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

MR_SegmPointf_ConvertTo_float()

MRC_API float MR_SegmPointf_ConvertTo_float

(

const MR_SegmPointf *

_this

)

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

MR_SegmPointf_ConvertTo_float_ref()

MRC_API float * MR_SegmPointf_ConvertTo_float_ref

(

MR_SegmPointf *

_this

)

Generated from conversion operator MR::SegmPointf::operator float &. 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_SegmPointf_DefaultConstruct()

MRC_API MR_SegmPointf * MR_SegmPointf_DefaultConstruct

(

void

)

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

MR_SegmPointf_DefaultConstructArray()

MRC_API MR_SegmPointf * MR_SegmPointf_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_SegmPointf_DestroyArray(). Use MR_SegmPointf_OffsetMutablePtr() and MR_SegmPointf_OffsetPtr() to access the array elements.

MR_SegmPointf_Destroy()

MRC_API void MR_SegmPointf_Destroy

(

const MR_SegmPointf *

_this

)

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

MR_SegmPointf_DestroyArray()

MRC_API void MR_SegmPointf_DestroyArray

(

const MR_SegmPointf *

_this

)

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

MR_SegmPointf_Get_a()

MRC_API const float * MR_SegmPointf_Get_a

(

const MR_SegmPointf *

_this

)

a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Modifies a member variable of class MR::SegmPointf named a. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in a.

MR_SegmPointf_Get_eps()

MRC_API const float * MR_SegmPointf_Get_eps

(

void

)

Returns a pointer to a member variable of class MR::SegmPointf named eps. The returned pointer will never be null. It is non-owning, do NOT destroy it. a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Returns a pointer to a member variable of class MR::SegmPointf named a. 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. The reference to this object might be preserved as the return value.

MR_SegmPointf_GetMutable_a()

MRC_API float * MR_SegmPointf_GetMutable_a

(

MR_SegmPointf *

_this

)

MR_SegmPointf_inVertex()

MRC_API int MR_SegmPointf_inVertex

(

const MR_SegmPointf *

_this

)

returns [0,1] if the point is in a vertex or -1 otherwise Generated from method MR::SegmPointf::inVertex. Parameter _this can not be null. It is a single object.

MR_SegmPointf_OffsetMutablePtr()

MRC_API MR_SegmPointf * MR_SegmPointf_OffsetMutablePtr	(	MR_SegmPointf *	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_SegmPointf_OffsetPtr()

MRC_API const MR_SegmPointf * MR_SegmPointf_OffsetPtr	(	const MR_SegmPointf *	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_SegmPointf_Set_a()

MRC_API void MR_SegmPointf_Set_a	(	MR_SegmPointf *	_this,
		float	value )

a in [0,1], a=0 => point is in v0, a=1 => point is in v1 Returns a mutable pointer to a member variable of class MR::SegmPointf named a. 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. The reference to this object might be preserved as the return value.

MR_SegmPointf_sym()

MRC_API MR_SegmPointf * MR_SegmPointf_sym

(

const MR_SegmPointf *

_this

)

represents the same point relative to oppositely directed segment Generated from method MR::SegmPointf::sym. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_SegmPointf_Destroy() to free it when you're done using it.