MRStep.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_MeshLoad_StepLoadSettings	MR_MeshLoad_StepLoadSettings

Functions
MRC_API const double *	MR_MeshLoad_StepLoadSettings_Get_angularDeflection (const MR_MeshLoad_StepLoadSettings *_this)
MRC_API void	MR_MeshLoad_StepLoadSettings_Set_angularDeflection (MR_MeshLoad_StepLoadSettings *_this, double value)
MRC_API double *	MR_MeshLoad_StepLoadSettings_GetMutable_angularDeflection (MR_MeshLoad_StepLoadSettings *_this)
MRC_API const double *	MR_MeshLoad_StepLoadSettings_Get_linearDeflection (const MR_MeshLoad_StepLoadSettings *_this)
MRC_API void	MR_MeshLoad_StepLoadSettings_Set_linearDeflection (MR_MeshLoad_StepLoadSettings *_this, double value)
MRC_API double *	MR_MeshLoad_StepLoadSettings_GetMutable_linearDeflection (MR_MeshLoad_StepLoadSettings *_this)
MRC_API const bool *	MR_MeshLoad_StepLoadSettings_Get_relative (const MR_MeshLoad_StepLoadSettings *_this)
MRC_API void	MR_MeshLoad_StepLoadSettings_Set_relative (MR_MeshLoad_StepLoadSettings *_this, bool value)
MRC_API bool *	MR_MeshLoad_StepLoadSettings_GetMutable_relative (MR_MeshLoad_StepLoadSettings *_this)
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_DefaultConstruct (void)
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_DefaultConstructArray (size_t num_elems)
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_ConstructFrom (double angularDeflection, double linearDeflection, bool relative)
MRC_API const MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_OffsetPtr (const MR_MeshLoad_StepLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_OffsetMutablePtr (MR_MeshLoad_StepLoadSettings *ptr, ptrdiff_t i)
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_ConstructFromAnother (const MR_MeshLoad_StepLoadSettings *_other)
MRC_API void	MR_MeshLoad_StepLoadSettings_Destroy (const MR_MeshLoad_StepLoadSettings *_this)
	Destroys a heap-allocated instance of MR_MeshLoad_StepLoadSettings. Does nothing if the pointer is null.
MRC_API void	MR_MeshLoad_StepLoadSettings_DestroyArray (const MR_MeshLoad_StepLoadSettings *_this)
	Destroys a heap-allocated array of MR_MeshLoad_StepLoadSettings. Does nothing if the pointer is null.
MRC_API MR_MeshLoad_StepLoadSettings *	MR_MeshLoad_StepLoadSettings_AssignFromAnother (MR_MeshLoad_StepLoadSettings *_this, const MR_MeshLoad_StepLoadSettings *_other)
MRC_API MR_expected_MR_Mesh_std_string *	MR_MeshLoad_fromStep_std_filesystem_path (const char *path, const char *path_end, const MR_MeshLoadSettings *settings, const MR_MeshLoad_StepLoadSettings *stepSettings)
MRC_API MR_expected_MR_Mesh_std_string *	MR_MeshLoad_fromStep_std_istream (MR_std_istream *in, const MR_MeshLoadSettings *settings, const MR_MeshLoad_StepLoadSettings *stepSettings)
MRC_API MR_expected_std_shared_ptr_MR_Object_std_string *	MR_MeshLoad_fromSceneStepFile_std_filesystem_path (const char *path, const char *path_end, const MR_MeshLoadSettings *settings, const MR_MeshLoad_StepLoadSettings *stepSettings)
MRC_API MR_expected_std_shared_ptr_MR_Object_std_string *	MR_MeshLoad_fromSceneStepFile_std_istream (MR_std_istream *in, const MR_MeshLoadSettings *settings, const MR_MeshLoad_StepLoadSettings *stepSettings)

Typedef Documentation

MR_MeshLoad_StepLoadSettings

typedef struct MR_MeshLoad_StepLoadSettings MR_MeshLoad_StepLoadSettings

STEP-specific mesh load parameters Generated from class MR::MeshLoad::StepLoadSettings. 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_MeshLoad_fromSceneStepFile_std_filesystem_path()

MRC_API MR_expected_std_shared_ptr_MR_Object_std_string * MR_MeshLoad_fromSceneStepFile_std_filesystem_path	(	const char *	path,
		const char *	path_end,
		const MR_MeshLoadSettings *	settings,
		const MR_MeshLoad_StepLoadSettings *	stepSettings )

load scene from STEP file using OpenCASCADE Generated from function MR::MeshLoad::fromSceneStepFile. Parameter path is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Parameter stepSettings is a single object. Parameter stepSettings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_std_shared_ptr_MR_Object_std_string_Destroy() to free it when you're done using it.

MR_MeshLoad_fromSceneStepFile_std_istream()

MRC_API MR_expected_std_shared_ptr_MR_Object_std_string * MR_MeshLoad_fromSceneStepFile_std_istream	(	MR_std_istream *	in,
		const MR_MeshLoadSettings *	settings,
		const MR_MeshLoad_StepLoadSettings *	stepSettings )

Generated from function MR::MeshLoad::fromSceneStepFile. Parameter in can not be null. It is a single object. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Parameter stepSettings is a single object. Parameter stepSettings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_std_shared_ptr_MR_Object_std_string_Destroy() to free it when you're done using it.

MR_MeshLoad_fromStep_std_filesystem_path()

MRC_API MR_expected_MR_Mesh_std_string * MR_MeshLoad_fromStep_std_filesystem_path	(	const char *	path,
		const char *	path_end,
		const MR_MeshLoadSettings *	settings,
		const MR_MeshLoad_StepLoadSettings *	stepSettings )

load mesh data from STEP file using OpenCASCADE Generated from function MR::MeshLoad::fromStep. Parameter path is a UTF-8 encoded filesystem path. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Parameter stepSettings is a single object. Parameter stepSettings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_MR_Mesh_std_string_Destroy() to free it when you're done using it.

MR_MeshLoad_fromStep_std_istream()

MRC_API MR_expected_MR_Mesh_std_string * MR_MeshLoad_fromStep_std_istream	(	MR_std_istream *	in,
		const MR_MeshLoadSettings *	settings,
		const MR_MeshLoad_StepLoadSettings *	stepSettings )

Generated from function MR::MeshLoad::fromStep. Parameter in can not be null. It is a single object. Parameter settings is a single object. Parameter settings has a default argument: {}, pass a null pointer to use it. Parameter stepSettings is a single object. Parameter stepSettings has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_MR_Mesh_std_string_Destroy() to free it when you're done using it.

MR_MeshLoad_StepLoadSettings_AssignFromAnother()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_AssignFromAnother	(	MR_MeshLoad_StepLoadSettings *	_this,
		const MR_MeshLoad_StepLoadSettings *	_other )

Generated from method MR::MeshLoad::StepLoadSettings::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_MeshLoad_StepLoadSettings_ConstructFrom()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_ConstructFrom	(	double	angularDeflection,
		double	linearDeflection,
		bool	relative )

Constructs MR::MeshLoad::StepLoadSettings elementwise. Never returns null. Returns an instance allocated on the heap! Must call MR_MeshLoad_StepLoadSettings_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.

MR_MeshLoad_StepLoadSettings_ConstructFromAnother()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_ConstructFromAnother

(

const MR_MeshLoad_StepLoadSettings *

_other

)

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

MR_MeshLoad_StepLoadSettings_DefaultConstruct()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_DefaultConstruct

(

void

)

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

MR_MeshLoad_StepLoadSettings_DefaultConstructArray()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_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_MeshLoad_StepLoadSettings_DestroyArray(). Use MR_MeshLoad_StepLoadSettings_OffsetMutablePtr() and MR_MeshLoad_StepLoadSettings_OffsetPtr() to access the array elements.

MR_MeshLoad_StepLoadSettings_Destroy()

MRC_API void MR_MeshLoad_StepLoadSettings_Destroy

(

const MR_MeshLoad_StepLoadSettings *

_this

)

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

MR_MeshLoad_StepLoadSettings_DestroyArray()

MRC_API void MR_MeshLoad_StepLoadSettings_DestroyArray

(

const MR_MeshLoad_StepLoadSettings *

_this

)

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

MR_MeshLoad_StepLoadSettings_Get_angularDeflection()

MRC_API const double * MR_MeshLoad_StepLoadSettings_Get_angularDeflection

(

const MR_MeshLoad_StepLoadSettings *

_this

)

angular deflection used to tessellate the boundary edges Returns a pointer to a member variable of class MR::MeshLoad::StepLoadSettings named angularDeflection. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_Get_linearDeflection()

MRC_API const double * MR_MeshLoad_StepLoadSettings_Get_linearDeflection

(

const MR_MeshLoad_StepLoadSettings *

_this

)

linear deflection used to tessellate the boundary edges Returns a pointer to a member variable of class MR::MeshLoad::StepLoadSettings named linearDeflection. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_Get_relative()

MRC_API const bool * MR_MeshLoad_StepLoadSettings_Get_relative

(

const MR_MeshLoad_StepLoadSettings *

_this

)

whether the deflection values are related to the size of edges Returns a pointer to a member variable of class MR::MeshLoad::StepLoadSettings named relative. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_GetMutable_angularDeflection()

MRC_API double * MR_MeshLoad_StepLoadSettings_GetMutable_angularDeflection

(

MR_MeshLoad_StepLoadSettings *

_this

)

angular deflection used to tessellate the boundary edges Returns a mutable pointer to a member variable of class MR::MeshLoad::StepLoadSettings named angularDeflection. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_GetMutable_linearDeflection()

MRC_API double * MR_MeshLoad_StepLoadSettings_GetMutable_linearDeflection

(

MR_MeshLoad_StepLoadSettings *

_this

)

linear deflection used to tessellate the boundary edges Returns a mutable pointer to a member variable of class MR::MeshLoad::StepLoadSettings named linearDeflection. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_GetMutable_relative()

MRC_API bool * MR_MeshLoad_StepLoadSettings_GetMutable_relative

(

MR_MeshLoad_StepLoadSettings *

_this

)

whether the deflection values are related to the size of edges Returns a mutable pointer to a member variable of class MR::MeshLoad::StepLoadSettings named relative. 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. The reference to this object might be preserved as the return value.

MR_MeshLoad_StepLoadSettings_OffsetMutablePtr()

MRC_API MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_OffsetMutablePtr	(	MR_MeshLoad_StepLoadSettings *	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_MeshLoad_StepLoadSettings_OffsetPtr()

MRC_API const MR_MeshLoad_StepLoadSettings * MR_MeshLoad_StepLoadSettings_OffsetPtr	(	const MR_MeshLoad_StepLoadSettings *	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_MeshLoad_StepLoadSettings_Set_angularDeflection()

MRC_API void MR_MeshLoad_StepLoadSettings_Set_angularDeflection	(	MR_MeshLoad_StepLoadSettings *	_this,
		double	value )

angular deflection used to tessellate the boundary edges Modifies a member variable of class MR::MeshLoad::StepLoadSettings named angularDeflection. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in angularDeflection.

MR_MeshLoad_StepLoadSettings_Set_linearDeflection()

MRC_API void MR_MeshLoad_StepLoadSettings_Set_linearDeflection	(	MR_MeshLoad_StepLoadSettings *	_this,
		double	value )

linear deflection used to tessellate the boundary edges Modifies a member variable of class MR::MeshLoad::StepLoadSettings named linearDeflection. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in linearDeflection.

MR_MeshLoad_StepLoadSettings_Set_relative()

MRC_API void MR_MeshLoad_StepLoadSettings_Set_relative	(	MR_MeshLoad_StepLoadSettings *	_this,
		bool	value )

whether the deflection values are related to the size of edges Modifies a member variable of class MR::MeshLoad::StepLoadSettings named relative. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in relative.