MRCone3.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_Line3d	MR_Line3d
typedef struct MR_Line3f	MR_Line3f
typedef struct MR_Cone3f	MR_Cone3f
typedef struct MR_Cone3d	MR_Cone3d

Functions
MRC_API const MR_Line3f *	MR_Cone3f_Get_axis (const MR_Cone3f *_this)
MRC_API void	MR_Cone3f_Set_axis (MR_Cone3f *_this, const MR_Line3f *value)
MRC_API MR_Line3f *	MR_Cone3f_GetMutable_axis (MR_Cone3f *_this)
MRC_API const float *	MR_Cone3f_Get_angle (const MR_Cone3f *_this)
MRC_API void	MR_Cone3f_Set_angle (MR_Cone3f *_this, float value)
MRC_API float *	MR_Cone3f_GetMutable_angle (MR_Cone3f *_this)
MRC_API const float *	MR_Cone3f_Get_height (const MR_Cone3f *_this)
MRC_API void	MR_Cone3f_Set_height (MR_Cone3f *_this, float value)
MRC_API float *	MR_Cone3f_GetMutable_height (MR_Cone3f *_this)
MRC_API MR_Cone3f *	MR_Cone3f_DefaultConstruct (void)
MRC_API MR_Cone3f *	MR_Cone3f_DefaultConstructArray (size_t num_elems)
MRC_API const MR_Cone3f *	MR_Cone3f_OffsetPtr (const MR_Cone3f *ptr, ptrdiff_t i)
MRC_API MR_Cone3f *	MR_Cone3f_OffsetMutablePtr (MR_Cone3f *ptr, ptrdiff_t i)
MRC_API MR_Cone3f *	MR_Cone3f_ConstructFromAnother (const MR_Cone3f *_other)
MRC_API MR_Cone3f *	MR_Cone3f_Construct (const MR_Line3f *inAxis, float inAngle, float inHeight)
MRC_API void	MR_Cone3f_Destroy (const MR_Cone3f *_this)
	Destroys a heap-allocated instance of MR_Cone3f. Does nothing if the pointer is null.
MRC_API void	MR_Cone3f_DestroyArray (const MR_Cone3f *_this)
	Destroys a heap-allocated array of MR_Cone3f. Does nothing if the pointer is null.
MRC_API MR_Cone3f *	MR_Cone3f_AssignFromAnother (MR_Cone3f *_this, const MR_Cone3f *_other)
MRC_API MR_Vector3f *	MR_Cone3f_center (MR_Cone3f *_this)
MRC_API const MR_Vector3f *	MR_Cone3f_center_const (const MR_Cone3f *_this)
MRC_API MR_Vector3f *	MR_Cone3f_direction (MR_Cone3f *_this)
MRC_API const MR_Vector3f *	MR_Cone3f_direction_const (const MR_Cone3f *_this)
MRC_API MR_Vector3f *	MR_Cone3f_apex (MR_Cone3f *_this)
MRC_API const MR_Vector3f *	MR_Cone3f_apex_const (const MR_Cone3f *_this)
MRC_API MR_Vector3f	MR_Cone3f_projectPoint (const MR_Cone3f *_this, const MR_Vector3f *point)
MRC_API const MR_Line3d *	MR_Cone3d_Get_axis (const MR_Cone3d *_this)
MRC_API void	MR_Cone3d_Set_axis (MR_Cone3d *_this, const MR_Line3d *value)
MRC_API MR_Line3d *	MR_Cone3d_GetMutable_axis (MR_Cone3d *_this)
MRC_API const double *	MR_Cone3d_Get_angle (const MR_Cone3d *_this)
MRC_API void	MR_Cone3d_Set_angle (MR_Cone3d *_this, double value)
MRC_API double *	MR_Cone3d_GetMutable_angle (MR_Cone3d *_this)
MRC_API const double *	MR_Cone3d_Get_height (const MR_Cone3d *_this)
MRC_API void	MR_Cone3d_Set_height (MR_Cone3d *_this, double value)
MRC_API double *	MR_Cone3d_GetMutable_height (MR_Cone3d *_this)
MRC_API MR_Cone3d *	MR_Cone3d_DefaultConstruct (void)
MRC_API MR_Cone3d *	MR_Cone3d_DefaultConstructArray (size_t num_elems)
MRC_API const MR_Cone3d *	MR_Cone3d_OffsetPtr (const MR_Cone3d *ptr, ptrdiff_t i)
MRC_API MR_Cone3d *	MR_Cone3d_OffsetMutablePtr (MR_Cone3d *ptr, ptrdiff_t i)
MRC_API MR_Cone3d *	MR_Cone3d_ConstructFromAnother (const MR_Cone3d *_other)
MRC_API MR_Cone3d *	MR_Cone3d_Construct (const MR_Line3d *inAxis, double inAngle, double inHeight)
MRC_API void	MR_Cone3d_Destroy (const MR_Cone3d *_this)
	Destroys a heap-allocated instance of MR_Cone3d. Does nothing if the pointer is null.
MRC_API void	MR_Cone3d_DestroyArray (const MR_Cone3d *_this)
	Destroys a heap-allocated array of MR_Cone3d. Does nothing if the pointer is null.
MRC_API MR_Cone3d *	MR_Cone3d_AssignFromAnother (MR_Cone3d *_this, const MR_Cone3d *_other)
MRC_API MR_Vector3d *	MR_Cone3d_center (MR_Cone3d *_this)
MRC_API const MR_Vector3d *	MR_Cone3d_center_const (const MR_Cone3d *_this)
MRC_API MR_Vector3d *	MR_Cone3d_direction (MR_Cone3d *_this)
MRC_API const MR_Vector3d *	MR_Cone3d_direction_const (const MR_Cone3d *_this)
MRC_API MR_Vector3d *	MR_Cone3d_apex (MR_Cone3d *_this)
MRC_API const MR_Vector3d *	MR_Cone3d_apex_const (const MR_Cone3d *_this)
MRC_API MR_Vector3d	MR_Cone3d_projectPoint (const MR_Cone3d *_this, const MR_Vector3d *point)

Typedef Documentation

MR_Cone3d

typedef struct MR_Cone3d MR_Cone3d

Generated from class MR::Cone3d. 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_Cone3f

typedef struct MR_Cone3f MR_Cone3f

Generated from class MR::Cone3f. 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_Line3d

typedef struct MR_Line3d MR_Line3d

MR_Line3f

typedef struct MR_Line3f MR_Line3f

Function Documentation

MR_Cone3d_apex()

MRC_API MR_Vector3d * MR_Cone3d_apex

(

MR_Cone3d *

_this

)

Generated from method MR::Cone3d::apex. 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_Cone3d_apex_const()

MRC_API const MR_Vector3d * MR_Cone3d_apex_const

(

const MR_Cone3d *

_this

)

Generated from method MR::Cone3d::apex. 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_Cone3d_AssignFromAnother()

MRC_API MR_Cone3d * MR_Cone3d_AssignFromAnother	(	MR_Cone3d *	_this,
		const MR_Cone3d *	_other )

Generated from method MR::Cone3d::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 had previously.

MR_Cone3d_center()

MRC_API MR_Vector3d * MR_Cone3d_center

(

MR_Cone3d *

_this

)

Generated from method MR::Cone3d::center. 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_Cone3d_center_const()

MRC_API const MR_Vector3d * MR_Cone3d_center_const

(

const MR_Cone3d *

_this

)

Generated from method MR::Cone3d::center. 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_Cone3d_Construct()

MRC_API MR_Cone3d * MR_Cone3d_Construct	(	const MR_Line3d *	inAxis,
		double	inAngle,
		double	inHeight )

Generated from constructor MR::Cone3d::Cone3d. Parameter inAxis can not be null. It is a single object. The reference to the parameter inAxis might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_Cone3d_Destroy() to free it when you're done using it.

MR_Cone3d_ConstructFromAnother()

MRC_API MR_Cone3d * MR_Cone3d_ConstructFromAnother

(

const MR_Cone3d *

_other

)

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

MR_Cone3d_DefaultConstruct()

MRC_API MR_Cone3d * MR_Cone3d_DefaultConstruct

(

void

)

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

MR_Cone3d_DefaultConstructArray()

MRC_API MR_Cone3d * MR_Cone3d_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_Cone3d_DestroyArray(). Use MR_Cone3d_OffsetMutablePtr() and MR_Cone3d_OffsetPtr() to access the array elements.

MR_Cone3d_Destroy()

MRC_API void MR_Cone3d_Destroy

(

const MR_Cone3d *

_this

)

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

MR_Cone3d_DestroyArray()

MRC_API void MR_Cone3d_DestroyArray

(

const MR_Cone3d *

_this

)

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

MR_Cone3d_direction()

MRC_API MR_Vector3d * MR_Cone3d_direction

(

MR_Cone3d *

_this

)

Generated from method MR::Cone3d::direction. 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_Cone3d_direction_const()

MRC_API const MR_Vector3d * MR_Cone3d_direction_const

(

const MR_Cone3d *

_this

)

Generated from method MR::Cone3d::direction. 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_Cone3d_Get_angle()

MRC_API const double * MR_Cone3d_Get_angle

(

const MR_Cone3d *

_this

)

Returns a pointer to a member variable of class MR::Cone3d named angle. 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_Cone3d_Get_axis()

MRC_API const MR_Line3d * MR_Cone3d_Get_axis

(

const MR_Cone3d *

_this

)

Returns a pointer to a member variable of class MR::Cone3d named axis. 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_Cone3d_Get_height()

MRC_API const double * MR_Cone3d_Get_height

(

const MR_Cone3d *

_this

)

Returns a pointer to a member variable of class MR::Cone3d named height. 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_Cone3d_GetMutable_angle()

MRC_API double * MR_Cone3d_GetMutable_angle

(

MR_Cone3d *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3d named angle. 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_Cone3d_GetMutable_axis()

MRC_API MR_Line3d * MR_Cone3d_GetMutable_axis

(

MR_Cone3d *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3d named axis. 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_Cone3d_GetMutable_height()

MRC_API double * MR_Cone3d_GetMutable_height

(

MR_Cone3d *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3d named height. 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_Cone3d_OffsetMutablePtr()

MRC_API MR_Cone3d * MR_Cone3d_OffsetMutablePtr	(	MR_Cone3d *	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_Cone3d_OffsetPtr()

MRC_API const MR_Cone3d * MR_Cone3d_OffsetPtr	(	const MR_Cone3d *	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_Cone3d_projectPoint()

MRC_API MR_Vector3d MR_Cone3d_projectPoint	(	const MR_Cone3d *	_this,
		const MR_Vector3d *	point )

Generated from method MR::Cone3d::projectPoint. Parameter _this can not be null. It is a single object. Parameter point can not be null. It is a single object.

MR_Cone3d_Set_angle()

MRC_API void MR_Cone3d_Set_angle	(	MR_Cone3d *	_this,
		double	value )

Modifies a member variable of class MR::Cone3d named angle. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in angle.

MR_Cone3d_Set_axis()

MRC_API void MR_Cone3d_Set_axis	(	MR_Cone3d *	_this,
		const MR_Line3d *	value )

Modifies a member variable of class MR::Cone3d named axis. Parameter _this can not be null. It is a single object. Parameter value can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element axis. When this function is called, this object will drop object references it had previously in axis.

MR_Cone3d_Set_height()

MRC_API void MR_Cone3d_Set_height	(	MR_Cone3d *	_this,
		double	value )

Modifies a member variable of class MR::Cone3d named height. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in height.

MR_Cone3f_apex()

MRC_API MR_Vector3f * MR_Cone3f_apex

(

MR_Cone3f *

_this

)

Generated from method MR::Cone3f::apex. 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_Cone3f_apex_const()

MRC_API const MR_Vector3f * MR_Cone3f_apex_const

(

const MR_Cone3f *

_this

)

Generated from method MR::Cone3f::apex. 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_Cone3f_AssignFromAnother()

MRC_API MR_Cone3f * MR_Cone3f_AssignFromAnother	(	MR_Cone3f *	_this,
		const MR_Cone3f *	_other )

Generated from method MR::Cone3f::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 had previously.

MR_Cone3f_center()

MRC_API MR_Vector3f * MR_Cone3f_center

(

MR_Cone3f *

_this

)

Generated from method MR::Cone3f::center. 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_Cone3f_center_const()

MRC_API const MR_Vector3f * MR_Cone3f_center_const

(

const MR_Cone3f *

_this

)

Generated from method MR::Cone3f::center. 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_Cone3f_Construct()

MRC_API MR_Cone3f * MR_Cone3f_Construct	(	const MR_Line3f *	inAxis,
		float	inAngle,
		float	inHeight )

Generated from constructor MR::Cone3f::Cone3f. Parameter inAxis can not be null. It is a single object. The reference to the parameter inAxis might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_Cone3f_Destroy() to free it when you're done using it.

MR_Cone3f_ConstructFromAnother()

MRC_API MR_Cone3f * MR_Cone3f_ConstructFromAnother

(

const MR_Cone3f *

_other

)

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

MR_Cone3f_DefaultConstruct()

MRC_API MR_Cone3f * MR_Cone3f_DefaultConstruct

(

void

)

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

MR_Cone3f_DefaultConstructArray()

MRC_API MR_Cone3f * MR_Cone3f_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_Cone3f_DestroyArray(). Use MR_Cone3f_OffsetMutablePtr() and MR_Cone3f_OffsetPtr() to access the array elements.

MR_Cone3f_Destroy()

MRC_API void MR_Cone3f_Destroy

(

const MR_Cone3f *

_this

)

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

MR_Cone3f_DestroyArray()

MRC_API void MR_Cone3f_DestroyArray

(

const MR_Cone3f *

_this

)

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

MR_Cone3f_direction()

MRC_API MR_Vector3f * MR_Cone3f_direction

(

MR_Cone3f *

_this

)

Generated from method MR::Cone3f::direction. 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_Cone3f_direction_const()

MRC_API const MR_Vector3f * MR_Cone3f_direction_const

(

const MR_Cone3f *

_this

)

Generated from method MR::Cone3f::direction. 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_Cone3f_Get_angle()

MRC_API const float * MR_Cone3f_Get_angle

(

const MR_Cone3f *

_this

)

Returns a pointer to a member variable of class MR::Cone3f named angle. 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_Cone3f_Get_axis()

MRC_API const MR_Line3f * MR_Cone3f_Get_axis

(

const MR_Cone3f *

_this

)

Returns a pointer to a member variable of class MR::Cone3f named axis. 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_Cone3f_Get_height()

MRC_API const float * MR_Cone3f_Get_height

(

const MR_Cone3f *

_this

)

Returns a pointer to a member variable of class MR::Cone3f named height. 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_Cone3f_GetMutable_angle()

MRC_API float * MR_Cone3f_GetMutable_angle

(

MR_Cone3f *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3f named angle. 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_Cone3f_GetMutable_axis()

MRC_API MR_Line3f * MR_Cone3f_GetMutable_axis

(

MR_Cone3f *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3f named axis. 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_Cone3f_GetMutable_height()

MRC_API float * MR_Cone3f_GetMutable_height

(

MR_Cone3f *

_this

)

Returns a mutable pointer to a member variable of class MR::Cone3f named height. 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_Cone3f_OffsetMutablePtr()

MRC_API MR_Cone3f * MR_Cone3f_OffsetMutablePtr	(	MR_Cone3f *	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_Cone3f_OffsetPtr()

MRC_API const MR_Cone3f * MR_Cone3f_OffsetPtr	(	const MR_Cone3f *	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_Cone3f_projectPoint()

MRC_API MR_Vector3f MR_Cone3f_projectPoint	(	const MR_Cone3f *	_this,
		const MR_Vector3f *	point )

Generated from method MR::Cone3f::projectPoint. Parameter _this can not be null. It is a single object. Parameter point can not be null. It is a single object.

MR_Cone3f_Set_angle()

MRC_API void MR_Cone3f_Set_angle	(	MR_Cone3f *	_this,
		float	value )

Modifies a member variable of class MR::Cone3f named angle. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in angle.

MR_Cone3f_Set_axis()

MRC_API void MR_Cone3f_Set_axis	(	MR_Cone3f *	_this,
		const MR_Line3f *	value )

Modifies a member variable of class MR::Cone3f named axis. Parameter _this can not be null. It is a single object. Parameter value can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element axis. When this function is called, this object will drop object references it had previously in axis.

MR_Cone3f_Set_height()

MRC_API void MR_Cone3f_Set_height	(	MR_Cone3f *	_this,
		float	value )

Modifies a member variable of class MR::Cone3f named height. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it had previously in height.