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

An iterator for looping through all the materials in a materialmodule. More...

#include <material.hpp>

Public Member Functions

 Materialiterator (cmzn_materialiterator_id iterator_id)
 
 Materialiterator (const Materialiterator &materialiterator)
 
Materialiteratoroperator= (const Materialiterator &materialiterator)
 
bool isValid () const
 
Material next ()
 

Detailed Description

An iterator for looping through all the materials in a materialmodule.

An iterator for looping through all the materials in a materialmodule.

Member Function Documentation

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

Check if this is a valid Materialiterator object.

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

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

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

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