IlvEventPlayer Class Reference

Event player class. More...

#include <ilviews/util/evplayer.h>

List of all members.

Public Member Functions
	IlvEventPlayer ()
	Constructor.
virtual IlBoolean	load (IlvDisplay *, const char *filename)
	Loads an event sequence.
virtual void	play (IlvDisplay *, IlUInt speed=1000, IlBoolean movePointer=((IlBoolean) 0))
	Plays the events.
void	playOnce (IlvDisplay *)
	Plays one event at a time.
virtual void	playOneEvent (IlvAbstractView *view, IlvEvent &event)
	Plays a given event.
virtual void	recordOneEvent (IlvView *view, IlvEvent &event)
	Records a given event.
virtual IlBoolean	save (const char *filename) const
	Saves an event sequence.
virtual void	start ()
	Resets the event player.
void	stop ()
	Stops the recording of events.

---

Detailed Description

Event player class.

Library: display

This class is designed to handle the recording of sequences of events that occur in the views that it controls. These event sequences can be saved or read from a data file, and played back at any speed.

See also:

IlvCurrentEventPlayer, IlvRecordingEvents.

---

Constructor & Destructor Documentation

IlvEventPlayer::IlvEventPlayer

(

)

Constructor.

The constructor initializes a new empty event player ready to record user events or load an event data file.

---

Member Function Documentation

virtual IlBoolean IlvEventPlayer::load	(	IlvDisplay *	,
		const char *	filename
	)			[virtual]

Loads an event sequence.

Loads an event sequence from the specified file. The previous list is emptied.

Returns:

IlFalse if there has been an error, and IlTrue otherwise.

virtual void IlvEventPlayer::play	(	IlvDisplay *	,
		IlUInt	speed = 1000,
		IlBoolean	movePointer = ((IlBoolean) 0)
	)			[virtual]

Plays the events.

Triggers, at a specified speed, each event stored in this event player. The greater period is, the slower the events will be played back. (In fact, it defines a period of time.) The default value 1000 indicates that the events are played back at the same speed, and with the same intervals between events, as they occurred when they were recorded.

Parameters:

period

Period of time at which events are played back.

void IlvEventPlayer::playOnce

(

IlvDisplay *

)

Plays one event at a time.

Triggers only one event at a time. An internal event pointer is updated to point to the next event of the event sequence.

virtual void IlvEventPlayer::playOneEvent	(	IlvAbstractView *	view,
		IlvEvent &	event
	)			[virtual]

Plays a given event.

Sends the event event to the view view. It is called when playing the event list, for each event that occurs.

Parameters:

	view	Gives the view where the event is to be played.
	event	The event to be played.

virtual void IlvEventPlayer::recordOneEvent	(	IlvView *	view,
		IlvEvent &	event
	)			[virtual]

Records a given event.

Records the event event for the view view, in the IlvEventPlayer.

Parameters:

	view	Gives the view where the event is to be recorded from.
	event	The event to be recorded.

virtual IlBoolean IlvEventPlayer::save

(

const char *

filename

)

const [virtual]

Saves an event sequence.

Saves the event sequence in the specified file.

Returns:

IlFalse if there has been an error, and IlTrue otherwise.

virtual void IlvEventPlayer::start

(

)

[virtual]

Resets the event player.

Resets this event player to the initial state. The event sequence is emptied.

void IlvEventPlayer::stop

(

)

Stops the recording of events.

Stops the recording of events for this event player, if it was the current event recorder.