RenderController

A dynamic view that can show or hide different renderables with transitions.

Overview

Options
Methods
inTransformFrom
inOpacityFrom
inOriginFrom
inAlignFrom
outTransformFrom
outOpacityFrom
outOriginFrom
outAlignFrom
show
hide

RenderController(options, inTransition, outTransition, overlap)

Constructor Parameters

options

Options

An object of configurable options.

inTransition

Transition

The transition in charge of showing a renderable.

outTransition

Transition

The transition in charge of removing your previous renderable when you show a new one, or hiding your current renderable.

overlap

Boolean

When showing a new renderable, overlap determines if the out transition of the old one executes concurrently with the in transition of the new one, or synchronously beforehand.

Methods

inTransformFrom(transform)

As your RenderController shows a new renderable, it executes a transition in. This transition in will affect a default interior state and modify it as you bring renderables in and out. However, if you want to control the transform, opacity, and origin state yourself, you may call certain methods (such as inTransformFrom) to obtain state from an outside source, that may either be a function or a Famous transitionable. inTransformFrom sets the accessor for the state of the transform used in transitioning in renderables.

Parameters
transform
Function|Transitionable
A function that returns a transform from outside closure, or a a transitionable that manages a full transform (a sixteen value array).

inOpacityFrom(opacity)

inOpacityFrom sets the accessor for the state of the opacity used in transitioning in renderables.

Parameters
opacity
Function|Transitionable
A function that returns an opacity from outside closure, or a a transitionable that manages opacity (a number between zero and one).

inOriginFrom(origin)

inOriginFrom sets the accessor for the state of the origin used in transitioning in renderables.

Parameters
origin
Function|Transitionable
A function that returns an origin from outside closure, or a a transitionable that manages origin (a two value array of numbers between zero and one).

inAlignFrom(align)

inAlignFrom sets the accessor for the state of the align used in transitioning in renderables.

Parameters
align
Function|Transitionable
A function that returns an align from outside closure, or a a transitionable that manages align (a two value array of numbers between zero and one).

outTransformFrom(transform)

outTransformFrom sets the accessor for the state of the transform used in transitioning out renderables.

Parameters
transform
Function|Transitionable
A function that returns a transform from outside closure, or a a transitionable that manages a full transform (a sixteen value array).

outOpacityFrom(opacity)

outOpacityFrom sets the accessor for the state of the opacity used in transitioning out renderables.

Parameters
opacity
Function|Transitionable
A function that returns an opacity from outside closure, or a a transitionable that manages opacity (a number between zero and one).

outOriginFrom(origin)

outOriginFrom sets the accessor for the state of the origin used in transitioning out renderables.

Parameters
origin
Function|Transitionable
A function that returns an origin from outside closure, or a a transitionable that manages origin (a two value array of numbers between zero and one).

outAlignFrom(align)

outAlignFrom sets the accessor for the state of the align used in transitioning out renderables.

Parameters
align
Function|Transitionable
A function that returns an align from outside closure, or a a transitionable that manages align (a two value array of numbers between zero and one).

show(renderable, transition, callback)

Show displays the targeted renderable with a transition and an optional callback to execute afterwards.

Parameters
renderable
Object
The renderable you want to show.
transition
Transition
Overwrites the default transition in to display the passed-in renderable.
callback
Function
Executes after transitioning in the renderable.

hide(transition, callback)

Hide hides the currently displayed renderable with an out transition.

Parameters
transition
Transition
Overwrites the default transition in to hide the currently controlled renderable.
callback
Function
Executes after transitioning out the renderable.