Fader

Modifier that allows you to fade the opacity of affected renderables in and out.

Overview

Options
cull
transition
pulseInTransition
pulseOutTransition
Methods
setOptions
show
hide
set
halt
isVisible

Fader(options)

Constructor Parameters

options

Object

options configuration object.

cull
Boolean
Stops returning affected renderables up the tree when they're fully faded when true.
transition
Transition
The main transition for showing and hiding.
pulseInTransition
Transition
Controls the transition to a pulsed state when the Fader instance's pulse method is called.
pulseOutTransition
Transition
Controls the transition back from a pulsed state when the Fader instance's pulse method is called.
Methods

setOptions(options)

Set internal options, overriding any default options

Parameters
options
Object
overrides of default options. See constructor.

show(transition, callback)

Fully displays the Fader instance's associated renderables.

Parameters
transition
Transition
The transition that coordinates setting to the new state.
callback
Function
A callback that executes once you've transitioned to the fully shown state.

hide(transition, callback)

Fully fades the Fader instance's associated renderables.

Parameters
transition
Transition
The transition that coordinates setting to the new state.
callback
Function
A callback that executes once you've transitioned to the fully faded state.

set(state, transition, callback)

Manually sets the opacity state of the fader to the passed-in one. Executes with an optional transition and callback.

Parameters
state
Number
A number from zero to one: the amount of opacity you want to set to.
transition
Transition
The transition that coordinates setting to the new state.
callback
Function
A callback that executes once you've finished executing the pulse.

halt()

Halt the transition

isVisible()

Tells you if your Fader instance is above its visibility threshold.

Returns
Boolean
Whether or not your Fader instance is visible.