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

Information about changes to glyphs in the glyph module. More...

#include <glyph.hpp>

Public Member Functions

 Glyphmoduleevent (cmzn_glyphmoduleevent_id in_glyphmodule_event_id)
 
 Glyphmoduleevent (const Glyphmoduleevent &glyphmoduleEvent)
 
Glyphmoduleeventoperator= (const Glyphmoduleevent &glyphmoduleEvent)
 
bool isValid () const
 
cmzn_glyphmoduleevent_id getId () const
 
Glyph::ChangeFlags getGlyphChangeFlags (const Glyph &glyph) const
 
Glyph::ChangeFlags getSummaryGlyphChangeFlags () const
 

Protected Attributes

cmzn_glyphmoduleevent_id id
 

Detailed Description

Information about changes to glyphs in the glyph module.

Information about changes to glyphs in the glyph module, sent with each callback from the glyphmodule notifier.

Member Function Documentation

Glyph::ChangeFlags OpenCMISS::Zinc::Glyphmoduleevent::getGlyphChangeFlags ( const Glyph glyph) const
inline

Get logical OR of flags indicating how the glyph has changed.

See also
Glyph::ChangeFlag
Parameters
glyphThe glyph to query about.
Returns
The change flags summarising the change: logical OR of enum Glyph::ChangeFlag values. Returns CMZN_SPECTRUM_CHANGE_FLAG_NONE in case of invalid arguments.
cmzn_glyphmoduleevent_id OpenCMISS::Zinc::Glyphmoduleevent::getId ( ) const
inline

Return the C handle of the Glyphmoduleevent object.

Returns
C handle of Glyphmoduleevent if this objects is valid, 0 otherwise.
Glyph::ChangeFlags OpenCMISS::Zinc::Glyphmoduleevent::getSummaryGlyphChangeFlags ( ) const
inline

Get logical OR of flags indicating how glyphs in the glyph module have changed.

See also
Glyph::ChangeFlag
Returns
The change flags summarising the change: logical OR of enum Glyph::ChangeFlag values.
bool OpenCMISS::Zinc::Glyphmoduleevent::isValid ( ) const
inline

Check if this is a valid Glyphmoduleevent object.

Returns
Status True if object is valid, false otherwise.

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