---

imageSeq Class Reference

Class containing image sequence. More...

#include <imageSeq.h>

Collaboration diagram for imageSeq:

[legend]

Public Types
enum	directionType
	The possible directions that the sequence can be played in. More...
Public Methods
	imageSeq (imageSeqType type, const char *path)
	Constructor. More...
	~imageSeq ()
	Destructor. More...
int	getNumFrames (void)
	Returns the number of frames in this image sequence. More...
Picture *	tick (int frames=1)
	Returns the next appropriate image. More...
Picture *	getCurrent (void)
	Returns the current image. More...
int	getWidth (void)
	Returns the width of the image (in pixels). More...
int	getHeight (void)
	Returns the height of the image (in pixels). More...
imageSeqType	getSeqType (void)
	Returns the current sequence type. More...
bool	getCameraReady (void)
	Indicates whether the camera is ready or not. More...
Camera *	getCamera (void)
	Returns a pointer to the Camera object. More...
char *	getInfo (void)
	Returns the information string, loaded from the README file of the sequence. More...
Static Public Methods
int	file_select (const struct dirent *entry)
	Callback function used when scanning directories for image files. More...

---

Detailed Description

Class containing image sequence.

Images can be either Pixmaps or from a camera.

---

Member Enumeration Documentation

enum imageSeq::directionType

The possible directions that the sequence can be played in.

---

Constructor & Destructor Documentation

imageSeq::imageSeq (  imageSeqType    type, const char *    path )

Constructor.

imageSeq::~imageSeq (    )

Destructor. Deletes the instance of the class.

---

Member Function Documentation

int imageSeq::file_select (  const struct dirent *    entry )  [static]

Callback function used when scanning directories for image files. This function returns 1 if the file is accepted, and 0 otherwise. Currently this function accepts all files except 'README', '.' and '..'. In future this should only return 1 for those file types imageSeq can actually support. Parameters: entry  The file that is to be evaluated. Returns: Whether the file was accepted or not.

Camera * imageSeq::getCamera (  void    )

Returns a pointer to the Camera object. See also: Camera

bool imageSeq::getCameraReady (  void    )

Indicates whether the camera is ready or not.

Picture * imageSeq::getCurrent (  void    )

Returns the current image.

int imageSeq::getHeight (  void    )

Returns the height of the image (in pixels).

char * imageSeq::getInfo (  void    )

Returns the information string, loaded from the README file of the sequence.

int imageSeq::getNumFrames (  void    )

Returns the number of frames in this image sequence.

imageSeqType imageSeq::getSeqType (  void    )

Returns the current sequence type. See also: imageSeqType

int imageSeq::getWidth (  void    )

Returns the width of the image (in pixels).

Picture * imageSeq::tick (  int    frames = 1 )

Returns the next appropriate image. Parameters: frames  Number of frames to step through (default is 1) Returns: The request image.

---

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

• imageSeq.h
• imageSeq.cpp

---