API Docs for: 0.2
Show:

fx Class

Defined in: src/effects.js:20

Effects : A facade for easy to use animations.

Item Index

Methods

Methods

fadeIn

(
  • item
  • settings
)

Defined in src/effects.js:78

Increase the opacity to 1

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • duration Number

      Duration of the animation. Default : 500

    • easing String

      Name of the easing function. Default : swing

    • complete Function

      complete callback

fadeOut

(
  • item
  • settings
)

Defined in src/effects.js:108

Decrease the opacity to 0

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • duration Number

      Duration of the animation. Default : 500

    • easing String

      Name of the easing function. Default : swing

    • complete Function

      complete callback

grow

(
  • path
)
deprecated

Defined in src/effects.js:27

Grow a path

Parameters:

  • path Object

    a paper.js Path object

shake

(
  • item
  • settings
)

Defined in src/effects.js:38

Shake an item

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • nb Number

      Number of shakes. Default : 2

    • movement Number

      Length of each shake? Default : 40

    • complete Function

      complete callback

slideDown

(
  • item
  • settings
  • setting.distance
)

Defined in src/effects.js:174

Decrease the opacity to 0 and go downward

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • duration Number

      Duration of the animation. Default : 500

    • easing String

      Name of the easing function. Default : swing

    • complete Function

      complete callback

  • setting.distance Number

    Distance to move downward. Default : 50

slideUp

(
  • item
  • settings
  • setting.distance
)

Defined in src/effects.js:138

Increase the opacity to 1 and go upward

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • duration Number

      Duration of the animation. Default : 500

    • easing String

      Name of the easing function. Default : swing

    • complete Function

      complete callback

  • setting.distance Number

    Distance to move upward. Default : 50

splash

(
  • item
  • settings
)

Defined in src/effects.js:210

Increase the opacity to 1, rotates 360deg and scales by 3.

Parameters:

  • item Object

    a paper.js Item object

  • settings Object
    • duration Number

      Duration of the animation. Default : 500

    • easing String

      Name of the easing function. Default : swing

    • complete Function

      complete callback