Flipper

Allows you to link two renderables as front and back sides that can be 'flipped' back and forth along a chosen axis. Rendering optimizations are automatically handled.

Overview

Options
transition
direction
Methods
flip
setAngle
setOptions
setFront
setBack

Flipper(options)

Constructor Parameters

options

Options

An object of options.

transition
Transition
The transition executed when flipping your Flipper instance.
direction
Direction
Direction specifies the axis of rotation.
Methods

flip(transition, callback)

Toggles the rotation between the front and back renderables

Parameters
transition
Object
Transition definition
callback
Function
Callback

setAngle(angle, transition, callback)

Basic setter to the angle

Parameters
angle
Number
transition
Object
Transition definition
callback
Function
Callback

setOptions(options)

Patches the Flipper instance's options with the passed-in ones.

Parameters
options
Options
An object of configurable options for the Flipper instance.

setFront(node)

Adds the passed-in renderable to the view associated with the 'front' of the Flipper instance.

Parameters
node
Object
The renderable you want to add to the front.

setBack(node)

Adds the passed-in renderable to the view associated with the 'back' of the Flipper instance.

Parameters
node
Object
The renderable you want to add to the back.