Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
OpenMesh::PropertyManager< PROPTYPE, MeshT > Class Template Reference

#include <libs_required/OpenMesh/src/OpenMesh/Core/Utils/PropertyManager.hh>

Classes

class  Proxy
 

Public Member Functions

 PropertyManager (MeshT &mesh, const char *propname, bool existing=false)
 
void swap (PropertyManager &rhs)
 
bool isValid () const
 
 operator bool () const
 
const PROPTYPE & getRawProperty () const
 
const std::string & getName () const
 
MeshT & getMesh () const
 
 operator Proxy ()
 
Proxy move ()
 
 PropertyManager (Proxy p)
 
PropertyManageroperator= (Proxy p)
 
Proxy duplicate (const char *clone_name)
 
void retain (bool doRetain=true)
 Disable lifecycle management for this property. More...
 
PROPTYPE & operator* ()
 
const PROPTYPE & operator* () const
 
template<typename HandleType >
PROPTYPE::reference operator[] (const HandleType &handle)
 
template<typename HandleType >
PROPTYPE::const_reference operator[] (const HandleType &handle) const
 
template<typename HandleTypeIterator >
void set_range (HandleTypeIterator begin, HandleTypeIterator end, typename PROPTYPE::const_reference value)
 
template<typename HandleTypeIterator , typename PROPTYPE_2 , typename MeshT_2 , typename HandleTypeIterator_2 >
void copy_to (HandleTypeIterator begin, HandleTypeIterator end, PropertyManager< PROPTYPE_2, MeshT_2 > &dst_propmanager, HandleTypeIterator_2 dst_begin, HandleTypeIterator_2 dst_end) const
 
template<typename RangeType , typename PROPTYPE_2 , typename MeshT_2 , typename RangeType_2 >
void copy_to (const RangeType &range, PropertyManager< PROPTYPE_2, MeshT_2 > &dst_propmanager, const RangeType_2 &dst_range) const
 

Static Public Member Functions

static bool propertyExists (MeshT &mesh, const char *propname)
 
static Proxy createIfNotExists (MeshT &mesh, const char *propname)
 
template<typename RangeType , typename MeshT_2 , typename RangeType_2 >
static void copy (const char *prop_name, MeshT &src_mesh, const RangeType &src_range, MeshT_2 &dst_mesh, const RangeType_2 &dst_range)
 

Private Member Functions

 PropertyManager (const PropertyManager &)
 
PropertyManageroperator= (const PropertyManager &)
 
void deleteProperty ()
 

Private Attributes

MeshT * mesh_
 
PROPTYPE prop_
 
bool retain_
 
std::string name_
 

Detailed Description

template<typename PROPTYPE, typename MeshT>
class OpenMesh::PropertyManager< PROPTYPE, MeshT >

This class is intended to manage the lifecycle of properties. It also defines convenience operators to access the encapsulated property's value.

Usage example:

TriMesh mesh;
PropertyManager<VPropHandleT<bool>, TriMesh> visited(mesh, "visited.plugin-example.i8.informatik.rwth-aachen.de");
for (TriMesh::VertexIter vh_it = mesh.begin(); ... ; ...) {
if (!visited[*vh_it]) {
visitComponent(mesh, *vh_it, visited);
}
}

Definition at line 71 of file PropertyManager.hh.

Constructor & Destructor Documentation

template<typename PROPTYPE, typename MeshT>
OpenMesh::PropertyManager< PROPTYPE, MeshT >::PropertyManager ( const PropertyManager< PROPTYPE, MeshT > &  )
private

Noncopyable because there aren't no straightforward copy semantics.

template<typename PROPTYPE, typename MeshT>
OpenMesh::PropertyManager< PROPTYPE, MeshT >::PropertyManager ( MeshT &  mesh,
const char *  propname,
bool  existing = false 
)
inline

Constructor.

Throws an std::runtime_error if existing is true and no property named propname of the appropriate property type exists.

Parameters
meshThe mesh on which to create the property.
propnameThe name of the property.
existingIf false, a new property is created and its lifecycle is managed (i.e. the property is deleted upon destruction of the PropertyManager instance). If true, the instance merely acts as a convenience wrapper around an existing property with no lifecycle management whatsoever.

Definition at line 104 of file PropertyManager.hh.

Member Function Documentation

template<typename PROPTYPE, typename MeshT>
template<typename RangeType , typename MeshT_2 , typename RangeType_2 >
static void OpenMesh::PropertyManager< PROPTYPE, MeshT >::copy ( const char *  prop_name,
MeshT &  src_mesh,
const RangeType &  src_range,
MeshT_2 &  dst_mesh,
const RangeType_2 &  dst_range 
)
inlinestatic

Copy the values of a property from a source range to a target range. The source range must not be smaller than the target range.

Parameters
prop_nameName of the property to copy. Must exist on the source mesh. Will be created on the target mesh if it doesn't exist.
src_meshSource mesh from which to copy.
src_rangeSource range which to copy. Must not be smaller than dst_range.
dst_meshDestination mesh on which to copy.
dst_rangeDestination range.

Definition at line 372 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
template<typename HandleTypeIterator , typename PROPTYPE_2 , typename MeshT_2 , typename HandleTypeIterator_2 >
void OpenMesh::PropertyManager< PROPTYPE, MeshT >::copy_to ( HandleTypeIterator  begin,
HandleTypeIterator  end,
PropertyManager< PROPTYPE_2, MeshT_2 > &  dst_propmanager,
HandleTypeIterator_2  dst_begin,
HandleTypeIterator_2  dst_end 
) const
inline

Conveniently transfer the values managed by one property manager onto the values managed by a different property manager.

Parameters
beginStart iterator. Needs to dereference to HandleType. Will be used with this property manager.
endEnd iterator. (Exclusive.) Will be used with this property manager.
dst_propmanagerThe destination property manager.
dst_beginStart iterator. Needs to dereference to the HandleType of dst_propmanager. Will be used with dst_propmanager.
dst_endEnd iterator. (Exclusive.) Will be used with dst_propmanager. Used to double check the bounds.

Definition at line 339 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
static Proxy OpenMesh::PropertyManager< PROPTYPE, MeshT >::createIfNotExists ( MeshT &  mesh,
const char *  propname 
)
inlinestatic

Create a property manager for the supplied property and mesh. If the property doesn't exist, it is created. In any case, lifecycle management is disabled.

Definition at line 230 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
PROPTYPE& OpenMesh::PropertyManager< PROPTYPE, MeshT >::operator* ( )
inline

Access the encapsulated property.

Definition at line 257 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
const PROPTYPE& OpenMesh::PropertyManager< PROPTYPE, MeshT >::operator* ( ) const
inline

Access the encapsulated property.

Definition at line 264 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
PropertyManager& OpenMesh::PropertyManager< PROPTYPE, MeshT >::operator= ( const PropertyManager< PROPTYPE, MeshT > &  )
private

Noncopyable because there aren't no straightforward copy semantics.

template<typename PROPTYPE, typename MeshT>
template<typename HandleType >
PROPTYPE::reference OpenMesh::PropertyManager< PROPTYPE, MeshT >::operator[] ( const HandleType &  handle)
inline

Enables convenient access to the encapsulated property.

For a usage example see this class' documentation.

Parameters
handleA handle of the appropriate handle type. (I.e. VertexHandle for VPropHandleT, etc.)

Definition at line 276 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
template<typename HandleType >
PROPTYPE::const_reference OpenMesh::PropertyManager< PROPTYPE, MeshT >::operator[] ( const HandleType &  handle) const
inline

Enables convenient access to the encapsulated property.

For a usage example see this class' documentation.

Parameters
handleA handle of the appropriate handle type. (I.e. VertexHandle for VPropHandleT, etc.)

Definition at line 288 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
void OpenMesh::PropertyManager< PROPTYPE, MeshT >::retain ( bool  doRetain = true)
inline

Disable lifecycle management for this property.

If this method is called, the encapsulated property will not be deleted upon destruction of the PropertyManager instance.

Definition at line 250 of file PropertyManager.hh.

template<typename PROPTYPE, typename MeshT>
template<typename HandleTypeIterator >
void OpenMesh::PropertyManager< PROPTYPE, MeshT >::set_range ( HandleTypeIterator  begin,
HandleTypeIterator  end,
typename PROPTYPE::const_reference  value 
)
inline

Conveniently set the property for an entire range of values.

Examples:

MeshT mesh;
PropertyManager<VPropHandleT<double>, MeshT> distance(
mesh, "distance.plugin-example.i8.informatik.rwth-aachen.de");
distance.set_range(
mesh.vertices_begin(), mesh.vertices_end(),
std::numeric_limits<double>::infinity());

or

MeshT::VertexHandle vh;
distance.set_range(
mesh.vv_begin(vh), mesh.vv_end(vh),
std::numeric_limits<double>::infinity());
Parameters
beginStart iterator. Needs to dereference to HandleType.
endEnd iterator. (Exclusive.)
valueThe value the range will be set to.

Definition at line 317 of file PropertyManager.hh.


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