API docs for “elisa.plugins.poblesec.slideshow.transition

Specialised slideshow that uses 2-pictures transitions every interval seconds to swap the current and next pictures.

Class Variables transition_class transition to use in the slideshow (type: elisa.plugins.poblesec.slideshow.transitions.Transition )

Line #	Kind	Name	Docs
176	Method	__init__
188	Method	clean	Cleanup the slideshow as to prepare it for destruction.
196	Method	set_playlist	Set the list of pictures to display during the slideshow and display one
210	Method	set_interval	Set the time during which a picture should be displayed/in focus for the
213	Method	start	Start the automated slideshow.
225	Method	stop	Stop the slideshow.
233	Method	next	Display the next picture in the playlist.
249	Method	previous	Display the previous picture in the playlist.
260	Method	_load_and_display_picture	Undocumented
269	Method	_set_current_index	Undocumented
277	Method	_trap_cancelled	Undocumented
280	Method	_load_picture	Undocumented
287	Method	_cancel_looping_call	Undocumented
292	Method	_schedule_transition	Undocumented
317	Method	_do_transition_if_loaded	Undocumented
327	Method	_load_model_into_animated	Undocumented
334	Method	_activate_antialiasing	Undocumented
339	Method	_wrap_into_animated	Undocumented
345	Method	_do_transition_if_timeout	Undocumented
352	Method	_do_transition	Undocumented
365	Method	_insert_into_playground	Undocumented
371	Method	_remove_from_playground	Undocumented
378	Method	_end_of_slideshow	Undocumented

Inherited from Slideshow:

Line #	Kind	Name	Docs
156	Method	_get_status	Undocumented
159	Method	_set_status	Undocumented

def __init__(self, *args, **kwargs):

Parameters playground node of the scene where the pictures will be displayed (type: elisa.plugins.pigment.graph.group.Group )

def set_playlist(self, playlist, index=0):

Set the list of pictures to display during the slideshow and display one of them immediately, by default the first one.

Parameters	playlist	list of pictures to display during the slideshow (type: `list` of `elisa.plugins.base.models.image.ImageModel` )
	index	index in the playlist of the picture to display immediately (type: `int` )

def set_interval(self, interval):

Set the time during which a picture should be displayed/in focus for the user.

Parameters interval time in seconds (type: float )

def start(self, index=None):

Start the automated slideshow.

Parameters index index in the playlist of the picture to start the slideshow with (type: int )

Class e.p.p.s.t.TransitionSlideshow(Slideshow):