Animation (PRIM_ANIM)

Animation

Ancestors - Object (PRIM_OBJT)

Details

An Animation is used to start and stop the execution and to provide feedback on whether the animation is running. Individual animation items control animation behaviors.
 
Animations do no affect the actual property values of controls until the animation completes. Stopping an animation before the end will cause all controls to revert to their state as it was before the animation started.
 
When an animation starts, the animating controls are not bound by the rules of Layout Managers. However, once it completes, normal layout behaviour will continue.
 
Animations construct a storyboard when the animation starts. This can cause confusion if the values specified for one item depend on another. For example, if an animation is defined to move a control 5 pixels to the right and then 5 to the left, the animation will actually move the control 5 to the right and then 10 to the left and then 5 to the right. This is becuase the first item added 5 to the start point while the second item took 5 away from the start point resulting in a 10 pixel gap.

Example

Simple animation that moves a button to a left position of 300 and then back to a left of 0.
Define_Com Class(#PRIM_ANIM) Name(#Animation)
Define_Com Class(#PRIM_ANIM.MoveTo) Name(#Step1) Left(300) Manage(#Button) Parent(#Animation) Duration(500)
Define_Com Class(#PRIM_ANIM.MoveTo) Name(#Step2) Manage(#Button) Parent(#Animation) Starttime(500) Duration(500)

Properties

Name Description
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
IsAnimating The animation is currently being executed
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT)
Ended The animation has complete
Cancelled
Starting The animation is about to start

Methods

Name Description
Cancel Stop animating and return to the start of the animation
Start Start the animation
Stop Stop animating and go to the end of the animation

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020