Wikitude SDK API Reference

API Docs for: 9.13.0
Show:

Animation Class

Extends ARchitectObject
Module: AR

Animations allow constant changes to numeric values/properties of an object.

Animations can be seen as functions defining the progress of the change on the value.

It is an abstract class that must not be instantiated directly.

Item Index

Methods

Properties

Events

Methods

destroy

()

Inherited from ARchitectObject

Destroys the object.

isRunning

() Boolean

Checks if the Animation is currently running.

Returns:

Boolean:

true if the Animation is currently running, false if the Animation is currently not running.

pause

()

Pauses the Animation.
If the PropertyAnimation is currently not running, the call will have no effect.

resume

()

Resumes the Animation.
If the PropertyAnimation is currently running, the call has no effect. Otherwise, it will either be resumed from the position where it was last paused, or will start from the beginning if it was not paused.

start

(
  • loopTimes
)

Immediately starts the Animation.

Parameters:

  • loopTimes (defaults to 1) Number optional

    Defines how often the animation should be played. A negative value indicates an infinite looping. Must be a whole number.

stop

()

Immediately stops the Animation. Allows manual stopping of the Animation before the animation would automatically stop. The onFinish-trigger will not be fired after a manual stopping.

Properties

destroyed

Boolean

Inherited from ARchitectObject

Indicates if the object has already been destroyed.

Events

onFinish

The trigger will fire when the Animation finishes.

The trigger is null by default, and will thus result in no action executed when the trigger fires. A developer can add custom functionality by assigning a custom function to onFinish.

onStart

The trigger will fire right before the Animation starts.

The trigger is null by default, and will thus result in no action executed when the trigger fires. A developer can add custom functionality by assigning a custom function to onStart.