Olympe SDK

Class: Grow

olympe.ui.std.animations. Grow

A Grow animation will progressively scale a new screen to the specified size over a given duration.

new Grow( [direction] [, duration] [, targetDimension])

Creates a Grow animation for a specified duration, size and direction.

Parameters:
Name Type Argument Description
direction olympe.df.Proxy.<olympe.ui.std.animations.Grow.ORIENTATION> | olympe.ui.std.animations.Grow.ORIENTATION <optional>

Direction in which to run the slide animation (default is left).
duration olympe.df.PONumber | number <optional>

Animation duration in milliseconds (default is 300 ms).
targetDimension olympe.df.PVector2 <optional>

End dimension to grow to.
Implements:

Members

<static> ORIENTATION :string

Grow directions

Type:
  • string
Properties:
Name Type Default Description
HORIZONTAL string hor
VERTICAL string ver

Methods

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

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

Parameters:
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])

Grow to X or Y target dimension, depending on orientation. If target dimension is not defined, initial element dimension will be used.

Parameters:
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:
Returns:

animated ONumber

Type
olympe.df.PONumber

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

Fold to X or Y = 0, depending on orientation. If target dimension is not defined, initial element dimension will be used.

Parameters:
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:
Returns:

animated ONumber

Type
olympe.df.PONumber