MRPlaneObject.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_FeatureObject	MR_FeatureObject
typedef struct MR_FeatureObjectProjectPointResult	MR_FeatureObjectProjectPointResult
typedef struct MR_Object	MR_Object
typedef struct MR_ObjectChildrenHolder	MR_ObjectChildrenHolder
typedef struct MR_VisualObject	MR_VisualObject
typedef struct MR_std_shared_ptr_MR_Object	MR_std_shared_ptr_MR_Object
typedef struct MR_std_string	MR_std_string
typedef struct MR_std_vector_MR_FeatureObjectSharedProperty	MR_std_vector_MR_FeatureObjectSharedProperty
typedef struct MR_std_vector_MR_Vector3f	MR_std_vector_MR_Vector3f
typedef struct MR_PlaneObject	MR_PlaneObject

Functions
MRC_API MR_PlaneObject *	MR_PlaneObject_DefaultConstruct (void)
MRC_API MR_PlaneObject *	MR_PlaneObject_DefaultConstructArray (size_t num_elems)
MRC_API const MR_PlaneObject *	MR_PlaneObject_OffsetPtr (const MR_PlaneObject *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_PlaneObject *	MR_PlaneObject_OffsetMutablePtr (MR_PlaneObject *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 const MR_FeatureObject *	MR_PlaneObject_UpcastTo_MR_FeatureObject (const MR_PlaneObject *object)
MRC_API MR_FeatureObject *	MR_PlaneObject_MutableUpcastTo_MR_FeatureObject (MR_PlaneObject *object)
	Upcasts an instance of MR::PlaneObject to its base class MR::FeatureObject.
MRC_API const MR_Object *	MR_PlaneObject_UpcastTo_MR_Object (const MR_PlaneObject *object)
MRC_API MR_Object *	MR_PlaneObject_MutableUpcastTo_MR_Object (MR_PlaneObject *object)
	Upcasts an instance of MR::PlaneObject to its base class MR::Object.
MRC_API const MR_ObjectChildrenHolder *	MR_PlaneObject_UpcastTo_MR_ObjectChildrenHolder (const MR_PlaneObject *object)
MRC_API MR_ObjectChildrenHolder *	MR_PlaneObject_MutableUpcastTo_MR_ObjectChildrenHolder (MR_PlaneObject *object)
	Upcasts an instance of MR::PlaneObject to its base class MR::ObjectChildrenHolder.
MRC_API const MR_VisualObject *	MR_PlaneObject_UpcastTo_MR_VisualObject (const MR_PlaneObject *object)
MRC_API MR_VisualObject *	MR_PlaneObject_MutableUpcastTo_MR_VisualObject (MR_PlaneObject *object)
	Upcasts an instance of MR::PlaneObject to its base class MR::VisualObject.
MRC_API MR_PlaneObject *	MR_PlaneObject_ConstructFromAnother (MR_PassBy _other_pass_by, MR_PlaneObject *_other)
MRC_API MR_PlaneObject *	MR_PlaneObject_Construct (const MR_std_vector_MR_Vector3f *pointsToApprox)
MRC_API void	MR_PlaneObject_Destroy (const MR_PlaneObject *_this)
	Destroys a heap-allocated instance of MR_PlaneObject. Does nothing if the pointer is null.
MRC_API void	MR_PlaneObject_DestroyArray (const MR_PlaneObject *_this)
	Destroys a heap-allocated array of MR_PlaneObject. Does nothing if the pointer is null.
MRC_API MR_PlaneObject *	MR_PlaneObject_AssignFromAnother (MR_PlaneObject *_this, MR_PassBy _other_pass_by, MR_PlaneObject *_other)
MRC_API const char *	MR_PlaneObject_TypeName (void)
	Generated from a method of class MR::PlaneObject named TypeName.
MRC_API const char *	MR_PlaneObject_typeName (const MR_PlaneObject *_this)
MRC_API MR_std_string *	MR_PlaneObject_getClassName (const MR_PlaneObject *_this)
MRC_API MR_std_string *	MR_PlaneObject_getClassNameInPlural (const MR_PlaneObject *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_PlaneObject_clone (const MR_PlaneObject *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_PlaneObject_shallowClone (const MR_PlaneObject *_this)
MRC_API MR_Vector3f	MR_PlaneObject_getNormal (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API MR_Vector3f	MR_PlaneObject_getCenter (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API void	MR_PlaneObject_setNormal (MR_PlaneObject *_this, const MR_Vector3f *normal, const MR_ViewportId *id)
MRC_API void	MR_PlaneObject_setCenter (MR_PlaneObject *_this, const MR_Vector3f *center, const MR_ViewportId *id)
MRC_API void	MR_PlaneObject_setSize (MR_PlaneObject *_this, float size, const MR_ViewportId *id)
MRC_API float	MR_PlaneObject_getSize (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API float	MR_PlaneObject_getSizeX (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API float	MR_PlaneObject_getSizeY (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API MR_Matrix3f	MR_PlaneObject_calcLocalBasis (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API void	MR_PlaneObject_setSizeX (MR_PlaneObject *_this, float size, const MR_ViewportId *id)
MRC_API void	MR_PlaneObject_setSizeY (MR_PlaneObject *_this, float size, const MR_ViewportId *id)
MRC_API MR_Vector3f	MR_PlaneObject_getBasePoint (const MR_PlaneObject *_this, const MR_ViewportId *id)
MRC_API MR_FeatureObjectProjectPointResult *	MR_PlaneObject_projectPoint (const MR_PlaneObject *_this, const MR_Vector3f *point, const MR_ViewportId *id)
MRC_API const MR_std_vector_MR_FeatureObjectSharedProperty *	MR_PlaneObject_getAllSharedProperties (const MR_PlaneObject *_this)

Typedef Documentation

MR_FeatureObject

typedef struct MR_FeatureObject MR_FeatureObject

MR_FeatureObjectProjectPointResult

typedef struct MR_FeatureObjectProjectPointResult MR_FeatureObjectProjectPointResult

MR_Object

typedef struct MR_Object MR_Object

MR_ObjectChildrenHolder

typedef struct MR_ObjectChildrenHolder MR_ObjectChildrenHolder

MR_PlaneObject

typedef struct MR_PlaneObject MR_PlaneObject

Object to show plane feature Generated from class MR::PlaneObject. Base classes: Direct: (non-virtual) MR::FeatureObject Indirect: (non-virtual) MR::Object MR::ObjectChildrenHolder MR::VisualObject

MR_std_shared_ptr_MR_Object

typedef struct MR_std_shared_ptr_MR_Object MR_std_shared_ptr_MR_Object

MR_std_string

typedef struct MR_std_string MR_std_string

MR_std_vector_MR_FeatureObjectSharedProperty

typedef struct MR_std_vector_MR_FeatureObjectSharedProperty MR_std_vector_MR_FeatureObjectSharedProperty

MR_std_vector_MR_Vector3f

typedef struct MR_std_vector_MR_Vector3f MR_std_vector_MR_Vector3f

MR_VisualObject

typedef struct MR_VisualObject MR_VisualObject

Function Documentation

MR_PlaneObject_AssignFromAnother()

MRC_API MR_PlaneObject * MR_PlaneObject_AssignFromAnother	(	MR_PlaneObject *	_this,
		MR_PassBy	_other_pass_by,
		MR_PlaneObject *	_other )

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

MRC_API MR_Matrix3f MR_PlaneObject_calcLocalBasis	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

calculates normalized directions of X,Y axis of the plane and normal as Z Generated from a method of class MR::PlaneObject named calcLocalBasis. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_clone()

MRC_API MR_std_shared_ptr_MR_Object * MR_PlaneObject_clone

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_Construct()

MRC_API MR_PlaneObject * MR_PlaneObject_Construct

(

const MR_std_vector_MR_Vector3f *

pointsToApprox

)

Finds best plane to approx given points Generated from a constructor of class MR::PlaneObject. Parameter pointsToApprox can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_PlaneObject_Destroy() to free it when you're done using it.

MR_PlaneObject_ConstructFromAnother()

MRC_API MR_PlaneObject * MR_PlaneObject_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_PlaneObject *	_other )

Generated from a constructor of class MR::PlaneObject. Never returns null. Returns an instance allocated on the heap! Must call MR_PlaneObject_Destroy() to free it when you're done using it.

MR_PlaneObject_DefaultConstruct()

MRC_API MR_PlaneObject * MR_PlaneObject_DefaultConstruct

(

void

)

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

MR_PlaneObject_DefaultConstructArray()

MRC_API MR_PlaneObject * MR_PlaneObject_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_PlaneObject_DestroyArray(). Use MR_PlaneObject_OffsetMutablePtr() and MR_PlaneObject_OffsetPtr() to access the array elements.

MR_PlaneObject_Destroy()

MRC_API void MR_PlaneObject_Destroy

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_DestroyArray()

MRC_API void MR_PlaneObject_DestroyArray

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_getAllSharedProperties()

MRC_API const MR_std_vector_MR_FeatureObjectSharedProperty * MR_PlaneObject_getAllSharedProperties

(

const MR_PlaneObject *

_this

)

Generated from a method of class MR::PlaneObject named getAllSharedProperties. 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_PlaneObject_getBasePoint()

MRC_API MR_Vector3f MR_PlaneObject_getBasePoint	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named getBasePoint. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_getCenter()

MRC_API MR_Vector3f MR_PlaneObject_getCenter	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

calculates center from xf Generated from a method of class MR::PlaneObject named getCenter. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_getClassName()

MRC_API MR_std_string * MR_PlaneObject_getClassName

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_getClassNameInPlural()

MRC_API MR_std_string * MR_PlaneObject_getClassNameInPlural

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_getNormal()

MRC_API MR_Vector3f MR_PlaneObject_getNormal	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

calculates normal from xf Generated from a method of class MR::PlaneObject named getNormal. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_getSize()

MRC_API float MR_PlaneObject_getSize	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

calculates plane size from xf Generated from a method of class MR::PlaneObject named getSize. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_getSizeX()

MRC_API float MR_PlaneObject_getSizeX	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named getSizeX. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_getSizeY()

MRC_API float MR_PlaneObject_getSizeY	(	const MR_PlaneObject *	_this,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named getSizeY. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_MutableUpcastTo_MR_FeatureObject()

MRC_API MR_FeatureObject * MR_PlaneObject_MutableUpcastTo_MR_FeatureObject

(

MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::FeatureObject.

MR_PlaneObject_MutableUpcastTo_MR_Object()

MRC_API MR_Object * MR_PlaneObject_MutableUpcastTo_MR_Object

(

MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::Object.

MR_PlaneObject_MutableUpcastTo_MR_ObjectChildrenHolder()

MRC_API MR_ObjectChildrenHolder * MR_PlaneObject_MutableUpcastTo_MR_ObjectChildrenHolder

(

MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::ObjectChildrenHolder.

MR_PlaneObject_MutableUpcastTo_MR_VisualObject()

MRC_API MR_VisualObject * MR_PlaneObject_MutableUpcastTo_MR_VisualObject

(

MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::VisualObject.

MR_PlaneObject_OffsetMutablePtr()

MRC_API MR_PlaneObject * MR_PlaneObject_OffsetMutablePtr	(	MR_PlaneObject *	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_PlaneObject_OffsetPtr()

MRC_API const MR_PlaneObject * MR_PlaneObject_OffsetPtr	(	const MR_PlaneObject *	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_PlaneObject_projectPoint()

MRC_API MR_FeatureObjectProjectPointResult * MR_PlaneObject_projectPoint	(	const MR_PlaneObject *	_this,
		const MR_Vector3f *	point,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named projectPoint. Parameter _this can not be null. It is a single object. Parameter point can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_FeatureObjectProjectPointResult_Destroy() to free it when you're done using it.

MR_PlaneObject_setCenter()

MRC_API void MR_PlaneObject_setCenter	(	MR_PlaneObject *	_this,
		const MR_Vector3f *	center,
		const MR_ViewportId *	id )

updates xf to fit given center Generated from a method of class MR::PlaneObject named setCenter. Parameter _this can not be null. It is a single object. Parameter center can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_setNormal()

MRC_API void MR_PlaneObject_setNormal	(	MR_PlaneObject *	_this,
		const MR_Vector3f *	normal,
		const MR_ViewportId *	id )

updates xf to fit given normal Generated from a method of class MR::PlaneObject named setNormal. Parameter _this can not be null. It is a single object. Parameter normal can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_setSize()

MRC_API void MR_PlaneObject_setSize	(	MR_PlaneObject *	_this,
		float	size,
		const MR_ViewportId *	id )

updates xf to scale size Generated from a method of class MR::PlaneObject named setSize. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_setSizeX()

MRC_API void MR_PlaneObject_setSizeX	(	MR_PlaneObject *	_this,
		float	size,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named setSizeX. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_setSizeY()

MRC_API void MR_PlaneObject_setSizeY	(	MR_PlaneObject *	_this,
		float	size,
		const MR_ViewportId *	id )

Generated from a method of class MR::PlaneObject named setSizeY. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_PlaneObject_shallowClone()

MRC_API MR_std_shared_ptr_MR_Object * MR_PlaneObject_shallowClone

(

const MR_PlaneObject *

_this

)

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

MR_PlaneObject_TypeName()

MRC_API const char * MR_PlaneObject_TypeName

(

void

)

Generated from a method of class MR::PlaneObject named TypeName.

MR_PlaneObject_typeName()

MRC_API const char * MR_PlaneObject_typeName

(

const MR_PlaneObject *

_this

)

Generated from a method of class MR::PlaneObject named typeName. Parameter _this can not be null. It is a single object.

MR_PlaneObject_UpcastTo_MR_FeatureObject()

MRC_API const MR_FeatureObject * MR_PlaneObject_UpcastTo_MR_FeatureObject

(

const MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::FeatureObject. This version is acting on mutable pointers.

MR_PlaneObject_UpcastTo_MR_Object()

MRC_API const MR_Object * MR_PlaneObject_UpcastTo_MR_Object

(

const MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::Object. This version is acting on mutable pointers.

MR_PlaneObject_UpcastTo_MR_ObjectChildrenHolder()

MRC_API const MR_ObjectChildrenHolder * MR_PlaneObject_UpcastTo_MR_ObjectChildrenHolder

(

const MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::ObjectChildrenHolder. This version is acting on mutable pointers.

MR_PlaneObject_UpcastTo_MR_VisualObject()

MRC_API const MR_VisualObject * MR_PlaneObject_UpcastTo_MR_VisualObject

(

const MR_PlaneObject *

object

)

Upcasts an instance of MR::PlaneObject to its base class MR::VisualObject. This version is acting on mutable pointers.