MRHexPalette.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_array_MR_Color_30	MR_std_array_MR_Color_30
typedef struct MR_HexPalette	MR_HexPalette

Functions
MRC_API const int *	MR_HexPalette_Get_CORNER_COLORS (void)
MRC_API const int *	MR_HexPalette_Get_SIDE_COLORS (void)
MRC_API const int *	MR_HexPalette_Get_N (void)
MRC_API const int *	MR_HexPalette_Get_STEP (void)
MRC_API const MR_std_array_MR_Color_30 *	MR_HexPalette_Get_colors (void)
MRC_API MR_HexPalette *	MR_HexPalette_DefaultConstruct (void)
MRC_API MR_HexPalette *	MR_HexPalette_DefaultConstructArray (size_t num_elems)
MRC_API const MR_HexPalette *	MR_HexPalette_OffsetPtr (const MR_HexPalette *ptr, ptrdiff_t i)
MRC_API MR_HexPalette *	MR_HexPalette_OffsetMutablePtr (MR_HexPalette *ptr, ptrdiff_t i)
MRC_API MR_HexPalette *	MR_HexPalette_ConstructFromAnother (const MR_HexPalette *_other)
MRC_API void	MR_HexPalette_Destroy (const MR_HexPalette *_this)
	Destroys a heap-allocated instance of MR_HexPalette. Does nothing if the pointer is null.
MRC_API void	MR_HexPalette_DestroyArray (const MR_HexPalette *_this)
	Destroys a heap-allocated array of MR_HexPalette. Does nothing if the pointer is null.
MRC_API MR_HexPalette *	MR_HexPalette_AssignFromAnother (MR_HexPalette *_this, const MR_HexPalette *_other)
MRC_API MR_Color	MR_HexPalette_colorAtStep (int i)

Typedef Documentation

MR_HexPalette

typedef struct MR_HexPalette MR_HexPalette

all colors here are on cube's boundary intersected by a skew plane, which makes a hexagon; gives visually distinct categorical colors for things like mesh segments or imported components Generated from class MR::HexPalette. 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_array_MR_Color_30

typedef struct MR_std_array_MR_Color_30 MR_std_array_MR_Color_30

Function Documentation

MR_HexPalette_AssignFromAnother()

MRC_API MR_HexPalette * MR_HexPalette_AssignFromAnother	(	MR_HexPalette *	_this,
		const MR_HexPalette *	_other )

Generated from method MR::HexPalette::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_HexPalette_colorAtStep()

MRC_API MR_Color MR_HexPalette_colorAtStep

(

int

i

)

returns the i-th color in stride order, so successive i values give visually distinct colors Generated from method MR::HexPalette::colorAtStep.

MR_HexPalette_ConstructFromAnother()

MRC_API MR_HexPalette * MR_HexPalette_ConstructFromAnother

(

const MR_HexPalette *

_other

)

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

MR_HexPalette_DefaultConstruct()

MRC_API MR_HexPalette * MR_HexPalette_DefaultConstruct

(

void

)

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

MR_HexPalette_DefaultConstructArray()

MRC_API MR_HexPalette * MR_HexPalette_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_HexPalette_DestroyArray(). Use MR_HexPalette_OffsetMutablePtr() and MR_HexPalette_OffsetPtr() to access the array elements.

MR_HexPalette_Destroy()

MRC_API void MR_HexPalette_Destroy

(

const MR_HexPalette *

_this

)

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

MR_HexPalette_DestroyArray()

MRC_API void MR_HexPalette_DestroyArray

(

const MR_HexPalette *

_this

)

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

MR_HexPalette_Get_colors()

MRC_API const MR_std_array_MR_Color_30 * MR_HexPalette_Get_colors

(

void

)

the palette colors, populated at compile time Returns a pointer to a member variable of class MR::HexPalette named colors. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_HexPalette_Get_CORNER_COLORS()

MRC_API const int * MR_HexPalette_Get_CORNER_COLORS

(

void

)

Returns a pointer to a member variable of class MR::HexPalette named CORNER_COLORS. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_HexPalette_Get_N()

MRC_API const int * MR_HexPalette_Get_N

(

void

)

Returns a pointer to a member variable of class MR::HexPalette named N. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_HexPalette_Get_SIDE_COLORS()

MRC_API const int * MR_HexPalette_Get_SIDE_COLORS

(

void

)

Returns a pointer to a member variable of class MR::HexPalette named SIDE_COLORS. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_HexPalette_Get_STEP()

MRC_API const int * MR_HexPalette_Get_STEP

(

void

)

recommended step from previous color to next color, to have big visual difference, and visit all colors in long run Returns a pointer to a member variable of class MR::HexPalette named STEP. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_HexPalette_OffsetMutablePtr()

MRC_API MR_HexPalette * MR_HexPalette_OffsetMutablePtr	(	MR_HexPalette *	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_HexPalette_OffsetPtr()

MRC_API const MR_HexPalette * MR_HexPalette_OffsetPtr	(	const MR_HexPalette *	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.