mglib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

vis/animation/animators/

mggranimator__define.pro


Base animator.

Class description for mggranimator

Subclasses: mggrparallelanimator mggrrotateanimator mggrscaleanimator mggrsequenceanimator mggrtransformanimator mggrtranslateanimator

Properties

Properties in mggranimator

duration get set init

the duration of the animator in seconds; defaults to 1.0 second

easing get set init

easing object to use for transitions; defaults to a linear easing

nframes get set init

the number of frames produces by the animator; defaults to 100 frames

target get set init

target object of the animator

Routines

Routines from mggranimator__define.pro

mggranimator::animate, progress

Do one frame of animation.

mggranimator::reset

Reset the animator.

mggranimator::getProperty, target=target, duration=duration, nframes=nframes, easing=easing

Get properties.

mggranimator::setProperty, target=target, duration=duration, nframes=nframes, easing=easing

Set properties.

mggranimator::cleanup

Free resources.

result = mggranimator::init(target=target, duration=duration, nframes=nframes, easing=easing)

Create an animator.

mggranimator__define

Define instance variables.

Routine details

top mggranimator::animate

mggranimator::animate, progress

Do one frame of animation. MGgrAnimator has a null animation.

Parameters

progress in required type=float

progress from 0.0 to 1.0

top mggranimator::reset

mggranimator::reset

Reset the animator.

top mggranimator::getProperty

mggranimator::getProperty, target=target, duration=duration, nframes=nframes, easing=easing

Get properties.

Keywords

target

target object of the animator

duration

the duration of the animator in seconds; defaults to 1.0 second

nframes

the number of frames produces by the animator; defaults to 100 frames

easing

easing object to use for transitions; defaults to a linear easing

top mggranimator::setProperty

mggranimator::setProperty, target=target, duration=duration, nframes=nframes, easing=easing

Set properties.

Keywords

target

target object of the animator

duration

the duration of the animator in seconds; defaults to 1.0 second

nframes

the number of frames produces by the animator; defaults to 100 frames

easing

easing object to use for transitions; defaults to a linear easing

top mggranimator::cleanup

mggranimator::cleanup

Free resources.

top mggranimator::init

result = mggranimator::init(target=target, duration=duration, nframes=nframes, easing=easing)

Create an animator.

Return value

1 for success, 0 for failure

Keywords

target

target object of the animator

duration

the duration of the animator in seconds; defaults to 1.0 second

nframes

the number of frames produces by the animator; defaults to 100 frames

easing

easing object to use for transitions; defaults to a linear easing

top mggranimator__define

mggranimator__define

Define instance variables.

File attributes

Modification date: Wed May 14 15:07:14 2014
Lines: 51
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.