std_variant_float_MR_Vector3f.h File Reference

#include <MRCMesh/MRVector3.h>
#include <MRCMisc/exports.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_variant_float_MR_Vector3f	MR_std_variant_float_MR_Vector3f

Functions
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_DefaultConstruct (void)
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_ConstructFromAnother (const MR_std_variant_float_MR_Vector3f *other)
MRC_API void	MR_std_variant_float_MR_Vector3f_AssignFromAnother (MR_std_variant_float_MR_Vector3f *_this, const MR_std_variant_float_MR_Vector3f *other)
MRC_API void	MR_std_variant_float_MR_Vector3f_Destroy (const MR_std_variant_float_MR_Vector3f *_this)
	Destroys a heap-allocated instance of MR_std_variant_float_MR_Vector3f. Does nothing if the pointer is null.
MRC_API void	MR_std_variant_float_MR_Vector3f_DestroyArray (const MR_std_variant_float_MR_Vector3f *_this)
	Destroys a heap-allocated array of MR_std_variant_float_MR_Vector3f. Does nothing if the pointer is null.
MRC_API const MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_OffsetPtr (const MR_std_variant_float_MR_Vector3f *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.
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_OffsetMutablePtr (MR_std_variant_float_MR_Vector3f *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.
MRC_API size_t	MR_std_variant_float_MR_Vector3f_Index (const MR_std_variant_float_MR_Vector3f *_this)
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_ConstructAs_float (float value)
MRC_API MR_std_variant_float_MR_Vector3f *	MR_std_variant_float_MR_Vector3f_ConstructAs_MR_Vector3f (MR_Vector3f value)
MRC_API void	MR_std_variant_float_MR_Vector3f_AssignAs_float (MR_std_variant_float_MR_Vector3f *_this, float value)
MRC_API void	MR_std_variant_float_MR_Vector3f_AssignAs_MR_Vector3f (MR_std_variant_float_MR_Vector3f *_this, MR_Vector3f value)
MRC_API const float *	MR_std_variant_float_MR_Vector3f_Get_float (const MR_std_variant_float_MR_Vector3f *_this)
MRC_API float *	MR_std_variant_float_MR_Vector3f_GetMutable_float (MR_std_variant_float_MR_Vector3f *_this)
MRC_API const MR_Vector3f *	MR_std_variant_float_MR_Vector3f_Get_MR_Vector3f (const MR_std_variant_float_MR_Vector3f *_this)
MRC_API MR_Vector3f *	MR_std_variant_float_MR_Vector3f_GetMutable_MR_Vector3f (MR_std_variant_float_MR_Vector3f *_this)

Typedef Documentation

MR_std_variant_float_MR_Vector3f

typedef struct MR_std_variant_float_MR_Vector3f MR_std_variant_float_MR_Vector3f

Stores one of 2 objects: float, MR::Vector3f. 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_std_variant_float_MR_Vector3f_AssignAs_float()

MRC_API void MR_std_variant_float_MR_Vector3f_AssignAs_float	(	MR_std_variant_float_MR_Vector3f *	_this,
		float	value )

Assigns to the variant, making it store the element 0, of type float. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_AssignAs_MR_Vector3f()

MRC_API void MR_std_variant_float_MR_Vector3f_AssignAs_MR_Vector3f	(	MR_std_variant_float_MR_Vector3f *	_this,
		MR_Vector3f	value )

Assigns to the variant, making it store the element 1, of type MR::Vector3f. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_AssignFromAnother()

MRC_API void MR_std_variant_float_MR_Vector3f_AssignFromAnother	(	MR_std_variant_float_MR_Vector3f *	_this,
		const MR_std_variant_float_MR_Vector3f *	other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_ConstructAs_float()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_ConstructAs_float

(

float

value

)

Constructs the variant storing the element 0, of type float. Never returns null. Returns an instance allocated on the heap! Must call MR_std_variant_float_MR_Vector3f_Destroy() to free it when you're done using it.

MR_std_variant_float_MR_Vector3f_ConstructAs_MR_Vector3f()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_ConstructAs_MR_Vector3f

(

MR_Vector3f

value

)

Constructs the variant storing the element 1, of type MR::Vector3f. Never returns null. Returns an instance allocated on the heap! Must call MR_std_variant_float_MR_Vector3f_Destroy() to free it when you're done using it.

MR_std_variant_float_MR_Vector3f_ConstructFromAnother()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_ConstructFromAnother

(

const MR_std_variant_float_MR_Vector3f *

other

)

Constructs a copy of another instance. The source remains alive. Parameter other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_variant_float_MR_Vector3f_Destroy() to free it when you're done using it.

MR_std_variant_float_MR_Vector3f_DefaultConstruct()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_DefaultConstruct

(

void

)

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

MR_std_variant_float_MR_Vector3f_DefaultConstructArray()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_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_std_variant_float_MR_Vector3f_DestroyArray(). Use MR_std_variant_float_MR_Vector3f_OffsetMutablePtr() and MR_std_variant_float_MR_Vector3f_OffsetPtr() to access the array elements.

MR_std_variant_float_MR_Vector3f_Destroy()

MRC_API void MR_std_variant_float_MR_Vector3f_Destroy

(

const MR_std_variant_float_MR_Vector3f *

_this

)

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

MR_std_variant_float_MR_Vector3f_DestroyArray()

MRC_API void MR_std_variant_float_MR_Vector3f_DestroyArray

(

const MR_std_variant_float_MR_Vector3f *

_this

)

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

MR_std_variant_float_MR_Vector3f_Get_float()

MRC_API const float * MR_std_variant_float_MR_Vector3f_Get_float

(

const MR_std_variant_float_MR_Vector3f *

_this

)

Returns the element 0, of type float, read-only. If it's not the active element, returns null. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_Get_MR_Vector3f()

MRC_API const MR_Vector3f * MR_std_variant_float_MR_Vector3f_Get_MR_Vector3f

(

const MR_std_variant_float_MR_Vector3f *

_this

)

Returns the element 1, of type MR::Vector3f, read-only. If it's not the active element, returns null. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_GetMutable_float()

MRC_API float * MR_std_variant_float_MR_Vector3f_GetMutable_float

(

MR_std_variant_float_MR_Vector3f *

_this

)

Returns the element 0, of type float, mutable. If it's not the active element, returns null. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_GetMutable_MR_Vector3f()

MRC_API MR_Vector3f * MR_std_variant_float_MR_Vector3f_GetMutable_MR_Vector3f

(

MR_std_variant_float_MR_Vector3f *

_this

)

Returns the element 1, of type MR::Vector3f, mutable. If it's not the active element, returns null. Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_Index()

MRC_API size_t MR_std_variant_float_MR_Vector3f_Index

(

const MR_std_variant_float_MR_Vector3f *

_this

)

Returns the index of the stored element type. In rare cases may return -1 if this variant is "valueless by exception". Parameter _this can not be null. It is a single object.

MR_std_variant_float_MR_Vector3f_OffsetMutablePtr()

MRC_API MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_OffsetMutablePtr	(	MR_std_variant_float_MR_Vector3f *	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.

MR_std_variant_float_MR_Vector3f_OffsetPtr()

MRC_API const MR_std_variant_float_MR_Vector3f * MR_std_variant_float_MR_Vector3f_OffsetPtr	(	const MR_std_variant_float_MR_Vector3f *	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.