Olympe SDK Class: Zoom

Class: Zoom

olympe .ui .std .animations. Zoom

A Zoom animation transition a screen by zooming in, or out, over a specified duration.

Creates a Zoom animation.

Name	Type	Argument	Default	Description
`position`	olympe.df.Proxy.<olympe.df.Vector2> \| olympe.df.Vector2			Top left corner of the section of the screen to zoom / where the new screen will appear.
`dimension`	olympe.df.Proxy.<olympe.df.Vector2> \| olympe.df.Vector2			Size of the section of the screen to zoom / where the new screen will appear.
`zoomOut`	olympe.df.POBoolean \| boolean	<optional>	false	`true` to zoom out instead of zoom in.
`duration`	olympe.df.PONumber \| number	<optional>	600	Animation duration in milliseconds.

Implements:

run(oldElement, newElement, oldElementId, newElementId, container [, onAnimationEnd])

Function called to run the animation on two elements WARNING : onAnimationEnd must be called for compatibility

Name	Type	Argument	Description
`oldElement`	olympe.ui.std.DockableElement \| olympe.df.Proxy.<olympe.ui.std.DockableElement>		screen to hide
`newElement`	olympe.ui.std.DockableElement \| olympe.df.Proxy.<olympe.ui.std.DockableElement>		screen to display
`oldElementId`	string
`newElementId`	string
`container`	olympe.ui.std.DockableElement
`onAnimationEnd`	function	<optional>

Implements:

runForward(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Zoom in place (at the end position and size equals the initial ones) Not fully tested!

Name	Type	Argument	Description
`element`	olympe.ui.std.DockableElement \| olympe.df.Proxy.<olympe.ui.std.DockableElement>		UI element to animate
`elementId`	string	<optional>
`container`	olympe.ui.std.DockableElement	<optional>
`onAnimationEnd`	function	<optional>
`synchronizedAnimatedValue`	olympe.df.PONumber	<optional>	Use an already existing animated ONumber to synchronize animations

Implements:

animated ONumber

runReverse(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Implementation not complete

Name	Type	Argument	Description
`element`	olympe.ui.std.DockableElement \| olympe.df.Proxy.<olympe.ui.std.DockableElement>		UI element to animate
`elementId`	string	<optional>
`container`	olympe.ui.std.DockableElement	<optional>
`onAnimationEnd`	function	<optional>
`synchronizedAnimatedValue`	olympe.df.PONumber	<optional>	Use an already existing animated ONumber to synchronize animations

Implements:

animated ONumber