OpenCMISS-Zinc C++ API Documentation
Public Member Functions | List of all members
OpenCMISS::Zinc::Meshchanges Class Reference

Object describing changes to a mesh in a fieldmoduleevent. More...

#include <mesh.hpp>

Public Member Functions

 Meshchanges (cmzn_meshchanges_id meshchanges_id)
 
 Meshchanges (const Meshchanges &meshchanges)
 
Meshchangesoperator= (const Meshchanges &meshchanges)
 
bool isValid () const
 
Element::ChangeFlags getElementChangeFlags (const Element &element)
 
int getNumberOfChanges ()
 
Element::ChangeFlags getSummaryElementChangeFlags ()
 

Detailed Description

Object describing changes to a mesh in a fieldmoduleevent.

Object describing changes to a mesh in a fieldmoduleevent

Member Function Documentation

Element::ChangeFlags OpenCMISS::Zinc::Meshchanges::getElementChangeFlags ( const Element element)
inline

Returns if and how the element has changed in the mesh changes. Note that individual changes are not stored for each element, hence this function returns the summary of all element changes if the element has changed, and CHANGE_FLAG_NONE if not changed.

Parameters
elementThe element to query about.
Returns
Logical OR of change bit flags. See #cmzn_element_change_flag.
int OpenCMISS::Zinc::Meshchanges::getNumberOfChanges ( )
inline

Returns the number of elements recorded as changed in the mesh changes, or -1 if all considered changed, i.e. too many changes occurred to record.

Returns
The number of changes to elements, or -1 if all changed.
Element::ChangeFlags OpenCMISS::Zinc::Meshchanges::getSummaryElementChangeFlags ( )
inline

Returns logical OR of change flags for all elements in the mesh changes.

Returns
Logical OR of change bit flags. See #cmzn_element_change_flag.
bool OpenCMISS::Zinc::Meshchanges::isValid ( ) const
inline

Check if this is a valid Meshchanges object.

Returns
Status True if object is valid, false otherwise.

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