Modifier

A collection of visual changes to be applied to another renderable component. This collection includes a transform matrix, an opacity constant, a size, an origin specifier. Modifier objects can be added to any RenderNode or object capable of displaying renderables. The Modifier's children and descendants are transformed by the amounts specified in the Modifier's properties.

Overview

Options
transform
opacity
origin
size
Methods
transformFrom
opacityFrom
originFrom
alignFrom
sizeFrom
proportionsFrom
setTransform
setOpacity
setOrigin
setAlign
setSize
setProportions
halt
getTransform
getFinalTransform
getOpacity
getOrigin
getAlign
getSize
getProportions

Modifier(options)

Constructor Parameters

options

Object

overrides of default options

transform
Transform
affine transformation matrix
opacity
Number
origin
Array.Number
origin adjustment
size
Array.Number
size to apply to descendants
Methods

transformFrom(transform)

Function, object, or static transform matrix which provides the transform. This is evaluated on every tick of the engine.

Parameters
transform
Object
transform provider object
Returns
Modifier
this

opacityFrom(opacity)

Set function, object, or number to provide opacity, in range [0,1].

Parameters
opacity
Object
provider object
Returns
Modifier
this

originFrom(origin)

Set function, object, or numerical array to provide origin, as [x,y], where x and y are in the range [0,1].

Parameters
origin
Object
provider object
Returns
Modifier
this

alignFrom(align)

Set function, object, or numerical array to provide align, as [x,y], where x and y are in the range [0,1].

Parameters
align
Object
provider object
Returns
Modifier
this

sizeFrom(size)

Set function, object, or numerical array to provide size, as [width, height].

Parameters
size
Object
provider object
Returns
Modifier
this

proportionsFrom(proportions)

Set function, object, or numerical array to provide proportions, as [percent of width, percent of height].

Parameters
proportions
Object
provider object
Returns
Modifier
this

setTransform(transform, transition, callback)Deprecated

Deprecated: Prefer transformFrom with static Transform, or use a TransitionableTransform.

Parameters
transform
Transform
Transform to transition to
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

setOpacity(opacity, transition, callback)Deprecated

Deprecated: Prefer opacityFrom with static opacity array, or use a Transitionable with that opacity.

Parameters
opacity
Number
Opacity value to transition to.
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

setOrigin(origin, transition, callback)Deprecated

Deprecated: Prefer originFrom with static origin array, or use a Transitionable with that origin.

Parameters
origin
Array.Number
two element array with values between 0 and 1.
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

setAlign(align, transition, callback)Deprecated

Deprecated: Prefer alignFrom with static align array, or use a Transitionable with that align.

Parameters
align
Array.Number
two element array with values between 0 and 1.
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

setSize(size, transition, callback)Deprecated

Deprecated: Prefer sizeFrom with static origin array, or use a Transitionable with that size.

Parameters
size
Array.Number
two element array of [width, height]
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

setProportions(proportions, transition, callback)Deprecated

Deprecated: Prefer proportionsFrom with static origin array, or use a Transitionable with those proportions.

Parameters
proportions
Array.Number
two element array of [percent of width, percent of height]
transition
Transitionable
Valid transitionable object
callback
Function
callback to call after transition completes
Returns
Modifier
this

halt()Deprecated

Deprecated: Prefer to stop transform in your provider object.

getTransform()Deprecated

Deprecated: Prefer to use your provided transform or output of your transform provider.

Returns
Object
transform provider object

getFinalTransform()Deprecated

Deprecated: Prefer to determine the end state of your transform from your transform provider

Returns
Transform
transform matrix

getOpacity()Deprecated

Deprecated: Prefer to use your provided opacity or output of your opacity provider.

Returns
Object
opacity provider object

getOrigin()Deprecated

Deprecated: Prefer to use your provided origin or output of your origin provider.

Returns
Object
origin provider object

getAlign()Deprecated

Deprecated: Prefer to use your provided align or output of your align provider.

Returns
Object
align provider object

getSize()Deprecated

Deprecated: Prefer to use your provided size or output of your size provider.

Returns
Object
size provider object

getProportions()Deprecated

Deprecated: Prefer to use your provided proportions or output of your proportions provider.

Returns
Object
proportions provider object