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

An iterator for looping through all the glyphs in a glyphmodule. More...

#include <glyph.hpp>

Public Member Functions

 Glyphiterator (cmzn_glyphiterator_id iterator_id)
 
 Glyphiterator (const Glyphiterator &glyphiterator)
 
Glyphiteratoroperator= (const Glyphiterator &glyphiterator)
 
bool isValid () const
 
Glyph next ()
 

Detailed Description

An iterator for looping through all the glyphs in a glyphmodule.

An iterator for looping through all the glyphs in a glyphmodule.

Member Function Documentation

bool OpenCMISS::Zinc::Glyphiterator::isValid ( ) const
inline

Check if this is a valid Glyphiterator object.

Returns
Status True if object is valid, false otherwise.
Glyph OpenCMISS::Zinc::Glyphiterator::next ( )
inline

Returns a handle to the next glyph in the container being iterated over then advances the iterator position. The caller is required to destroy the returned glyph handle.

Returns
Handle to the next glyph, or NULL/invalid handle if none or failed.

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