MREndMill.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_Mesh	MR_Mesh
typedef struct MR_EndMillCutter	MR_EndMillCutter
typedef enum MR_EndMillCutter_Type	MR_EndMillCutter_Type
	cutter type
typedef struct MR_EndMillTool	MR_EndMillTool

Enumerations
enum	MR_EndMillCutter_Type {   MR_EndMillCutter_Type_Flat = 0 , MR_EndMillCutter_Type_Ball = 1 , MR_EndMillCutter_Type_BullNose = 2 , MR_EndMillCutter_Type_Chamfer = 3 ,   MR_EndMillCutter_Type_Count = 4 }
	cutter type More...

Functions
MRC_API const MR_EndMillCutter_Type *	MR_EndMillCutter_Get_type (const MR_EndMillCutter *_this)
MRC_API void	MR_EndMillCutter_Set_type (MR_EndMillCutter *_this, MR_EndMillCutter_Type value)
MRC_API MR_EndMillCutter_Type *	MR_EndMillCutter_GetMutable_type (MR_EndMillCutter *_this)
MRC_API const float *	MR_EndMillCutter_Get_cornerRadius (const MR_EndMillCutter *_this)
MRC_API void	MR_EndMillCutter_Set_cornerRadius (MR_EndMillCutter *_this, float value)
MRC_API float *	MR_EndMillCutter_GetMutable_cornerRadius (MR_EndMillCutter *_this)
MRC_API const float *	MR_EndMillCutter_Get_cuttingAngle (const MR_EndMillCutter *_this)
MRC_API void	MR_EndMillCutter_Set_cuttingAngle (MR_EndMillCutter *_this, float value)
MRC_API float *	MR_EndMillCutter_GetMutable_cuttingAngle (MR_EndMillCutter *_this)
MRC_API const float *	MR_EndMillCutter_Get_endDiameter (const MR_EndMillCutter *_this)
MRC_API void	MR_EndMillCutter_Set_endDiameter (MR_EndMillCutter *_this, float value)
MRC_API float *	MR_EndMillCutter_GetMutable_endDiameter (MR_EndMillCutter *_this)
MRC_API MR_EndMillCutter *	MR_EndMillCutter_DefaultConstruct (void)
MRC_API MR_EndMillCutter *	MR_EndMillCutter_DefaultConstructArray (size_t num_elems)
MRC_API MR_EndMillCutter *	MR_EndMillCutter_ConstructFrom (MR_EndMillCutter_Type type, float cornerRadius, float cuttingAngle, float endDiameter)
MRC_API const MR_EndMillCutter *	MR_EndMillCutter_OffsetPtr (const MR_EndMillCutter *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_EndMillCutter *	MR_EndMillCutter_OffsetMutablePtr (MR_EndMillCutter *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_EndMillCutter *	MR_EndMillCutter_ConstructFromAnother (const MR_EndMillCutter *_other)
MRC_API void	MR_EndMillCutter_Destroy (const MR_EndMillCutter *_this)
	Destroys a heap-allocated instance of MR_EndMillCutter. Does nothing if the pointer is null.
MRC_API void	MR_EndMillCutter_DestroyArray (const MR_EndMillCutter *_this)
	Destroys a heap-allocated array of MR_EndMillCutter. Does nothing if the pointer is null.
MRC_API MR_EndMillCutter *	MR_EndMillCutter_AssignFromAnother (MR_EndMillCutter *_this, const MR_EndMillCutter *_other)
MRC_API const float *	MR_EndMillTool_Get_length (const MR_EndMillTool *_this)
MRC_API void	MR_EndMillTool_Set_length (MR_EndMillTool *_this, float value)
MRC_API float *	MR_EndMillTool_GetMutable_length (MR_EndMillTool *_this)
MRC_API const float *	MR_EndMillTool_Get_diameter (const MR_EndMillTool *_this)
MRC_API void	MR_EndMillTool_Set_diameter (MR_EndMillTool *_this, float value)
MRC_API float *	MR_EndMillTool_GetMutable_diameter (MR_EndMillTool *_this)
MRC_API const MR_EndMillCutter *	MR_EndMillTool_Get_cutter (const MR_EndMillTool *_this)
MRC_API void	MR_EndMillTool_Set_cutter (MR_EndMillTool *_this, const MR_EndMillCutter *value)
MRC_API MR_EndMillCutter *	MR_EndMillTool_GetMutable_cutter (MR_EndMillTool *_this)
MRC_API MR_EndMillTool *	MR_EndMillTool_DefaultConstruct (void)
MRC_API MR_EndMillTool *	MR_EndMillTool_DefaultConstructArray (size_t num_elems)
MRC_API MR_EndMillTool *	MR_EndMillTool_ConstructFrom (float length, float diameter, const MR_EndMillCutter *cutter)
MRC_API const MR_EndMillTool *	MR_EndMillTool_OffsetPtr (const MR_EndMillTool *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_EndMillTool *	MR_EndMillTool_OffsetMutablePtr (MR_EndMillTool *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_EndMillTool *	MR_EndMillTool_ConstructFromAnother (const MR_EndMillTool *_other)
MRC_API void	MR_EndMillTool_Destroy (const MR_EndMillTool *_this)
	Destroys a heap-allocated instance of MR_EndMillTool. Does nothing if the pointer is null.
MRC_API void	MR_EndMillTool_DestroyArray (const MR_EndMillTool *_this)
	Destroys a heap-allocated array of MR_EndMillTool. Does nothing if the pointer is null.
MRC_API MR_EndMillTool *	MR_EndMillTool_AssignFromAnother (MR_EndMillTool *_this, const MR_EndMillTool *_other)
MRC_API float	MR_EndMillTool_getMinimalCutLength (const MR_EndMillTool *_this)
MRC_API MR_Mesh *	MR_EndMillTool_toMesh (const MR_EndMillTool *_this, const int *horizontalResolution, const int *verticalResolution)

Typedef Documentation

MR_EndMillCutter

typedef struct MR_EndMillCutter MR_EndMillCutter

end mill cutter specifications Generated from class MR::EndMillCutter.

MR_EndMillCutter_Type

typedef enum MR_EndMillCutter_Type MR_EndMillCutter_Type

cutter type

MR_EndMillTool

typedef struct MR_EndMillTool MR_EndMillTool

end mill tool specifications Generated from class MR::EndMillTool.

MR_Mesh

typedef struct MR_Mesh MR_Mesh

Enumeration Type Documentation

MR_EndMillCutter_Type

enum MR_EndMillCutter_Type

cutter type

Enumerator
MR_EndMillCutter_Type_Flat	flat end mill
MR_EndMillCutter_Type_Ball	ball end mill
MR_EndMillCutter_Type_BullNose	bull nose end mill
MR_EndMillCutter_Type_Chamfer	chamfer end mill
MR_EndMillCutter_Type_Count	chamfer end mill

Function Documentation

MR_EndMillCutter_AssignFromAnother()

MRC_API MR_EndMillCutter * MR_EndMillCutter_AssignFromAnother	(	MR_EndMillCutter *	_this,
		const MR_EndMillCutter *	_other )

Generated from a method of class MR::EndMillCutter named operator=. Parameter _this can not be null. It is a single object. Parameter _other 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_EndMillCutter_ConstructFrom()

MRC_API MR_EndMillCutter * MR_EndMillCutter_ConstructFrom	(	MR_EndMillCutter_Type	type,
		float	cornerRadius,
		float	cuttingAngle,
		float	endDiameter )

Constructs MR::EndMillCutter elementwise. Never returns null. Returns an instance allocated on the heap! Must call MR_EndMillCutter_Destroy() to free it when you're done using it.

MR_EndMillCutter_ConstructFromAnother()

MRC_API MR_EndMillCutter * MR_EndMillCutter_ConstructFromAnother

(

const MR_EndMillCutter *

_other

)

Generated from a constructor of class MR::EndMillCutter. Parameter _other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_EndMillCutter_Destroy() to free it when you're done using it.

MR_EndMillCutter_DefaultConstruct()

MRC_API MR_EndMillCutter * MR_EndMillCutter_DefaultConstruct

(

void

)

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

MR_EndMillCutter_DefaultConstructArray()

MRC_API MR_EndMillCutter * MR_EndMillCutter_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_EndMillCutter_DestroyArray(). Use MR_EndMillCutter_OffsetMutablePtr() and MR_EndMillCutter_OffsetPtr() to access the array elements.

MR_EndMillCutter_Destroy()

MRC_API void MR_EndMillCutter_Destroy

(

const MR_EndMillCutter *

_this

)

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

MR_EndMillCutter_DestroyArray()

MRC_API void MR_EndMillCutter_DestroyArray

(

const MR_EndMillCutter *

_this

)

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

MR_EndMillCutter_Get_cornerRadius()

MRC_API const float * MR_EndMillCutter_Get_cornerRadius

(

const MR_EndMillCutter *

_this

)

(bull nose) corner radius Returns a pointer to a member variable of class MR::EndMillCutter named cornerRadius. 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_EndMillCutter_Get_cuttingAngle()

MRC_API const float * MR_EndMillCutter_Get_cuttingAngle

(

const MR_EndMillCutter *

_this

)

(chamfer) cutting angle Returns a pointer to a member variable of class MR::EndMillCutter named cuttingAngle. 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_EndMillCutter_Get_endDiameter()

MRC_API const float * MR_EndMillCutter_Get_endDiameter

(

const MR_EndMillCutter *

_this

)

(chamfer) end diameter Returns a pointer to a member variable of class MR::EndMillCutter named endDiameter. 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_EndMillCutter_Get_type()

MRC_API const MR_EndMillCutter_Type * MR_EndMillCutter_Get_type

(

const MR_EndMillCutter *

_this

)

Returns a pointer to a member variable of class MR::EndMillCutter named type. 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_EndMillCutter_GetMutable_cornerRadius()

MRC_API float * MR_EndMillCutter_GetMutable_cornerRadius

(

MR_EndMillCutter *

_this

)

(bull nose) corner radius Returns a mutable pointer to a member variable of class MR::EndMillCutter named cornerRadius. 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_EndMillCutter_GetMutable_cuttingAngle()

MRC_API float * MR_EndMillCutter_GetMutable_cuttingAngle

(

MR_EndMillCutter *

_this

)

(chamfer) cutting angle Returns a mutable pointer to a member variable of class MR::EndMillCutter named cuttingAngle. 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_EndMillCutter_GetMutable_endDiameter()

MRC_API float * MR_EndMillCutter_GetMutable_endDiameter

(

MR_EndMillCutter *

_this

)

(chamfer) end diameter Returns a mutable pointer to a member variable of class MR::EndMillCutter named endDiameter. 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_EndMillCutter_GetMutable_type()

MRC_API MR_EndMillCutter_Type * MR_EndMillCutter_GetMutable_type

(

MR_EndMillCutter *

_this

)

Returns a mutable pointer to a member variable of class MR::EndMillCutter named type. 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_EndMillCutter_OffsetMutablePtr()

MRC_API MR_EndMillCutter * MR_EndMillCutter_OffsetMutablePtr	(	MR_EndMillCutter *	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_EndMillCutter_OffsetPtr()

MRC_API const MR_EndMillCutter * MR_EndMillCutter_OffsetPtr	(	const MR_EndMillCutter *	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_EndMillCutter_Set_cornerRadius()

MRC_API void MR_EndMillCutter_Set_cornerRadius	(	MR_EndMillCutter *	_this,
		float	value )

(bull nose) corner radius Modifies a member variable of class MR::EndMillCutter named cornerRadius. Parameter _this can not be null. It is a single object.

MR_EndMillCutter_Set_cuttingAngle()

MRC_API void MR_EndMillCutter_Set_cuttingAngle	(	MR_EndMillCutter *	_this,
		float	value )

(chamfer) cutting angle Modifies a member variable of class MR::EndMillCutter named cuttingAngle. Parameter _this can not be null. It is a single object.

MR_EndMillCutter_Set_endDiameter()

MRC_API void MR_EndMillCutter_Set_endDiameter	(	MR_EndMillCutter *	_this,
		float	value )

(chamfer) end diameter Modifies a member variable of class MR::EndMillCutter named endDiameter. Parameter _this can not be null. It is a single object.

MR_EndMillCutter_Set_type()

MRC_API void MR_EndMillCutter_Set_type	(	MR_EndMillCutter *	_this,
		MR_EndMillCutter_Type	value )

Modifies a member variable of class MR::EndMillCutter named type. Parameter _this can not be null. It is a single object.

MR_EndMillTool_AssignFromAnother()

MRC_API MR_EndMillTool * MR_EndMillTool_AssignFromAnother	(	MR_EndMillTool *	_this,
		const MR_EndMillTool *	_other )

Generated from a method of class MR::EndMillTool named operator=. Parameter _this can not be null. It is a single object. Parameter _other 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_EndMillTool_ConstructFrom()

MRC_API MR_EndMillTool * MR_EndMillTool_ConstructFrom	(	float	length,
		float	diameter,
		const MR_EndMillCutter *	cutter )

Constructs MR::EndMillTool elementwise. Parameter cutter can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_EndMillTool_Destroy() to free it when you're done using it.

MR_EndMillTool_ConstructFromAnother()

MRC_API MR_EndMillTool * MR_EndMillTool_ConstructFromAnother

(

const MR_EndMillTool *

_other

)

Generated from a constructor of class MR::EndMillTool. Parameter _other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_EndMillTool_Destroy() to free it when you're done using it.

MR_EndMillTool_DefaultConstruct()

MRC_API MR_EndMillTool * MR_EndMillTool_DefaultConstruct

(

void

)

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

MR_EndMillTool_DefaultConstructArray()

MRC_API MR_EndMillTool * MR_EndMillTool_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_EndMillTool_DestroyArray(). Use MR_EndMillTool_OffsetMutablePtr() and MR_EndMillTool_OffsetPtr() to access the array elements.

MR_EndMillTool_Destroy()

MRC_API void MR_EndMillTool_Destroy

(

const MR_EndMillTool *

_this

)

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

MR_EndMillTool_DestroyArray()

MRC_API void MR_EndMillTool_DestroyArray

(

const MR_EndMillTool *

_this

)

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

MR_EndMillTool_Get_cutter()

MRC_API const MR_EndMillCutter * MR_EndMillTool_Get_cutter

(

const MR_EndMillTool *

_this

)

cutter Returns a pointer to a member variable of class MR::EndMillTool named cutter. 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_EndMillTool_Get_diameter()

MRC_API const float * MR_EndMillTool_Get_diameter

(

const MR_EndMillTool *

_this

)

tool diameter Returns a pointer to a member variable of class MR::EndMillTool named diameter. 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_EndMillTool_Get_length()

MRC_API const float * MR_EndMillTool_Get_length

(

const MR_EndMillTool *

_this

)

overall tool length Returns a pointer to a member variable of class MR::EndMillTool named length. 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_EndMillTool_getMinimalCutLength()

MRC_API float MR_EndMillTool_getMinimalCutLength

(

const MR_EndMillTool *

_this

)

compute the minimal cut length based on the cutter parameters Generated from a method of class MR::EndMillTool named getMinimalCutLength. Parameter _this can not be null. It is a single object.

MR_EndMillTool_GetMutable_cutter()

MRC_API MR_EndMillCutter * MR_EndMillTool_GetMutable_cutter

(

MR_EndMillTool *

_this

)

cutter Returns a mutable pointer to a member variable of class MR::EndMillTool named cutter. 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_EndMillTool_GetMutable_diameter()

MRC_API float * MR_EndMillTool_GetMutable_diameter

(

MR_EndMillTool *

_this

)

tool diameter Returns a mutable pointer to a member variable of class MR::EndMillTool named diameter. 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_EndMillTool_GetMutable_length()

MRC_API float * MR_EndMillTool_GetMutable_length

(

MR_EndMillTool *

_this

)

overall tool length Returns a mutable pointer to a member variable of class MR::EndMillTool named length. 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_EndMillTool_OffsetMutablePtr()

MRC_API MR_EndMillTool * MR_EndMillTool_OffsetMutablePtr	(	MR_EndMillTool *	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_EndMillTool_OffsetPtr()

MRC_API const MR_EndMillTool * MR_EndMillTool_OffsetPtr	(	const MR_EndMillTool *	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_EndMillTool_Set_cutter()

MRC_API void MR_EndMillTool_Set_cutter	(	MR_EndMillTool *	_this,
		const MR_EndMillCutter *	value )

cutter Modifies a member variable of class MR::EndMillTool named cutter. Parameter _this can not be null. It is a single object. Parameter value can not be null. It is a single object.

MR_EndMillTool_Set_diameter()

MRC_API void MR_EndMillTool_Set_diameter	(	MR_EndMillTool *	_this,
		float	value )

tool diameter Modifies a member variable of class MR::EndMillTool named diameter. Parameter _this can not be null. It is a single object.

MR_EndMillTool_Set_length()

MRC_API void MR_EndMillTool_Set_length	(	MR_EndMillTool *	_this,
		float	value )

overall tool length Modifies a member variable of class MR::EndMillTool named length. Parameter _this can not be null. It is a single object.

MR_EndMillTool_toMesh()

MRC_API MR_Mesh * MR_EndMillTool_toMesh	(	const MR_EndMillTool *	_this,
		const int *	horizontalResolution,
		const int *	verticalResolution )

create a tool mesh Generated from a method of class MR::EndMillTool named toMesh. Parameter _this can not be null. It is a single object. Parameter horizontalResolution has a default argument: 32, pass a null pointer to use it. Parameter verticalResolution has a default argument: 32, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_Mesh_Destroy() to free it when you're done using it.