MRCNCMachineSettings.h File Reference

#include <MRCMesh/MRVector2.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_Vector3f	MR_Vector3f
typedef struct MR_std_optional_MR_Vector2f	MR_std_optional_MR_Vector2f
typedef struct MR_std_vector_MR_CNCMachineSettings_RotationAxisName	MR_std_vector_MR_CNCMachineSettings_RotationAxisName
typedef enum MR_CNCMachineSettings_RotationAxisName	MR_CNCMachineSettings_RotationAxisName
typedef struct MR_CNCMachineSettings	MR_CNCMachineSettings

Enumerations
enum	MR_CNCMachineSettings_RotationAxisName { MR_CNCMachineSettings_RotationAxisName_A = 0 , MR_CNCMachineSettings_RotationAxisName_B = 1 , MR_CNCMachineSettings_RotationAxisName_C = 2 }

Functions
MRC_API MR_CNCMachineSettings *	MR_CNCMachineSettings_DefaultConstruct (void)
MRC_API MR_CNCMachineSettings *	MR_CNCMachineSettings_DefaultConstructArray (size_t num_elems)
MRC_API const MR_CNCMachineSettings *	MR_CNCMachineSettings_OffsetPtr (const MR_CNCMachineSettings *ptr, ptrdiff_t i)
MRC_API MR_CNCMachineSettings *	MR_CNCMachineSettings_OffsetMutablePtr (MR_CNCMachineSettings *ptr, ptrdiff_t i)
MRC_API MR_CNCMachineSettings *	MR_CNCMachineSettings_ConstructFromAnother (MR_PassBy _other_pass_by, MR_CNCMachineSettings *_other)
MRC_API void	MR_CNCMachineSettings_Destroy (const MR_CNCMachineSettings *_this)
	Destroys a heap-allocated instance of MR_CNCMachineSettings. Does nothing if the pointer is null.
MRC_API void	MR_CNCMachineSettings_DestroyArray (const MR_CNCMachineSettings *_this)
	Destroys a heap-allocated array of MR_CNCMachineSettings. Does nothing if the pointer is null.
MRC_API MR_CNCMachineSettings *	MR_CNCMachineSettings_AssignFromAnother (MR_CNCMachineSettings *_this, MR_PassBy _other_pass_by, MR_CNCMachineSettings *_other)
MRC_API int	MR_CNCMachineSettings_getAxesCount (void)
	Generated from method MR::CNCMachineSettings::getAxesCount.
MRC_API void	MR_CNCMachineSettings_setRotationAxis (MR_CNCMachineSettings *_this, MR_CNCMachineSettings_RotationAxisName paramName, const MR_Vector3f *rotationAxis)
MRC_API const MR_Vector3f *	MR_CNCMachineSettings_getRotationAxis (const MR_CNCMachineSettings *_this, MR_CNCMachineSettings_RotationAxisName paramName)
MRC_API void	MR_CNCMachineSettings_setRotationLimits (MR_CNCMachineSettings *_this, MR_CNCMachineSettings_RotationAxisName paramName, const MR_Vector2f *rotationLimits)
MRC_API const MR_std_optional_MR_Vector2f *	MR_CNCMachineSettings_getRotationLimits (const MR_CNCMachineSettings *_this, MR_CNCMachineSettings_RotationAxisName paramName)
MRC_API void	MR_CNCMachineSettings_setRotationOrder (MR_CNCMachineSettings *_this, const MR_std_vector_MR_CNCMachineSettings_RotationAxisName *rotationAxesOrder)
MRC_API const MR_std_vector_MR_CNCMachineSettings_RotationAxisName *	MR_CNCMachineSettings_getRotationOrder (const MR_CNCMachineSettings *_this)
MRC_API void	MR_CNCMachineSettings_setFeedrateIdle (MR_CNCMachineSettings *_this, float feedrateIdle)
MRC_API float	MR_CNCMachineSettings_getFeedrateIdle (const MR_CNCMachineSettings *_this)
MRC_API void	MR_CNCMachineSettings_setHomePosition (MR_CNCMachineSettings *_this, const MR_Vector3f *homePosition)
MRC_API const MR_Vector3f *	MR_CNCMachineSettings_getHomePosition (const MR_CNCMachineSettings *_this)
MRC_API bool	MR_equal_MR_CNCMachineSettings (MR_CNCMachineSettings *_this, const MR_CNCMachineSettings *rhs)
MRC_API bool	MR_not_equal_MR_CNCMachineSettings (MR_CNCMachineSettings *_this, const MR_CNCMachineSettings *rhs)

Typedef Documentation

MR_CNCMachineSettings

typedef struct MR_CNCMachineSettings MR_CNCMachineSettings

class with CNC machine emulation settings Generated from class MR::CNCMachineSettings. 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_CNCMachineSettings_RotationAxisName

typedef enum MR_CNCMachineSettings_RotationAxisName MR_CNCMachineSettings_RotationAxisName

MR_std_optional_MR_Vector2f

typedef struct MR_std_optional_MR_Vector2f MR_std_optional_MR_Vector2f

MR_std_vector_MR_CNCMachineSettings_RotationAxisName

typedef struct MR_std_vector_MR_CNCMachineSettings_RotationAxisName MR_std_vector_MR_CNCMachineSettings_RotationAxisName

MR_Vector3f

typedef struct MR_Vector3f MR_Vector3f

Enumeration Type Documentation

MR_CNCMachineSettings_RotationAxisName

enum MR_CNCMachineSettings_RotationAxisName

Enumerator
MR_CNCMachineSettings_RotationAxisName_A
MR_CNCMachineSettings_RotationAxisName_B
MR_CNCMachineSettings_RotationAxisName_C

Function Documentation

MR_CNCMachineSettings_AssignFromAnother()

MRC_API MR_CNCMachineSettings * MR_CNCMachineSettings_AssignFromAnother	(	MR_CNCMachineSettings *	_this,
		MR_PassBy	_other_pass_by,
		MR_CNCMachineSettings *	_other )

Generated from method MR::CNCMachineSettings::operator=. Parameter _this 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_CNCMachineSettings_ConstructFromAnother()

MRC_API MR_CNCMachineSettings * MR_CNCMachineSettings_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_CNCMachineSettings *	_other )

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

MR_CNCMachineSettings_DefaultConstruct()

MRC_API MR_CNCMachineSettings * MR_CNCMachineSettings_DefaultConstruct

(

void

)

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

MR_CNCMachineSettings_DefaultConstructArray()

MRC_API MR_CNCMachineSettings * MR_CNCMachineSettings_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_CNCMachineSettings_DestroyArray(). Use MR_CNCMachineSettings_OffsetMutablePtr() and MR_CNCMachineSettings_OffsetPtr() to access the array elements.

MR_CNCMachineSettings_Destroy()

MRC_API void MR_CNCMachineSettings_Destroy

(

const MR_CNCMachineSettings *

_this

)

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

MR_CNCMachineSettings_DestroyArray()

MRC_API void MR_CNCMachineSettings_DestroyArray

(

const MR_CNCMachineSettings *

_this

)

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

MR_CNCMachineSettings_getAxesCount()

MRC_API int MR_CNCMachineSettings_getAxesCount

(

void

)

Generated from method MR::CNCMachineSettings::getAxesCount.

MR_CNCMachineSettings_getFeedrateIdle()

MRC_API float MR_CNCMachineSettings_getFeedrateIdle

(

const MR_CNCMachineSettings *

_this

)

Generated from method MR::CNCMachineSettings::getFeedrateIdle. Parameter _this can not be null. It is a single object.

MR_CNCMachineSettings_getHomePosition()

MRC_API const MR_Vector3f * MR_CNCMachineSettings_getHomePosition

(

const MR_CNCMachineSettings *

_this

)

Generated from method MR::CNCMachineSettings::getHomePosition. 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_CNCMachineSettings_getRotationAxis()

MRC_API const MR_Vector3f * MR_CNCMachineSettings_getRotationAxis	(	const MR_CNCMachineSettings *	_this,
		MR_CNCMachineSettings_RotationAxisName	paramName )

Generated from method MR::CNCMachineSettings::getRotationAxis. 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_CNCMachineSettings_getRotationLimits()

MRC_API const MR_std_optional_MR_Vector2f * MR_CNCMachineSettings_getRotationLimits	(	const MR_CNCMachineSettings *	_this,
		MR_CNCMachineSettings_RotationAxisName	paramName )

Generated from method MR::CNCMachineSettings::getRotationLimits. 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_CNCMachineSettings_getRotationOrder()

MRC_API const MR_std_vector_MR_CNCMachineSettings_RotationAxisName * MR_CNCMachineSettings_getRotationOrder

(

const MR_CNCMachineSettings *

_this

)

Generated from method MR::CNCMachineSettings::getRotationOrder. 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_CNCMachineSettings_OffsetMutablePtr()

MRC_API MR_CNCMachineSettings * MR_CNCMachineSettings_OffsetMutablePtr	(	MR_CNCMachineSettings *	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_CNCMachineSettings_OffsetPtr()

MRC_API const MR_CNCMachineSettings * MR_CNCMachineSettings_OffsetPtr	(	const MR_CNCMachineSettings *	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_CNCMachineSettings_setFeedrateIdle()

MRC_API void MR_CNCMachineSettings_setFeedrateIdle	(	MR_CNCMachineSettings *	_this,
		float	feedrateIdle )

Generated from method MR::CNCMachineSettings::setFeedrateIdle. Parameter _this can not be null. It is a single object.

MR_CNCMachineSettings_setHomePosition()

MRC_API void MR_CNCMachineSettings_setHomePosition	(	MR_CNCMachineSettings *	_this,
		const MR_Vector3f *	homePosition )

Generated from method MR::CNCMachineSettings::setHomePosition. Parameter _this can not be null. It is a single object. Parameter homePosition can not be null. It is a single object.

MR_CNCMachineSettings_setRotationAxis()

MRC_API void MR_CNCMachineSettings_setRotationAxis	(	MR_CNCMachineSettings *	_this,
		MR_CNCMachineSettings_RotationAxisName	paramName,
		const MR_Vector3f *	rotationAxis )

Generated from method MR::CNCMachineSettings::setRotationAxis. Parameter _this can not be null. It is a single object. Parameter rotationAxis can not be null. It is a single object.

MR_CNCMachineSettings_setRotationLimits()

MRC_API void MR_CNCMachineSettings_setRotationLimits	(	MR_CNCMachineSettings *	_this,
		MR_CNCMachineSettings_RotationAxisName	paramName,
		const MR_Vector2f *	rotationLimits )

Generated from method MR::CNCMachineSettings::setRotationLimits. Parameter _this can not be null. It is a single object. Parameter rotationLimits is optional. To keep it empty, pass a null pointer.

MR_CNCMachineSettings_setRotationOrder()

MRC_API void MR_CNCMachineSettings_setRotationOrder	(	MR_CNCMachineSettings *	_this,
		const MR_std_vector_MR_CNCMachineSettings_RotationAxisName *	rotationAxesOrder )

Generated from method MR::CNCMachineSettings::setRotationOrder. Parameter _this can not be null. It is a single object. Parameter rotationAxesOrder can not be null. It is a single object.

MR_equal_MR_CNCMachineSettings()

MRC_API bool MR_equal_MR_CNCMachineSettings	(	MR_CNCMachineSettings *	_this,
		const MR_CNCMachineSettings *	rhs )

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

MR_not_equal_MR_CNCMachineSettings()

MRC_API bool MR_not_equal_MR_CNCMachineSettings	(	MR_CNCMachineSettings *	_this,
		const MR_CNCMachineSettings *	rhs )

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