ImageListΒΆ

The ImageList class represents a list of Image objects. More...

Inherits Interface.

Public Types

typedef ConstListIterator< ImageList, Imageconst_iterator
 A C++ iterator type for ImageList objects. More...
 

Public Member Functions

ImageListappend (const ImageList &other)
 Appends the members of the specified ImageList to this ImageList. More...
 
const_iterator begin () const
 The C++ iterator set to the beginning of this ImageList. More...
 
int count () const
 The number of images in this list. More...
 
const_iterator end () const
 The C++ iterator set to the end of this ImageList. More...
 
 ImageList (const ListBaseImplementation< Image > &)
 
 ImageList ()
 Constructs an empty list of images. More...
 
bool isEmpty () const
 Reports whether the list is empty. More...
 
Image operator[] (int index) const
 Access a list member by its position in the list. More...
 

Detailed Description

The ImageList class represents a list of Image objects.

Get the ImageList object associated with the a Frame of tracking data by calling Frame::images(). Get the most recent set of images, which can be newer than the images used to create the current frame, by calling Controller::images().

Since
2.1.0

Member Typedef Documentation

typedef ConstListIterator<ImageList, Image> const_iterator

A C++ iterator type for ImageList objects.

Since
2.1.0

Constructor & Destructor Documentation

ImageList ( const ListBaseImplementation< Image > &  )
ImageList ( )

Constructs an empty list of images.

Since
2.1.0

Member Function Documentation

ImageList& append ( const ImageList other)

Appends the members of the specified ImageList to this ImageList.

Parameters
otherA ImageList object containing Image objects to append to the end of this ImageList.
Since
2.1.0
const_iterator begin ( ) const

The C++ iterator set to the beginning of this ImageList.

Since
2.1.0
int count ( ) const

The number of images in this list.

Returns
The number of images in this list.
Since
2.1.0
const_iterator end ( ) const

The C++ iterator set to the end of this ImageList.

Since
2.1.0
bool isEmpty ( ) const

Reports whether the list is empty.

Returns
True, if the list has no members.
Since
2.1.0
Image operator[] ( int  index) const

Access a list member by its position in the list.

Parameters
indexThe zero-based list position index.
Returns
The Image object at the specified index.
Since
2.1.0