MRPlane3.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_Plane3f	MR_Plane3f
typedef struct MR_Plane3d	MR_Plane3d

Functions
MRC_API const MR_Vector3f *	MR_Plane3f_Get_n (const MR_Plane3f *_this)
MRC_API void	MR_Plane3f_Set_n (MR_Plane3f *_this, MR_Vector3f value)
MRC_API MR_Vector3f *	MR_Plane3f_GetMutable_n (MR_Plane3f *_this)
MRC_API const float *	MR_Plane3f_Get_d (const MR_Plane3f *_this)
MRC_API void	MR_Plane3f_Set_d (MR_Plane3f *_this, float value)
MRC_API float *	MR_Plane3f_GetMutable_d (MR_Plane3f *_this)
MRC_API MR_Plane3f *	MR_Plane3f_DefaultConstruct (void)
MRC_API MR_Plane3f *	MR_Plane3f_DefaultConstructArray (size_t num_elems)
MRC_API const MR_Plane3f *	MR_Plane3f_OffsetPtr (const MR_Plane3f *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_Plane3f *	MR_Plane3f_OffsetMutablePtr (MR_Plane3f *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_Plane3f *	MR_Plane3f_ConstructFromAnother (const MR_Plane3f *_other)
MRC_API MR_Plane3f *	MR_Plane3f_Construct (const MR_Vector3f *n, float d)
MRC_API MR_Plane3f *	MR_Plane3f_Construct_double (const MR_Plane3d *p)
MRC_API MR_Plane3f *	MR_Plane3f_Construct_float (const MR_Plane3f *p)
MRC_API void	MR_Plane3f_Destroy (const MR_Plane3f *_this)
	Destroys a heap-allocated instance of MR_Plane3f. Does nothing if the pointer is null.
MRC_API void	MR_Plane3f_DestroyArray (const MR_Plane3f *_this)
	Destroys a heap-allocated array of MR_Plane3f. Does nothing if the pointer is null.
MRC_API MR_Plane3f *	MR_Plane3f_AssignFromAnother (MR_Plane3f *_this, const MR_Plane3f *_other)
MRC_API MR_Plane3f *	MR_Plane3f_fromDirAndPt (const MR_Vector3f *n, const MR_Vector3f *p)
MRC_API float	MR_Plane3f_distance (const MR_Plane3f *_this, const MR_Vector3f *x)
MRC_API MR_Plane3f *	MR_neg_MR_Plane3f (const MR_Plane3f *_this)
MRC_API const MR_Plane3f *	MR_pos_MR_Plane3f (const MR_Plane3f *_this)
MRC_API MR_Plane3f *	MR_Plane3f_normalized (const MR_Plane3f *_this)
MRC_API MR_Vector3f	MR_Plane3f_project (const MR_Plane3f *_this, const MR_Vector3f *p)
MRC_API const MR_Vector3d *	MR_Plane3d_Get_n (const MR_Plane3d *_this)
MRC_API void	MR_Plane3d_Set_n (MR_Plane3d *_this, MR_Vector3d value)
MRC_API MR_Vector3d *	MR_Plane3d_GetMutable_n (MR_Plane3d *_this)
MRC_API const double *	MR_Plane3d_Get_d (const MR_Plane3d *_this)
MRC_API void	MR_Plane3d_Set_d (MR_Plane3d *_this, double value)
MRC_API double *	MR_Plane3d_GetMutable_d (MR_Plane3d *_this)
MRC_API MR_Plane3d *	MR_Plane3d_DefaultConstruct (void)
MRC_API MR_Plane3d *	MR_Plane3d_DefaultConstructArray (size_t num_elems)
MRC_API const MR_Plane3d *	MR_Plane3d_OffsetPtr (const MR_Plane3d *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_Plane3d *	MR_Plane3d_OffsetMutablePtr (MR_Plane3d *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_Plane3d *	MR_Plane3d_ConstructFromAnother (const MR_Plane3d *_other)
MRC_API MR_Plane3d *	MR_Plane3d_Construct (const MR_Vector3d *n, double d)
MRC_API MR_Plane3d *	MR_Plane3d_Construct_float (const MR_Plane3f *p)
MRC_API void	MR_Plane3d_Destroy (const MR_Plane3d *_this)
	Destroys a heap-allocated instance of MR_Plane3d. Does nothing if the pointer is null.
MRC_API void	MR_Plane3d_DestroyArray (const MR_Plane3d *_this)
	Destroys a heap-allocated array of MR_Plane3d. Does nothing if the pointer is null.
MRC_API MR_Plane3d *	MR_Plane3d_AssignFromAnother (MR_Plane3d *_this, const MR_Plane3d *_other)
MRC_API MR_Plane3d *	MR_Plane3d_fromDirAndPt (const MR_Vector3d *n, const MR_Vector3d *p)
MRC_API double	MR_Plane3d_distance (const MR_Plane3d *_this, const MR_Vector3d *x)
MRC_API MR_Plane3d *	MR_neg_MR_Plane3d (const MR_Plane3d *_this)
MRC_API const MR_Plane3d *	MR_pos_MR_Plane3d (const MR_Plane3d *_this)
MRC_API MR_Plane3d *	MR_Plane3d_normalized (const MR_Plane3d *_this)
MRC_API MR_Vector3d	MR_Plane3d_project (const MR_Plane3d *_this, const MR_Vector3d *p)

Typedef Documentation

MR_Plane3d

typedef struct MR_Plane3d MR_Plane3d

3-dimensional plane: dot(n,x) - d = 0 Generated from class MR::Plane3d.

MR_Plane3f

typedef struct MR_Plane3f MR_Plane3f

3-dimensional plane: dot(n,x) - d = 0 Generated from class MR::Plane3f.

Function Documentation

MR_neg_MR_Plane3d()

MRC_API MR_Plane3d * MR_neg_MR_Plane3d

(

const MR_Plane3d *

_this

)

returns same plane represented with flipped direction of n-vector Generated from a method of class MR::Plane3d named operator-. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3d_Destroy() to free it when you're done using it.

MR_neg_MR_Plane3f()

MRC_API MR_Plane3f * MR_neg_MR_Plane3f

(

const MR_Plane3f *

_this

)

returns same plane represented with flipped direction of n-vector Generated from a method of class MR::Plane3f named operator-. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3f_Destroy() to free it when you're done using it.

MR_Plane3d_AssignFromAnother()

MRC_API MR_Plane3d * MR_Plane3d_AssignFromAnother	(	MR_Plane3d *	_this,
		const MR_Plane3d *	_other )

Generated from a method of class MR::Plane3d 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_Plane3d_Construct()

MRC_API MR_Plane3d * MR_Plane3d_Construct	(	const MR_Vector3d *	n,
		double	d )

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

MR_Plane3d_Construct_float()

MRC_API MR_Plane3d * MR_Plane3d_Construct_float

(

const MR_Plane3f *

p

)

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

MR_Plane3d_ConstructFromAnother()

MRC_API MR_Plane3d * MR_Plane3d_ConstructFromAnother

(

const MR_Plane3d *

_other

)

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

MR_Plane3d_DefaultConstruct()

MRC_API MR_Plane3d * MR_Plane3d_DefaultConstruct

(

void

)

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

MR_Plane3d_DefaultConstructArray()

MRC_API MR_Plane3d * MR_Plane3d_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_Plane3d_DestroyArray(). Use MR_Plane3d_OffsetMutablePtr() and MR_Plane3d_OffsetPtr() to access the array elements.

MR_Plane3d_Destroy()

MRC_API void MR_Plane3d_Destroy

(

const MR_Plane3d *

_this

)

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

MR_Plane3d_DestroyArray()

MRC_API void MR_Plane3d_DestroyArray

(

const MR_Plane3d *

_this

)

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

MR_Plane3d_distance()

MRC_API double MR_Plane3d_distance	(	const MR_Plane3d *	_this,
		const MR_Vector3d *	x )

returns distance from given point to this plane (if n is a unit vector) Generated from a method of class MR::Plane3d named distance. Parameter _this can not be null. It is a single object. Parameter x can not be null. It is a single object.

MR_Plane3d_fromDirAndPt()

MRC_API MR_Plane3d * MR_Plane3d_fromDirAndPt	(	const MR_Vector3d *	n,
		const MR_Vector3d *	p )

Generated from a method of class MR::Plane3d named fromDirAndPt. Parameter n can not be null. It is a single object. Parameter p can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3d_Destroy() to free it when you're done using it.

MR_Plane3d_Get_d()

MRC_API const double * MR_Plane3d_Get_d

(

const MR_Plane3d *

_this

)

Returns a pointer to a member variable of class MR::Plane3d named d. 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_Plane3d_Get_n()

MRC_API const MR_Vector3d * MR_Plane3d_Get_n

(

const MR_Plane3d *

_this

)

Returns a pointer to a member variable of class MR::Plane3d named n. 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_Plane3d_GetMutable_d()

MRC_API double * MR_Plane3d_GetMutable_d

(

MR_Plane3d *

_this

)

Returns a mutable pointer to a member variable of class MR::Plane3d named d. 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_Plane3d_GetMutable_n()

MRC_API MR_Vector3d * MR_Plane3d_GetMutable_n

(

MR_Plane3d *

_this

)

Returns a mutable pointer to a member variable of class MR::Plane3d named n. 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_Plane3d_normalized()

MRC_API MR_Plane3d * MR_Plane3d_normalized

(

const MR_Plane3d *

_this

)

returns same plane represented with unit n-vector Generated from a method of class MR::Plane3d named normalized. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3d_Destroy() to free it when you're done using it.

MR_Plane3d_OffsetMutablePtr()

MRC_API MR_Plane3d * MR_Plane3d_OffsetMutablePtr	(	MR_Plane3d *	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_Plane3d_OffsetPtr()

MRC_API const MR_Plane3d * MR_Plane3d_OffsetPtr	(	const MR_Plane3d *	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_Plane3d_project()

MRC_API MR_Vector3d MR_Plane3d_project	(	const MR_Plane3d *	_this,
		const MR_Vector3d *	p )

finds the closest point on plane Generated from a method of class MR::Plane3d named project. Parameter _this can not be null. It is a single object. Parameter p can not be null. It is a single object.

MR_Plane3d_Set_d()

MRC_API void MR_Plane3d_Set_d	(	MR_Plane3d *	_this,
		double	value )

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

MR_Plane3d_Set_n()

MRC_API void MR_Plane3d_Set_n	(	MR_Plane3d *	_this,
		MR_Vector3d	value )

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

MR_Plane3f_AssignFromAnother()

MRC_API MR_Plane3f * MR_Plane3f_AssignFromAnother	(	MR_Plane3f *	_this,
		const MR_Plane3f *	_other )

Generated from a method of class MR::Plane3f 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_Plane3f_Construct()

MRC_API MR_Plane3f * MR_Plane3f_Construct	(	const MR_Vector3f *	n,
		float	d )

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

MR_Plane3f_Construct_double()

MRC_API MR_Plane3f * MR_Plane3f_Construct_double

(

const MR_Plane3d *

p

)

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

MR_Plane3f_Construct_float()

MRC_API MR_Plane3f * MR_Plane3f_Construct_float

(

const MR_Plane3f *

p

)

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

MR_Plane3f_ConstructFromAnother()

MRC_API MR_Plane3f * MR_Plane3f_ConstructFromAnother

(

const MR_Plane3f *

_other

)

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

MR_Plane3f_DefaultConstruct()

MRC_API MR_Plane3f * MR_Plane3f_DefaultConstruct

(

void

)

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

MR_Plane3f_DefaultConstructArray()

MRC_API MR_Plane3f * MR_Plane3f_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_Plane3f_DestroyArray(). Use MR_Plane3f_OffsetMutablePtr() and MR_Plane3f_OffsetPtr() to access the array elements.

MR_Plane3f_Destroy()

MRC_API void MR_Plane3f_Destroy

(

const MR_Plane3f *

_this

)

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

MR_Plane3f_DestroyArray()

MRC_API void MR_Plane3f_DestroyArray

(

const MR_Plane3f *

_this

)

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

MR_Plane3f_distance()

MRC_API float MR_Plane3f_distance	(	const MR_Plane3f *	_this,
		const MR_Vector3f *	x )

returns distance from given point to this plane (if n is a unit vector) Generated from a method of class MR::Plane3f named distance. Parameter _this can not be null. It is a single object. Parameter x can not be null. It is a single object.

MR_Plane3f_fromDirAndPt()

MRC_API MR_Plane3f * MR_Plane3f_fromDirAndPt	(	const MR_Vector3f *	n,
		const MR_Vector3f *	p )

Generated from a method of class MR::Plane3f named fromDirAndPt. Parameter n can not be null. It is a single object. Parameter p can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3f_Destroy() to free it when you're done using it.

MR_Plane3f_Get_d()

MRC_API const float * MR_Plane3f_Get_d

(

const MR_Plane3f *

_this

)

Returns a pointer to a member variable of class MR::Plane3f named d. 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_Plane3f_Get_n()

MRC_API const MR_Vector3f * MR_Plane3f_Get_n

(

const MR_Plane3f *

_this

)

Returns a pointer to a member variable of class MR::Plane3f named n. 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_Plane3f_GetMutable_d()

MRC_API float * MR_Plane3f_GetMutable_d

(

MR_Plane3f *

_this

)

Returns a mutable pointer to a member variable of class MR::Plane3f named d. 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_Plane3f_GetMutable_n()

MRC_API MR_Vector3f * MR_Plane3f_GetMutable_n

(

MR_Plane3f *

_this

)

Returns a mutable pointer to a member variable of class MR::Plane3f named n. 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_Plane3f_normalized()

MRC_API MR_Plane3f * MR_Plane3f_normalized

(

const MR_Plane3f *

_this

)

returns same plane represented with unit n-vector Generated from a method of class MR::Plane3f named normalized. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_Plane3f_Destroy() to free it when you're done using it.

MR_Plane3f_OffsetMutablePtr()

MRC_API MR_Plane3f * MR_Plane3f_OffsetMutablePtr	(	MR_Plane3f *	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_Plane3f_OffsetPtr()

MRC_API const MR_Plane3f * MR_Plane3f_OffsetPtr	(	const MR_Plane3f *	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_Plane3f_project()

MRC_API MR_Vector3f MR_Plane3f_project	(	const MR_Plane3f *	_this,
		const MR_Vector3f *	p )

finds the closest point on plane Generated from a method of class MR::Plane3f named project. Parameter _this can not be null. It is a single object. Parameter p can not be null. It is a single object.

MR_Plane3f_Set_d()

MRC_API void MR_Plane3f_Set_d	(	MR_Plane3f *	_this,
		float	value )

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

MR_Plane3f_Set_n()

MRC_API void MR_Plane3f_Set_n	(	MR_Plane3f *	_this,
		MR_Vector3f	value )

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

MR_pos_MR_Plane3d()

MRC_API const MR_Plane3d * MR_pos_MR_Plane3d

(

const MR_Plane3d *

_this

)

returns same representation Generated from a method of class MR::Plane3d named operator+. 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_pos_MR_Plane3f()

MRC_API const MR_Plane3f * MR_pos_MR_Plane3f

(

const MR_Plane3f *

_this

)

returns same representation Generated from a method of class MR::Plane3f named operator+. 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.