MRCNCMachineSettings.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRVector2.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_Vector3f MR_Vector3f; // Defined in `#include <MRCMesh/MRVector3.h>`.
typedef struct MR_std_optional_MR_Vector2f MR_std_optional_MR_Vector2f; // Defined in `#include <MRCMisc/std_optional_MR_Vector2f.h>`.
typedef struct MR_std_vector_MR_CNCMachineSettings_RotationAxisName MR_std_vector_MR_CNCMachineSettings_RotationAxisName; // Defined in `#include <MRCMisc/std_vector_MR_CNCMachineSettings_RotationAxisName.h>`.
 
 
typedef struct MR_CNCMachineSettings MR_CNCMachineSettings;
 
// enumeration of axes of rotation
typedef int32_t MR_CNCMachineSettings_RotationAxisName;
enum // MR_CNCMachineSettings_RotationAxisName
{
    MR_CNCMachineSettings_RotationAxisName_A = 0,
    MR_CNCMachineSettings_RotationAxisName_B = 1,
    MR_CNCMachineSettings_RotationAxisName_C = 2,
};
 
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);
 
MRC_API void MR_CNCMachineSettings_DestroyArray(const MR_CNCMachineSettings *_this);
 
MRC_API MR_CNCMachineSettings *MR_CNCMachineSettings_AssignFromAnother(MR_CNCMachineSettings *_this, MR_PassBy _other_pass_by, MR_CNCMachineSettings *_other);
 
MRC_API int32_t MR_CNCMachineSettings_getAxesCount(void);
 
// rotationAxis length will be more then 0.01
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);
 
// rotationLimits = {min, max}
// valid range -180 <= min < max <= 180
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);
 
// duplicated values will be removed (ABAAC - > ABC)
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);
 
// set feedrate idle. valid range - [0, 100000]
// 0 - feedrate idle set as maximum feedrate on any action, or 100 if feedrate is not set in any action
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);
 
#ifdef __cplusplus
} // extern "C"
#endif