NITE 1.5.1 - API Reference

XnVMultipleHands::ConstIterator Class Reference

#include <XnVMultipleHands.h>

Inheritance diagram for XnVMultipleHands::ConstIterator:
Collaboration diagram for XnVMultipleHands::ConstIterator:

List of all members.

Public Member Functions

 ConstIterator (const ConstIterator &other)
ConstIteratoroperator++ ()
ConstIterator operator++ (int)
XnBool operator== (const ConstIterator &other) const
XnBool operator!= (const ConstIterator &other) const
const XnVHandPointContextoperator* () const
XnBool IsNew () const
XnBool IsActive () const
XnBool IsValid () const

Protected Member Functions

 ConstIterator (const XnVMultipleHands *pHands)
 ConstIterator (const XnVMultipleHands *pHands, XnUInt32 nPosition)

Protected Attributes

const XnVMultipleHandsm_pHands
XnUInt32 m_nPosition
XnBool m_bValid

Friends

class XnVMultipleHands

Detailed Description

Enable iteration over hands. This is the const version of the iterator.

Definition at line 165 of file XnVMultipleHands.h.


Constructor & Destructor Documentation

XnVMultipleHands::ConstIterator::ConstIterator ( const ConstIterator other)

Copy constructor. Copies the internal state of the other iterator

Parameters:
[in]otherThe other iterator
XnVMultipleHands::ConstIterator::ConstIterator ( const XnVMultipleHands pHands) [protected]
XnVMultipleHands::ConstIterator::ConstIterator ( const XnVMultipleHands pHands,
XnUInt32  nPosition 
) [protected]

Member Function Documentation

XnBool XnVMultipleHands::ConstIterator::IsActive ( ) const

Check if the current Point is active

Returns:
TRUE if point is active, FALSE o/w
XnBool XnVMultipleHands::ConstIterator::IsNew ( ) const

Check if the current Point is a new point.

Returns:
TRUE if point is new, FALSE o/w
XnBool XnVMultipleHands::ConstIterator::IsValid ( ) const

Check if the iterator is valid

Returns:
TRUE if iterator is valid, FALSE o/w
XnBool XnVMultipleHands::ConstIterator::operator!= ( const ConstIterator other) const

Compare with another iterator.

Returns:
FALSE if both iterators are valid and refer to the same position in the same MultipleHands, o/w TRUE
const XnVHandPointContext* XnVMultipleHands::ConstIterator::operator* ( ) const

Get the HandPointContext the iterator currently refers to.

Returns:
The current HandPointContext. NULL if invalid.

Reimplemented in XnVMultipleHands::Iterator.

ConstIterator XnVMultipleHands::ConstIterator::operator++ ( int  )

Advance the iterator to the next position.

Returns:
iterator before advancing

Reimplemented in XnVMultipleHands::Iterator.

ConstIterator& XnVMultipleHands::ConstIterator::operator++ ( )

Advance the iterator to the next position.

Returns:
iterator after advancing

Reimplemented in XnVMultipleHands::Iterator.

XnBool XnVMultipleHands::ConstIterator::operator== ( const ConstIterator other) const

Compare with another iterator.

Returns:
TRUE if both iterators are valid and refer to the same position in the same MultipleHands, o/w FALSE

Friends And Related Function Documentation

friend class XnVMultipleHands [friend]

Reimplemented in XnVMultipleHands::Iterator.

Definition at line 168 of file XnVMultipleHands.h.


Member Data Documentation

Definition at line 234 of file XnVMultipleHands.h.

Definition at line 233 of file XnVMultipleHands.h.

Definition at line 232 of file XnVMultipleHands.h.


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