Scene Fusion 2 API Reference
KS::ksHierarchyObject< T >::DescendantIter< D > Class Template Reference

#include <ksHierarchyObject.h>

Public Member Functions

 DescendantIter (D obj)
 
bool Next ()
 
bool operator== (const DescendantIter< D > &other) const
 
bool operator!= (const DescendantIter< D > &other) const
 
Value ()
 

Detailed Description

template<typename T>
template<typename D>
class KS::ksHierarchyObject< T >::DescendantIter< D >

Descendant Iterator. Traverses children depth first until the sub tree of this object has been traversed. A null result indicates the end of iteration.

Constructor & Destructor Documentation

◆ DescendantIter()

template<typename T >
template<typename D >
KS::ksHierarchyObject< T >::DescendantIter< D >::DescendantIter ( obj)
inline

Constructor

Parameters
D- first iteration object

Member Function Documentation

◆ Next()

template<typename T >
template<typename D >
bool KS::ksHierarchyObject< T >::DescendantIter< D >::Next ( )
inline

Advance the iterator

Returns
bool - false if we have reached the end of the iteration

◆ operator!=()

template<typename T >
template<typename D >
bool KS::ksHierarchyObject< T >::DescendantIter< D >::operator!= ( const DescendantIter< D > &  other) const
inline

Not-equals comparison

Parameters
constDescendantIter<D>& - other iterator

◆ operator==()

template<typename T >
template<typename D >
bool KS::ksHierarchyObject< T >::DescendantIter< D >::operator== ( const DescendantIter< D > &  other) const
inline

Equals comparison

Parameters
constDescendantIter<D>& - other iterator

◆ Value()

template<typename T >
template<typename D >
D KS::ksHierarchyObject< T >::DescendantIter< D >::Value ( )
inline

Current iteration object.

Parameters
D- current object

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