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

An iterator for looping through all the lights in a light module. More...

#include <light.hpp>

Public Member Functions

 Lightiterator (cmzn_lightiterator_id iterator_id)
 
 Lightiterator (const Lightiterator &lightiterator)
 
Lightiteratoroperator= (const Lightiterator &lightiterator)
 
bool isValid () const
 
Light next ()
 

Detailed Description

An iterator for looping through all the lights in a light module.

An iterator for looping through all the lights in a light module.

Member Function Documentation

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

Check if this is a valid Lightiterator object.

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

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

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

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