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

NameDescription
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
IsAnimatingThe animation is currently being executed
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe 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

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT)
EndedThe animation has complete
Cancelled
StartingThe animation is about to start

Methods

NameDescription
CancelStop animating and return to the start of the animation
StartStart the animation
StopStop animating and go to the end of the animation

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2