#include <OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Mesh/BaseKernel.hh>

Inheritance diagram for OpenMesh::BaseKernel:

Public Member Functions
template<>
size_t	n_elements () const

template<>
size_t	n_elements () const

template<>
size_t	n_elements () const

template<>
size_t	n_elements () const

Add a property to a mesh item
template<class T >
void	add_property (VPropHandleT< T > &_ph, const std::string &_name="<vprop>")

template<class T >
void	add_property (HPropHandleT< T > &_ph, const std::string &_name="<hprop>")

template<class T >
void	add_property (EPropHandleT< T > &_ph, const std::string &_name="<eprop>")

template<class T >
void	add_property (FPropHandleT< T > &_ph, const std::string &_name="<fprop>")

template<class T >
void	add_property (MPropHandleT< T > &_ph, const std::string &_name="<mprop>")

Removing a property from a mesh tiem
template<typename T >
void	remove_property (VPropHandleT< T > &_ph)

template<typename T >
void	remove_property (HPropHandleT< T > &_ph)

template<typename T >
void	remove_property (EPropHandleT< T > &_ph)

template<typename T >
void	remove_property (FPropHandleT< T > &_ph)

template<typename T >
void	remove_property (MPropHandleT< T > &_ph)

Get property handle by name
template<class T >
bool	get_property_handle (VPropHandleT< T > &_ph, const std::string &_name) const

template<class T >
bool	get_property_handle (HPropHandleT< T > &_ph, const std::string &_name) const

template<class T >
bool	get_property_handle (EPropHandleT< T > &_ph, const std::string &_name) const

template<class T >
bool	get_property_handle (FPropHandleT< T > &_ph, const std::string &_name) const

template<class T >
bool	get_property_handle (MPropHandleT< T > &_ph, const std::string &_name) const

Access a property
template<class T >
PropertyT< T > &	property (VPropHandleT< T > _ph)

template<class T >
const PropertyT< T > &	property (VPropHandleT< T > _ph) const

template<class T >
PropertyT< T > &	property (HPropHandleT< T > _ph)

template<class T >
const PropertyT< T > &	property (HPropHandleT< T > _ph) const

template<class T >
PropertyT< T > &	property (EPropHandleT< T > _ph)

template<class T >
const PropertyT< T > &	property (EPropHandleT< T > _ph) const

template<class T >
PropertyT< T > &	property (FPropHandleT< T > _ph)

template<class T >
const PropertyT< T > &	property (FPropHandleT< T > _ph) const

template<class T >
PropertyT< T > &	mproperty (MPropHandleT< T > _ph)

template<class T >
const PropertyT< T > &	mproperty (MPropHandleT< T > _ph) const

Access a property element using a handle to a mesh item
typedef PropertyContainer::iterator	prop_iterator

typedef PropertyContainer::const_iterator	const_prop_iterator

PropertyContainer	vprops_

PropertyContainer	hprops_

PropertyContainer	eprops_

PropertyContainer	fprops_

PropertyContainer	mprops_

template<class T >
VPropHandleT< T >::reference	property (VPropHandleT< T > _ph, VertexHandle _vh)

template<class T >
VPropHandleT< T >::const_reference	property (VPropHandleT< T > _ph, VertexHandle _vh) const

template<class T >
HPropHandleT< T >::reference	property (HPropHandleT< T > _ph, HalfedgeHandle _hh)

template<class T >
HPropHandleT< T >::const_reference	property (HPropHandleT< T > _ph, HalfedgeHandle _hh) const

template<class T >
EPropHandleT< T >::reference	property (EPropHandleT< T > _ph, EdgeHandle _eh)

template<class T >
EPropHandleT< T >::const_reference	property (EPropHandleT< T > _ph, EdgeHandle _eh) const

template<class T >
FPropHandleT< T >::reference	property (FPropHandleT< T > _ph, FaceHandle _fh)

template<class T >
FPropHandleT< T >::const_reference	property (FPropHandleT< T > _ph, FaceHandle _fh) const

template<class T >
MPropHandleT< T >::reference	property (MPropHandleT< T > _ph)

template<class T >
MPropHandleT< T >::const_reference	property (MPropHandleT< T > _ph) const

template<class T >
void	copy_property (VPropHandleT< T > &_ph, VertexHandle _vh_from, VertexHandle _vh_to)

template<class T >
void	copy_property (HPropHandleT< T > _ph, HalfedgeHandle _hh_from, HalfedgeHandle _hh_to)

template<class T >
void	copy_property (EPropHandleT< T > _ph, EdgeHandle _eh_from, EdgeHandle _eh_to)

template<class T >
void	copy_property (FPropHandleT< T > _ph, FaceHandle _fh_from, FaceHandle _fh_to)

void	copy_all_properties (VertexHandle _vh_from, VertexHandle _vh_to, bool _copyBuildIn=false)

void	copy_all_properties (HalfedgeHandle _hh_from, HalfedgeHandle _hh_to, bool _copyBuildIn=false)

void	copy_all_properties (EdgeHandle _eh_from, EdgeHandle _eh_to, bool _copyBuildIn=false)

void	copy_all_properties (FaceHandle _fh_from, FaceHandle _fh_to, bool _copyBuildIn=false)

void	copy_all_kernel_properties (const BaseKernel &_other)
	copy_all_kernel_properties uses the = operator to copy all properties from a given other BaseKernel.

size_t	n_vprops (void) const

size_t	n_eprops (void) const

size_t	n_hprops (void) const

size_t	n_fprops (void) const

size_t	n_mprops (void) const

BaseProperty *	_get_vprop (const std::string &_name)

BaseProperty *	_get_eprop (const std::string &_name)

BaseProperty *	_get_hprop (const std::string &_name)

BaseProperty *	_get_fprop (const std::string &_name)

BaseProperty *	_get_mprop (const std::string &_name)

const BaseProperty *	_get_vprop (const std::string &_name) const

const BaseProperty *	_get_eprop (const std::string &_name) const

const BaseProperty *	_get_hprop (const std::string &_name) const

const BaseProperty *	_get_fprop (const std::string &_name) const

const BaseProperty *	_get_mprop (const std::string &_name) const

BaseProperty &	_vprop (size_t _idx)

BaseProperty &	_eprop (size_t _idx)

BaseProperty &	_hprop (size_t _idx)

BaseProperty &	_fprop (size_t _idx)

BaseProperty &	_mprop (size_t _idx)

const BaseProperty &	_vprop (size_t _idx) const

const BaseProperty &	_eprop (size_t _idx) const

const BaseProperty &	_hprop (size_t _idx) const

const BaseProperty &	_fprop (size_t _idx) const

const BaseProperty &	_mprop (size_t _idx) const

size_t	_add_vprop (BaseProperty *_bp)

size_t	_add_eprop (BaseProperty *_bp)

size_t	_add_hprop (BaseProperty *_bp)

size_t	_add_fprop (BaseProperty *_bp)

size_t	_add_mprop (BaseProperty *_bp)

virtual size_t	n_vertices () const

virtual size_t	n_halfedges () const

virtual size_t	n_edges () const

virtual size_t	n_faces () const

template<typename HandleT >
size_t	n_elements () const

void	property_stats () const

void	property_stats (std::ostream &_ostr) const

void	vprop_stats (std::string &_string) const

void	hprop_stats (std::string &_string) const

void	eprop_stats (std::string &_string) const

void	fprop_stats (std::string &_string) const

void	mprop_stats (std::string &_string) const

void	vprop_stats () const

void	hprop_stats () const

void	eprop_stats () const

void	fprop_stats () const

void	mprop_stats () const

void	vprop_stats (std::ostream &_ostr) const

void	hprop_stats (std::ostream &_ostr) const

void	eprop_stats (std::ostream &_ostr) const

void	fprop_stats (std::ostream &_ostr) const

void	mprop_stats (std::ostream &_ostr) const

prop_iterator	vprops_begin ()

prop_iterator	vprops_end ()

const_prop_iterator	vprops_begin () const

const_prop_iterator	vprops_end () const

prop_iterator	eprops_begin ()

prop_iterator	eprops_end ()

const_prop_iterator	eprops_begin () const

const_prop_iterator	eprops_end () const

prop_iterator	hprops_begin ()

prop_iterator	hprops_end ()

const_prop_iterator	hprops_begin () const

const_prop_iterator	hprops_end () const

prop_iterator	fprops_begin ()

prop_iterator	fprops_end ()

const_prop_iterator	fprops_begin () const

const_prop_iterator	fprops_end () const

prop_iterator	mprops_begin ()

prop_iterator	mprops_end ()

const_prop_iterator	mprops_begin () const

const_prop_iterator	mprops_end () const

BaseProperty &	_vprop (BaseHandle _h)

BaseProperty &	_eprop (BaseHandle _h)

BaseProperty &	_hprop (BaseHandle _h)

BaseProperty &	_fprop (BaseHandle _h)

BaseProperty &	_mprop (BaseHandle _h)

const BaseProperty &	_vprop (BaseHandle _h) const

const BaseProperty &	_eprop (BaseHandle _h) const

const BaseProperty &	_hprop (BaseHandle _h) const

const BaseProperty &	_fprop (BaseHandle _h) const

const BaseProperty &	_mprop (BaseHandle _h) const

void	vprops_reserve (size_t _n) const
	Reserves space for `_n` elements in all vertex property vectors.

void	vprops_resize (size_t _n) const
	Resizes all vertex property vectors to the specified size.

void	vprops_resize_if_smaller (size_t _n) const

void	vprops_clear ()

void	vprops_swap (unsigned int _i0, unsigned int _i1) const

void	hprops_reserve (size_t _n) const

void	hprops_resize (size_t _n) const

void	hprops_clear ()

void	hprops_swap (unsigned int _i0, unsigned int _i1) const

void	eprops_reserve (size_t _n) const

void	eprops_resize (size_t _n) const

void	eprops_clear ()

void	eprops_swap (unsigned int _i0, unsigned int _i1) const

void	fprops_reserve (size_t _n) const

void	fprops_resize (size_t _n) const

void	fprops_clear ()

void	fprops_swap (unsigned int _i0, unsigned int _i1) const

void	mprops_resize (size_t _n) const

void	mprops_clear ()

Detailed Description

This class provides low-level property management like adding/removing properties and access to properties. Under most circumstances, it is advisable to use the high-level property management provided by PropertyManager, instead.

All operations provided by BaseKernel need at least a property handle (VPropHandleT, EPropHandleT, HPropHandleT, FPropHandleT, MPropHandleT). which keeps the data type of the property, too.

There are two types of properties:

Standard properties - mesh data (e.g. vertex normal or face color)
Custom properties - user defined data

The differentiation is only semantically, technically both are equally handled. Therefore the methods provided by the BaseKernel are applicable to both property types.

Attention: Since the class PolyMeshT derives from a kernel, hence all public elements of BaseKernel are usable.

Definition at line 97 of file BaseKernel.hh.

Member Typedef Documentation

◆ const_prop_iterator

typedef PropertyContainer::const_iterator OpenMesh::BaseKernel::const_prop_iterator

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 783 of file BaseKernel.hh.

◆ prop_iterator

typedef PropertyContainer::iterator OpenMesh::BaseKernel::prop_iterator

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 782 of file BaseKernel.hh.

Constructor & Destructor Documentation

◆ BaseKernel()

OpenMesh::BaseKernel::BaseKernel ( )

inline

Definition at line 101 of file BaseKernel.hh.

◆ ~BaseKernel()

virtual OpenMesh::BaseKernel::~BaseKernel ( )

inlinevirtual

Definition at line 102 of file BaseKernel.hh.

Member Function Documentation

◆ _add_eprop()

size_t OpenMesh::BaseKernel::_add_eprop ( BaseProperty * _bp )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 655 of file BaseKernel.hh.

◆ _add_fprop()

size_t OpenMesh::BaseKernel::_add_fprop ( BaseProperty * _bp )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 657 of file BaseKernel.hh.

◆ _add_hprop()

size_t OpenMesh::BaseKernel::_add_hprop ( BaseProperty * _bp )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 656 of file BaseKernel.hh.

◆ _add_mprop()

size_t OpenMesh::BaseKernel::_add_mprop ( BaseProperty * _bp )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 658 of file BaseKernel.hh.

◆ _add_vprop()

size_t OpenMesh::BaseKernel::_add_vprop ( BaseProperty * _bp )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 654 of file BaseKernel.hh.

◆ _eprop() [1/4]

BaseProperty & OpenMesh::BaseKernel::_eprop ( BaseHandle _h )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 664 of file BaseKernel.hh.

◆ _eprop() [2/4]

const BaseProperty & OpenMesh::BaseKernel::_eprop ( BaseHandle _h ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 675 of file BaseKernel.hh.

◆ _eprop() [3/4]

BaseProperty & OpenMesh::BaseKernel::_eprop ( size_t _idx )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 638 of file BaseKernel.hh.

◆ _eprop() [4/4]

const BaseProperty & OpenMesh::BaseKernel::_eprop ( size_t _idx ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 645 of file BaseKernel.hh.

◆ _fprop() [1/4]

BaseProperty & OpenMesh::BaseKernel::_fprop ( BaseHandle _h )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 668 of file BaseKernel.hh.

◆ _fprop() [2/4]

const BaseProperty & OpenMesh::BaseKernel::_fprop ( BaseHandle _h ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 679 of file BaseKernel.hh.

◆ _fprop() [3/4]

BaseProperty & OpenMesh::BaseKernel::_fprop ( size_t _idx )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 640 of file BaseKernel.hh.

◆ _fprop() [4/4]

const BaseProperty & OpenMesh::BaseKernel::_fprop ( size_t _idx ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 649 of file BaseKernel.hh.

◆ _get_eprop() [1/2]

BaseProperty * OpenMesh::BaseKernel::_get_eprop ( const std::string & _name )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 610 of file BaseKernel.hh.

◆ _get_eprop() [2/2]

const BaseProperty * OpenMesh::BaseKernel::_get_eprop ( const std::string & _name ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 625 of file BaseKernel.hh.

◆ _get_fprop() [1/2]

BaseProperty * OpenMesh::BaseKernel::_get_fprop ( const std::string & _name )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 616 of file BaseKernel.hh.

◆ _get_fprop() [2/2]

const BaseProperty * OpenMesh::BaseKernel::_get_fprop ( const std::string & _name ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 631 of file BaseKernel.hh.

◆ _get_hprop() [1/2]

BaseProperty * OpenMesh::BaseKernel::_get_hprop ( const std::string & _name )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 613 of file BaseKernel.hh.

◆ _get_hprop() [2/2]

const BaseProperty * OpenMesh::BaseKernel::_get_hprop ( const std::string & _name ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 628 of file BaseKernel.hh.

◆ _get_mprop() [1/2]

BaseProperty * OpenMesh::BaseKernel::_get_mprop ( const std::string & _name )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 619 of file BaseKernel.hh.

◆ _get_mprop() [2/2]

const BaseProperty * OpenMesh::BaseKernel::_get_mprop ( const std::string & _name ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 634 of file BaseKernel.hh.

◆ _get_vprop() [1/2]

BaseProperty * OpenMesh::BaseKernel::_get_vprop ( const std::string & _name )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 607 of file BaseKernel.hh.

◆ _get_vprop() [2/2]

const BaseProperty * OpenMesh::BaseKernel::_get_vprop ( const std::string & _name ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 622 of file BaseKernel.hh.

◆ _hprop() [1/4]

BaseProperty & OpenMesh::BaseKernel::_hprop ( BaseHandle _h )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 666 of file BaseKernel.hh.

◆ _hprop() [2/4]

const BaseProperty & OpenMesh::BaseKernel::_hprop ( BaseHandle _h ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 677 of file BaseKernel.hh.

◆ _hprop() [3/4]

BaseProperty & OpenMesh::BaseKernel::_hprop ( size_t _idx )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 639 of file BaseKernel.hh.

◆ _hprop() [4/4]

const BaseProperty & OpenMesh::BaseKernel::_hprop ( size_t _idx ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 647 of file BaseKernel.hh.

◆ _mprop() [1/4]

BaseProperty & OpenMesh::BaseKernel::_mprop ( BaseHandle _h )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 670 of file BaseKernel.hh.

◆ _mprop() [2/4]

const BaseProperty & OpenMesh::BaseKernel::_mprop ( BaseHandle _h ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 681 of file BaseKernel.hh.

◆ _mprop() [3/4]

BaseProperty & OpenMesh::BaseKernel::_mprop ( size_t _idx )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 641 of file BaseKernel.hh.

◆ _mprop() [4/4]

const BaseProperty & OpenMesh::BaseKernel::_mprop ( size_t _idx ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 651 of file BaseKernel.hh.

◆ _vprop() [1/4]

BaseProperty & OpenMesh::BaseKernel::_vprop ( BaseHandle _h )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 662 of file BaseKernel.hh.

◆ _vprop() [2/4]

const BaseProperty & OpenMesh::BaseKernel::_vprop ( BaseHandle _h ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 673 of file BaseKernel.hh.

◆ _vprop() [3/4]

BaseProperty & OpenMesh::BaseKernel::_vprop ( size_t _idx )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 637 of file BaseKernel.hh.

◆ _vprop() [4/4]

const BaseProperty & OpenMesh::BaseKernel::_vprop ( size_t _idx ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 643 of file BaseKernel.hh.

◆ add_property() [1/5]

template<class T >

void OpenMesh::BaseKernel::add_property	(	EPropHandleT< T > &	_ph,
		const std::string &	_name = `"<eprop>"`
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper and/or one of its helper functions such as makePropertyManagerFromNew, makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Adds a property

Depending on the property handle type a vertex, (half-)edge, face or mesh property is added to the mesh. If the action fails the handle is invalid. On success the handle must be used to access the property data with property().

Parameters

_ph	A property handle defining the data type to bind to mesh. On success the handle is valid else invalid.
_name	Optional name of property. Following restrictions apply to the name: Maximum length of name is 256 characters The prefixes matching "^[vhefm]:" are reserved for internal usage. The expression "^<.*>$" is reserved for internal usage.

Definition at line 155 of file BaseKernel.hh.

◆ add_property() [2/5]

template<class T >

void OpenMesh::BaseKernel::add_property	(	FPropHandleT< T > &	_ph,
		const std::string &	_name = `"<fprop>"`
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper and/or one of its helper functions such as makePropertyManagerFromNew, makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Adds a property

Depending on the property handle type a vertex, (half-)edge, face or mesh property is added to the mesh. If the action fails the handle is invalid. On success the handle must be used to access the property data with property().

Parameters

_ph	A property handle defining the data type to bind to mesh. On success the handle is valid else invalid.
_name	Optional name of property. Following restrictions apply to the name: Maximum length of name is 256 characters The prefixes matching "^[vhefm]:" are reserved for internal usage. The expression "^<.*>$" is reserved for internal usage.

Definition at line 162 of file BaseKernel.hh.

◆ add_property() [3/5]

template<class T >

void OpenMesh::BaseKernel::add_property	(	HPropHandleT< T > &	_ph,
		const std::string &	_name = `"<hprop>"`
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper and/or one of its helper functions such as makePropertyManagerFromNew, makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Adds a property

Depending on the property handle type a vertex, (half-)edge, face or mesh property is added to the mesh. If the action fails the handle is invalid. On success the handle must be used to access the property data with property().

Parameters

_ph	A property handle defining the data type to bind to mesh. On success the handle is valid else invalid.
_name	Optional name of property. Following restrictions apply to the name: Maximum length of name is 256 characters The prefixes matching "^[vhefm]:" are reserved for internal usage. The expression "^<.*>$" is reserved for internal usage.

Definition at line 148 of file BaseKernel.hh.

◆ add_property() [4/5]

template<class T >

void OpenMesh::BaseKernel::add_property	(	MPropHandleT< T > &	_ph,
		const std::string &	_name = `"<mprop>"`
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper and/or one of its helper functions such as makePropertyManagerFromNew, makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Adds a property

Depending on the property handle type a vertex, (half-)edge, face or mesh property is added to the mesh. If the action fails the handle is invalid. On success the handle must be used to access the property data with property().

Parameters

_ph	A property handle defining the data type to bind to mesh. On success the handle is valid else invalid.
_name	Optional name of property. Following restrictions apply to the name: Maximum length of name is 256 characters The prefixes matching "^[vhefm]:" are reserved for internal usage. The expression "^<.*>$" is reserved for internal usage.

Definition at line 169 of file BaseKernel.hh.

◆ add_property() [5/5]

template<class T >

void OpenMesh::BaseKernel::add_property	(	VPropHandleT< T > &	_ph,
		const std::string &	_name = `"<vprop>"`
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper and/or one of its helper functions such as makePropertyManagerFromNew, makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Adds a property

Depending on the property handle type a vertex, (half-)edge, face or mesh property is added to the mesh. If the action fails the handle is invalid. On success the handle must be used to access the property data with property().

Parameters

_ph	A property handle defining the data type to bind to mesh. On success the handle is valid else invalid.
_name	Optional name of property. Following restrictions apply to the name: Maximum length of name is 256 characters The prefixes matching "^[vhefm]:" are reserved for internal usage. The expression "^<.*>$" is reserved for internal usage.

Definition at line 141 of file BaseKernel.hh.

◆ copy_all_kernel_properties()

void OpenMesh::BaseKernel::copy_all_kernel_properties ( const BaseKernel & _other )

inline

copy_all_kernel_properties uses the = operator to copy all properties from a given other BaseKernel.

Parameters

_other Another BaseKernel, to copy the properties from.

Definition at line 585 of file BaseKernel.hh.

◆ copy_all_properties() [1/4]

void OpenMesh::BaseKernel::copy_all_properties	(	EdgeHandle	_eh_from,
		EdgeHandle	_eh_to,
		bool	_copyBuildIn = `false`
	)

inline

Copies all properties from one mesh element to another (of the same type)

Parameters

_eh_from	An edge handle - source
_eh_to	An edge handle - target
_copyBuildIn	Should the internal properties (position, normal, texture coordinate,..) be copied?

Definition at line 549 of file BaseKernel.hh.

◆ copy_all_properties() [2/4]

void OpenMesh::BaseKernel::copy_all_properties	(	FaceHandle	_fh_from,
		FaceHandle	_fh_to,
		bool	_copyBuildIn = `false`
	)

inline

Copies all properties from one mesh element to another (of the same type)

Parameters

_fh_from	A face handle - source
_fh_to	A face handle - target
_copyBuildIn	Should the internal properties (position, normal, texture coordinate,..) be copied?

Definition at line 568 of file BaseKernel.hh.

◆ copy_all_properties() [3/4]

void OpenMesh::BaseKernel::copy_all_properties	(	HalfedgeHandle	_hh_from,
		HalfedgeHandle	_hh_to,
		bool	_copyBuildIn = `false`
	)

inline

Copies all properties from one mesh element to another (of the same type)

Parameters

_hh_from	A halfedge handle - source
_hh_to	A halfedge handle - target
_copyBuildIn	Should the internal properties (position, normal, texture coordinate,..) be copied?

Definition at line 530 of file BaseKernel.hh.

◆ copy_all_properties() [4/4]

void OpenMesh::BaseKernel::copy_all_properties	(	VertexHandle	_vh_from,
		VertexHandle	_vh_to,
		bool	_copyBuildIn = `false`
	)

inline

Copies all properties from one mesh element to another (of the same type)

Parameters

_vh_from	A vertex handle - source
_vh_to	A vertex handle - target
_copyBuildIn	Should the internal properties (position, normal, texture coordinate,..) be copied?

Definition at line 511 of file BaseKernel.hh.

◆ copy_property() [1/4]

template<class T >

void OpenMesh::BaseKernel::copy_property	(	EPropHandleT< T >	_ph,
		EdgeHandle	_eh_from,
		EdgeHandle	_eh_to
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::copy_to or PropertyManager::copy).

Copies a single property from one mesh element to another (of the same type)

Parameters

_ph	An edge property handle
_eh_from	From edge handle
_eh_to	To edge handle

Definition at line 479 of file BaseKernel.hh.

◆ copy_property() [2/4]

template<class T >

void OpenMesh::BaseKernel::copy_property	(	FPropHandleT< T >	_ph,
		FaceHandle	_fh_from,
		FaceHandle	_fh_to
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::copy_to or PropertyManager::copy).

Copies a single property from one mesh element to another (of the same type)

Parameters

_ph	A face property handle
_fh_from	From face handle
_fh_to	To face handle

Definition at line 495 of file BaseKernel.hh.

◆ copy_property() [3/4]

template<class T >

void OpenMesh::BaseKernel::copy_property	(	HPropHandleT< T >	_ph,
		HalfedgeHandle	_hh_from,
		HalfedgeHandle	_hh_to
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::copy_to or PropertyManager::copy).

Copies a single property from one mesh element to another (of the same type)

Parameters

_ph	A halfedge property handle
_hh_from	From halfedge handle
_hh_to	To halfedge handle

Definition at line 463 of file BaseKernel.hh.

◆ copy_property() [4/4]

template<class T >

void OpenMesh::BaseKernel::copy_property	(	VPropHandleT< T > &	_ph,
		VertexHandle	_vh_from,
		VertexHandle	_vh_to
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::copy_to or PropertyManager::copy).

Copies a single property from one mesh element to another (of the same type)

Parameters

_ph	A vertex property handle
_vh_from	From vertex handle
_vh_to	To vertex handle

Definition at line 447 of file BaseKernel.hh.

◆ eprop_stats() [1/3]

void OpenMesh::BaseKernel::eprop_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 196 of file BaseKernel.cc.

◆ eprop_stats() [2/3]

void OpenMesh::BaseKernel::eprop_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 200 of file BaseKernel.cc.

◆ eprop_stats() [3/3]

void OpenMesh::BaseKernel::eprop_stats ( std::string & _string ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 125 of file BaseKernel.cc.

◆ eprops_begin() [1/2]

prop_iterator OpenMesh::BaseKernel::eprops_begin ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 790 of file BaseKernel.hh.

◆ eprops_begin() [2/2]

const_prop_iterator OpenMesh::BaseKernel::eprops_begin ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 792 of file BaseKernel.hh.

◆ eprops_clear()

void OpenMesh::BaseKernel::eprops_clear ( )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 734 of file BaseKernel.hh.

◆ eprops_end() [1/2]

prop_iterator OpenMesh::BaseKernel::eprops_end ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 791 of file BaseKernel.hh.

◆ eprops_end() [2/2]

const_prop_iterator OpenMesh::BaseKernel::eprops_end ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 793 of file BaseKernel.hh.

◆ eprops_reserve()

void OpenMesh::BaseKernel::eprops_reserve ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 732 of file BaseKernel.hh.

◆ eprops_resize()

void OpenMesh::BaseKernel::eprops_resize ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 733 of file BaseKernel.hh.

◆ eprops_swap()

void OpenMesh::BaseKernel::eprops_swap	(	unsigned int	_i0,
		unsigned int	_i1
	)		const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 737 of file BaseKernel.hh.

◆ fprop_stats() [1/3]

void OpenMesh::BaseKernel::fprop_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 208 of file BaseKernel.cc.

◆ fprop_stats() [2/3]

void OpenMesh::BaseKernel::fprop_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 212 of file BaseKernel.cc.

◆ fprop_stats() [3/3]

void OpenMesh::BaseKernel::fprop_stats ( std::string & _string ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 140 of file BaseKernel.cc.

◆ fprops_begin() [1/2]

prop_iterator OpenMesh::BaseKernel::fprops_begin ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 800 of file BaseKernel.hh.

◆ fprops_begin() [2/2]

const_prop_iterator OpenMesh::BaseKernel::fprops_begin ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 802 of file BaseKernel.hh.

◆ fprops_clear()

void OpenMesh::BaseKernel::fprops_clear ( )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 743 of file BaseKernel.hh.

◆ fprops_end() [1/2]

prop_iterator OpenMesh::BaseKernel::fprops_end ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 801 of file BaseKernel.hh.

◆ fprops_end() [2/2]

const_prop_iterator OpenMesh::BaseKernel::fprops_end ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 803 of file BaseKernel.hh.

◆ fprops_reserve()

void OpenMesh::BaseKernel::fprops_reserve ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 741 of file BaseKernel.hh.

◆ fprops_resize()

void OpenMesh::BaseKernel::fprops_resize ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 742 of file BaseKernel.hh.

◆ fprops_swap()

void OpenMesh::BaseKernel::fprops_swap	(	unsigned int	_i0,
		unsigned int	_i1
	)		const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 746 of file BaseKernel.hh.

◆ get_property_handle() [1/5]

template<class T >

bool OpenMesh::BaseKernel::get_property_handle	(	EPropHandleT< T > &	_ph,
		const std::string &	_name
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::propertyExists) or one of its higher level helper functions such as makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Retrieves the handle to a named property by it's name.

Parameters

_ph	A property handle. On success the handle is valid else invalid.
_name	Name of wanted property.

Returns: true if such a named property is available, else false.

Definition at line 268 of file BaseKernel.hh.

◆ get_property_handle() [2/5]

template<class T >

bool OpenMesh::BaseKernel::get_property_handle	(	FPropHandleT< T > &	_ph,
		const std::string &	_name
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::propertyExists) or one of its higher level helper functions such as makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Retrieves the handle to a named property by it's name.

Parameters

_ph	A property handle. On success the handle is valid else invalid.
_name	Name of wanted property.

Returns: true if such a named property is available, else false.

Definition at line 275 of file BaseKernel.hh.

◆ get_property_handle() [3/5]

template<class T >

bool OpenMesh::BaseKernel::get_property_handle	(	HPropHandleT< T > &	_ph,
		const std::string &	_name
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::propertyExists) or one of its higher level helper functions such as makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Retrieves the handle to a named property by it's name.

Parameters

_ph	A property handle. On success the handle is valid else invalid.
_name	Name of wanted property.

Returns: true if such a named property is available, else false.

Definition at line 261 of file BaseKernel.hh.

◆ get_property_handle() [4/5]

template<class T >

bool OpenMesh::BaseKernel::get_property_handle	(	MPropHandleT< T > &	_ph,
		const std::string &	_name
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::propertyExists) or one of its higher level helper functions such as makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Retrieves the handle to a named property by it's name.

Parameters

_ph	A property handle. On success the handle is valid else invalid.
_name	Name of wanted property.

Returns: true if such a named property is available, else false.

Definition at line 282 of file BaseKernel.hh.

◆ get_property_handle() [5/5]

template<class T >

bool OpenMesh::BaseKernel::get_property_handle	(	VPropHandleT< T > &	_ph,
		const std::string &	_name
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper (e.g. PropertyManager::propertyExists) or one of its higher level helper functions such as makePropertyManagerFromExisting, or makePropertyManagerFromExistingOrNew.

Retrieves the handle to a named property by it's name.

Parameters

_ph	A property handle. On success the handle is valid else invalid.
_name	Name of wanted property.

Returns: true if such a named property is available, else false.

Definition at line 254 of file BaseKernel.hh.

◆ hprop_stats() [1/3]

void OpenMesh::BaseKernel::hprop_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 184 of file BaseKernel.cc.

◆ hprop_stats() [2/3]

void OpenMesh::BaseKernel::hprop_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 188 of file BaseKernel.cc.

◆ hprop_stats() [3/3]

void OpenMesh::BaseKernel::hprop_stats ( std::string & _string ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 109 of file BaseKernel.cc.

◆ hprops_begin() [1/2]

prop_iterator OpenMesh::BaseKernel::hprops_begin ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 795 of file BaseKernel.hh.

◆ hprops_begin() [2/2]

const_prop_iterator OpenMesh::BaseKernel::hprops_begin ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 797 of file BaseKernel.hh.

◆ hprops_clear()

void OpenMesh::BaseKernel::hprops_clear ( )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 725 of file BaseKernel.hh.

◆ hprops_end() [1/2]

prop_iterator OpenMesh::BaseKernel::hprops_end ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 796 of file BaseKernel.hh.

◆ hprops_end() [2/2]

const_prop_iterator OpenMesh::BaseKernel::hprops_end ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 798 of file BaseKernel.hh.

◆ hprops_reserve()

void OpenMesh::BaseKernel::hprops_reserve ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 723 of file BaseKernel.hh.

◆ hprops_resize()

void OpenMesh::BaseKernel::hprops_resize ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 724 of file BaseKernel.hh.

◆ hprops_swap()

void OpenMesh::BaseKernel::hprops_swap	(	unsigned int	_i0,
		unsigned int	_i1
	)		const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 728 of file BaseKernel.hh.

◆ mprop_stats() [1/3]

void OpenMesh::BaseKernel::mprop_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 220 of file BaseKernel.cc.

◆ mprop_stats() [2/3]

void OpenMesh::BaseKernel::mprop_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 224 of file BaseKernel.cc.

◆ mprop_stats() [3/3]

void OpenMesh::BaseKernel::mprop_stats ( std::string & _string ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 156 of file BaseKernel.cc.

◆ mproperty() [1/2]

template<class T >

PropertyT< T > & OpenMesh::BaseKernel::mproperty ( MPropHandleT< T > _ph )

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 346 of file BaseKernel.hh.

◆ mproperty() [2/2]

template<class T >

const PropertyT< T > & OpenMesh::BaseKernel::mproperty ( MPropHandleT< T > _ph ) const

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 350 of file BaseKernel.hh.

◆ mprops_begin() [1/2]

prop_iterator OpenMesh::BaseKernel::mprops_begin ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 805 of file BaseKernel.hh.

◆ mprops_begin() [2/2]

const_prop_iterator OpenMesh::BaseKernel::mprops_begin ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 807 of file BaseKernel.hh.

◆ mprops_clear()

void OpenMesh::BaseKernel::mprops_clear ( )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 751 of file BaseKernel.hh.

◆ mprops_end() [1/2]

prop_iterator OpenMesh::BaseKernel::mprops_end ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 806 of file BaseKernel.hh.

◆ mprops_end() [2/2]

const_prop_iterator OpenMesh::BaseKernel::mprops_end ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 808 of file BaseKernel.hh.

◆ mprops_resize()

void OpenMesh::BaseKernel::mprops_resize ( size_t _n ) const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 750 of file BaseKernel.hh.

◆ n_edges()

virtual size_t OpenMesh::BaseKernel::n_edges ( ) const

inlinevirtual

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Reimplemented in OpenMesh::ArrayKernel.

Definition at line 690 of file BaseKernel.hh.

◆ n_elements() [1/5]

template<typename HandleT >

size_t OpenMesh::BaseKernel::n_elements ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

◆ n_elements() [2/5]

template<>

size_t OpenMesh::BaseKernel::n_elements ( ) const

inline

Definition at line 821 of file BaseKernel.hh.

◆ n_elements() [3/5]

template<>

size_t OpenMesh::BaseKernel::n_elements ( ) const

inline

Definition at line 823 of file BaseKernel.hh.

◆ n_elements() [4/5]

template<>

size_t OpenMesh::BaseKernel::n_elements ( ) const

inline

Definition at line 825 of file BaseKernel.hh.

◆ n_elements() [5/5]

template<>

size_t OpenMesh::BaseKernel::n_elements ( ) const

inline

Definition at line 827 of file BaseKernel.hh.

◆ n_eprops()

size_t OpenMesh::BaseKernel::n_eprops ( void ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 599 of file BaseKernel.hh.

◆ n_faces()

virtual size_t OpenMesh::BaseKernel::n_faces ( ) const

inlinevirtual

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Reimplemented in OpenMesh::ArrayKernel.

Definition at line 691 of file BaseKernel.hh.

◆ n_fprops()

size_t OpenMesh::BaseKernel::n_fprops ( void ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 603 of file BaseKernel.hh.

◆ n_halfedges()

virtual size_t OpenMesh::BaseKernel::n_halfedges ( ) const

inlinevirtual

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Reimplemented in OpenMesh::ArrayKernel.

Definition at line 689 of file BaseKernel.hh.

◆ n_hprops()

size_t OpenMesh::BaseKernel::n_hprops ( void ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 601 of file BaseKernel.hh.

◆ n_mprops()

size_t OpenMesh::BaseKernel::n_mprops ( void ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 605 of file BaseKernel.hh.

◆ n_vertices()

virtual size_t OpenMesh::BaseKernel::n_vertices ( ) const

inlinevirtual

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Reimplemented in OpenMesh::ArrayKernel.

Definition at line 688 of file BaseKernel.hh.

◆ n_vprops()

size_t OpenMesh::BaseKernel::n_vprops ( void ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 597 of file BaseKernel.hh.

◆ property() [1/18]

template<class T >

PropertyT< T > & OpenMesh::BaseKernel::property ( EPropHandleT< T > _ph )

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 328 of file BaseKernel.hh.

◆ property() [2/18]

template<class T >

const PropertyT< T > & OpenMesh::BaseKernel::property ( EPropHandleT< T > _ph ) const

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 332 of file BaseKernel.hh.

◆ property() [3/18]

template<class T >

EPropHandleT< T >::reference OpenMesh::BaseKernel::property	(	EPropHandleT< T >	_ph,
		EdgeHandle	_eh
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 395 of file BaseKernel.hh.

◆ property() [4/18]

template<class T >

EPropHandleT< T >::const_reference OpenMesh::BaseKernel::property	(	EPropHandleT< T >	_ph,
		EdgeHandle	_eh
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 401 of file BaseKernel.hh.

◆ property() [5/18]

template<class T >

PropertyT< T > & OpenMesh::BaseKernel::property ( FPropHandleT< T > _ph )

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 337 of file BaseKernel.hh.

◆ property() [6/18]

template<class T >

const PropertyT< T > & OpenMesh::BaseKernel::property ( FPropHandleT< T > _ph ) const

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 341 of file BaseKernel.hh.

◆ property() [7/18]

template<class T >

FPropHandleT< T >::reference OpenMesh::BaseKernel::property	(	FPropHandleT< T >	_ph,
		FaceHandle	_fh
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 408 of file BaseKernel.hh.

◆ property() [8/18]

template<class T >

FPropHandleT< T >::const_reference OpenMesh::BaseKernel::property	(	FPropHandleT< T >	_ph,
		FaceHandle	_fh
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 414 of file BaseKernel.hh.

◆ property() [9/18]

template<class T >

PropertyT< T > & OpenMesh::BaseKernel::property ( HPropHandleT< T > _ph )

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 319 of file BaseKernel.hh.

◆ property() [10/18]

template<class T >

const PropertyT< T > & OpenMesh::BaseKernel::property ( HPropHandleT< T > _ph ) const

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 323 of file BaseKernel.hh.

◆ property() [11/18]

template<class T >

HPropHandleT< T >::reference OpenMesh::BaseKernel::property	(	HPropHandleT< T >	_ph,
		HalfedgeHandle	_hh
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 382 of file BaseKernel.hh.

◆ property() [12/18]

template<class T >

HPropHandleT< T >::const_reference OpenMesh::BaseKernel::property	(	HPropHandleT< T >	_ph,
		HalfedgeHandle	_hh
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 388 of file BaseKernel.hh.

◆ property() [13/18]

template<class T >

MPropHandleT< T >::reference OpenMesh::BaseKernel::property ( MPropHandleT< T > _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 421 of file BaseKernel.hh.

◆ property() [14/18]

template<class T >

MPropHandleT< T >::const_reference OpenMesh::BaseKernel::property ( MPropHandleT< T > _ph ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 427 of file BaseKernel.hh.

◆ property() [15/18]

template<class T >

PropertyT< T > & OpenMesh::BaseKernel::property ( VPropHandleT< T > _ph )

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 310 of file BaseKernel.hh.

◆ property() [16/18]

template<class T >

const PropertyT< T > & OpenMesh::BaseKernel::property ( VPropHandleT< T > _ph ) const

inline

In most cases you should use the convenient PropertyManager wrapper and use of this function should not be necessary. Under some circumstances, however (i.e. making a property persistent), it might be necessary to use this function.

Access a property

This method returns a reference to property. The property handle must be valid! The result is unpredictable if the handle is invalid!

Parameters

_ph	A valid (!) property handle.

Returns: The wanted property if the handle is valid.

Definition at line 314 of file BaseKernel.hh.

◆ property() [17/18]

template<class T >

VPropHandleT< T >::reference OpenMesh::BaseKernel::property	(	VPropHandleT< T >	_ph,
		VertexHandle	_vh
	)

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 369 of file BaseKernel.hh.

◆ property() [18/18]

template<class T >

VPropHandleT< T >::const_reference OpenMesh::BaseKernel::property	(	VPropHandleT< T >	_ph,
		VertexHandle	_vh
	)		const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 375 of file BaseKernel.hh.

◆ property_stats() [1/2]

void OpenMesh::BaseKernel::property_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 50 of file BaseKernel.cc.

◆ property_stats() [2/2]

void OpenMesh::BaseKernel::property_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 54 of file BaseKernel.cc.

◆ remove_property() [1/5]

template<typename T >

void OpenMesh::BaseKernel::remove_property ( EPropHandleT< T > & _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper to manage (and remove) properties.

Remove a property.

Removes the property represented by the handle from the apropriate mesh item.

Parameters

_ph	Property to be removed. The handle is invalid afterwords.

Definition at line 210 of file BaseKernel.hh.

◆ remove_property() [2/5]

template<typename T >

void OpenMesh::BaseKernel::remove_property ( FPropHandleT< T > & _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper to manage (and remove) properties.

Remove a property.

Removes the property represented by the handle from the apropriate mesh item.

Parameters

_ph	Property to be removed. The handle is invalid afterwords.

Definition at line 218 of file BaseKernel.hh.

◆ remove_property() [3/5]

template<typename T >

void OpenMesh::BaseKernel::remove_property ( HPropHandleT< T > & _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper to manage (and remove) properties.

Remove a property.

Removes the property represented by the handle from the apropriate mesh item.

Parameters

_ph	Property to be removed. The handle is invalid afterwords.

Definition at line 202 of file BaseKernel.hh.

◆ remove_property() [4/5]

template<typename T >

void OpenMesh::BaseKernel::remove_property ( MPropHandleT< T > & _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper to manage (and remove) properties.

Remove a property.

Removes the property represented by the handle from the apropriate mesh item.

Parameters

_ph	Property to be removed. The handle is invalid afterwords.

Definition at line 226 of file BaseKernel.hh.

◆ remove_property() [5/5]

template<typename T >

void OpenMesh::BaseKernel::remove_property ( VPropHandleT< T > & _ph )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper to manage (and remove) properties.

Remove a property.

Removes the property represented by the handle from the apropriate mesh item.

Parameters

_ph	Property to be removed. The handle is invalid afterwords.

Definition at line 194 of file BaseKernel.hh.

◆ vprop_stats() [1/3]

void OpenMesh::BaseKernel::vprop_stats ( ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 172 of file BaseKernel.cc.

◆ vprop_stats() [2/3]

void OpenMesh::BaseKernel::vprop_stats ( std::ostream & _ostr ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 176 of file BaseKernel.cc.

◆ vprop_stats() [3/3]

void OpenMesh::BaseKernel::vprop_stats ( std::string & _string ) const

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 93 of file BaseKernel.cc.

◆ vprops_begin() [1/2]

prop_iterator OpenMesh::BaseKernel::vprops_begin ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 785 of file BaseKernel.hh.

◆ vprops_begin() [2/2]

const_prop_iterator OpenMesh::BaseKernel::vprops_begin ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 787 of file BaseKernel.hh.

◆ vprops_clear()

void OpenMesh::BaseKernel::vprops_clear ( )

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 715 of file BaseKernel.hh.

◆ vprops_end() [1/2]

prop_iterator OpenMesh::BaseKernel::vprops_end ( )

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 786 of file BaseKernel.hh.

◆ vprops_end() [2/2]

const_prop_iterator OpenMesh::BaseKernel::vprops_end ( ) const

inline

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 788 of file BaseKernel.hh.

◆ vprops_reserve()

void OpenMesh::BaseKernel::vprops_reserve ( size_t _n ) const

inlineprotected

Reserves space for _n elements in all vertex property vectors.

Definition at line 700 of file BaseKernel.hh.

◆ vprops_resize()

void OpenMesh::BaseKernel::vprops_resize ( size_t _n ) const

inlineprotected

Resizes all vertex property vectors to the specified size.

Definition at line 703 of file BaseKernel.hh.

◆ vprops_resize_if_smaller()

void OpenMesh::BaseKernel::vprops_resize_if_smaller ( size_t _n ) const

inlineprotected

Same as vprops_resize() but ignores vertex property vectors that have a size larger than _n.

Use this method instead of vprops_resize() if you plan to frequently reduce and enlarge the property container and you don't want to waste time reallocating the property vectors every time.

Definition at line 713 of file BaseKernel.hh.

◆ vprops_swap()

void OpenMesh::BaseKernel::vprops_swap	(	unsigned int	_i0,
		unsigned int	_i1
	)		const

inlineprotected

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 719 of file BaseKernel.hh.

Member Data Documentation

◆ eprops_

PropertyContainer OpenMesh::BaseKernel::eprops_

private

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 814 of file BaseKernel.hh.

◆ fprops_

PropertyContainer OpenMesh::BaseKernel::fprops_

private

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 815 of file BaseKernel.hh.

◆ hprops_

PropertyContainer OpenMesh::BaseKernel::hprops_

private

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 813 of file BaseKernel.hh.

◆ mprops_

PropertyContainer OpenMesh::BaseKernel::mprops_

private

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 816 of file BaseKernel.hh.

◆ vprops_

PropertyContainer OpenMesh::BaseKernel::vprops_

private

You should not use this function directly. Instead, use the convenient PropertyManager wrapper.

Return value of property for an item

Definition at line 812 of file BaseKernel.hh.

The documentation for this class was generated from the following files:

OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Mesh/BaseKernel.hh
OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Mesh/BaseKernel.cc

Public Member Functions

Access a property element using a handle to a mesh item

Detailed Description

Member Typedef Documentation

◆ const_prop_iterator

◆ prop_iterator

Constructor & Destructor Documentation

◆ BaseKernel()

◆ ~BaseKernel()

Member Function Documentation

◆ _add_eprop()

◆ _add_fprop()

◆ _add_hprop()

◆ _add_mprop()

◆ _add_vprop()

◆ _eprop() [1/4]

◆ _eprop() [2/4]

◆ _eprop() [3/4]

◆ _eprop() [4/4]

◆ _fprop() [1/4]

◆ _fprop() [2/4]

◆ _fprop() [3/4]

◆ _fprop() [4/4]

◆ _get_eprop() [1/2]

◆ _get_eprop() [2/2]

◆ _get_fprop() [1/2]

◆ _get_fprop() [2/2]

◆ _get_hprop() [1/2]

◆ _get_hprop() [2/2]

◆ _get_mprop() [1/2]

◆ _get_mprop() [2/2]

◆ _get_vprop() [1/2]

◆ _get_vprop() [2/2]

◆ _hprop() [1/4]

◆ _hprop() [2/4]

◆ _hprop() [3/4]

◆ _hprop() [4/4]

◆ _mprop() [1/4]

◆ _mprop() [2/4]

◆ _mprop() [3/4]

◆ _mprop() [4/4]

◆ _vprop() [1/4]

◆ _vprop() [2/4]

◆ _vprop() [3/4]

◆ _vprop() [4/4]

◆ add_property() [1/5]

◆ add_property() [2/5]

◆ add_property() [3/5]

◆ add_property() [4/5]

◆ add_property() [5/5]

◆ copy_all_kernel_properties()

◆ copy_all_properties() [1/4]

◆ copy_all_properties() [2/4]

◆ copy_all_properties() [3/4]

◆ copy_all_properties() [4/4]

◆ copy_property() [1/4]

◆ copy_property() [2/4]

◆ copy_property() [3/4]

◆ copy_property() [4/4]

◆ eprop_stats() [1/3]

◆ eprop_stats() [2/3]

◆ eprop_stats() [3/3]

◆ eprops_begin() [1/2]

◆ eprops_begin() [2/2]

◆ eprops_clear()

◆ eprops_end() [1/2]

◆ eprops_end() [2/2]

◆ eprops_reserve()

◆ eprops_resize()

◆ eprops_swap()

◆ fprop_stats() [1/3]

◆ fprop_stats() [2/3]

◆ fprop_stats() [3/3]

◆ fprops_begin() [1/2]

◆ fprops_begin() [2/2]

◆ fprops_clear()

◆ fprops_end() [1/2]

◆ fprops_end() [2/2]

◆ fprops_reserve()

◆ fprops_resize()