Options
All
  • Public
  • Public/Protected
  • All
Menu

animation which can be create anywhere and which will be run by animationManager

Hierarchy

  • animation

Index

Constructors

constructor

  • new animation(coreSystem: coreSystem, howmany?: number, start?: number, step?: number): animation
  • Create a new animation

    Parameters

    • coreSystem: coreSystem

      System of the 3D scene

    • Optional howmany: number

      How many step is needed to end the animation

    • Optional start: number

      Starting value

    • Optional step: number

      Progress step used in each run call

    Returns animation

Properties

count

count: number = 0

Current progress

funct

funct: Function

Function called at each run and used to animate something

functend

functend: Function

Function called when animation is over

howmany

howmany: number

How many step is needed to end the animation

running

running: boolean = false

Is the animation running or not

start

start: number = 0

Starting value

step

step: number = 1

Progress step used in each run call

Methods

alternate

  • alternate(howmany: number, alter: number, funct1: Function, funct2?: Function, functend?: Function): this
  • Create an infinite animation which will never stop

    Parameters

    • howmany: number

      How many step is needed to end the animation

    • alter: number

      How many step do we need to alternate the animation

    • funct1: Function

      Alternate function 1

    • Optional funct2: Function

      Alternate function 2

    • Optional functend: Function

      Function called when animation is over

    Returns this

go

  • go(funct: Function, functend?: Function): this
  • Set main animation functions and launch it (Often used after setting the animation parameters)

    Parameters

    • funct: Function

      Function called at each run and used to animate something

    • Optional functend: Function

      Function called when animation is over

    Returns this

infinite

  • infinite(funct: Function): this
  • Create an infinite animation which will never stop

    Parameters

    • funct: Function

      Function called at each run and used to animate something

    Returns this

loop

  • loop(howmany: number, loop: number, funct: Function, functloop?: Function, functend?: Function): this
  • Create an infinite animation which will never stop

    Parameters

    • howmany: number

      How many step is needed to end the animation

    • loop: number

      How many step do we need to loopn the animation

    • funct: Function

      Function called at each run and used to animate something

    • Optional functloop: Function

      Function called everytime the loop goes back to start

    • Optional functend: Function

      Function called when animation is over

    Returns this

pause

  • pause(): this

play

  • play(): this

setParam

  • setParam(howmany: number, start?: number, step?: number): this
  • Set animation parameters

    Parameters

    • howmany: number

      How many step is needed to end the animation

    • Optional start: number

      Starting value

    • Optional step: number

      Progress step used in each run call

    Returns this

simple

  • simple(howmany: number, funct: Function, functend?: Function): this
  • Easiest way to lauch an animation (By default it start at 0 and use a step of 1)

    Parameters

    • howmany: number

      How many step is needed to end the animation

    • funct: Function

      Function called at each run and used to animate something

    • Optional functend: Function

      Function called when animation is over

    Returns this

stop

  • stop(arg?: boolean): this
  • Stop animation

    Parameters

    • Optional arg: boolean

      Sent to functend so that it knows the stop can be forced and is not due to the end of the animation

    Returns this

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc