Learn what Felgo offers to help your business succeed. Start your free evaluation today! Felgo for Your Business

AnimatedSprite

Plays a single sprite animation stored as a series of frames. More...

Import Statement: import Felgo 3.0
Inherits:

Item

Properties

Methods

Detailed Description

AnimatedSprite provides rendering and control over animations which are provided as multiple frames in the same image file. You can play it at a fixed speed, at the frame rate of your display, or manually advance and control the progress.

For full Qt 5 documentation see AnimatedSprite and the Sprite Animations overview. Note that the AnimatedSprite type does not use Sprite types to define multiple animations, but instead encapsulates a single animation itself.

Note: For sprites with improved performance use TexturePackerAnimatedSprite instead.

Felgo Additions to AnimatedSprite

AnimatedSprite enhances the Qt 5 component AnimatedSprite with Content Scaling and Dynamic Image Switching Support & Density Independence.

Specifically, it allows you to:

  • Use the ideal image for memory and loading times based on the Felgo File Selectors.
  • Always has the same logical size for easy positioning in a Scene. This approach is also called Content Scaling.
  • Set the initial frameX or frameY with startFrameColumn or startFrameRow for simpler definitions.
  • The interpolate property is set to false by default, because at sprite animations interpolations usually looks blurry and should be deactivated by default.
  • Set the mirrorX and or mirrorY property.
  • The width & height properties are set automatically to frameWidth and frameHeight, respectively. If you explicitly define a width or height, the AnimatedSprite will be scaled to this size as it is done in AnimatedSprite. Thus existing Qt 5 AnimatedSprite code will work for AnimatedSprite, but the added convenience of AnimatedSprite cannot be applied back to normal AnimatedSprite components.

See the Felgo Script for Multi-Resolution Asset Generation how to create sprite sheets from single sprite frames and scale them down automatically.

Property Documentation

currentFrame : alias

See AnimatedSprite::currentFrame.


frameCount : alias

See AnimatedSprite::frameCount.


frameDuration : alias

See AnimatedSprite::frameDuration.


frameHeight : int

See AnimatedSprite::frameHeight.


frameRate : alias

See AnimatedSprite::frameRate.


frameSync : alias

See AnimatedSprite::frameSync.


frameWidth : int

See AnimatedSprite::frameWidth.


frameX : int

See AnimatedSprite::frameX.


frameY : int

See AnimatedSprite::frameY.


interpolate : alias

See AnimatedSprite::interpolate.


loops : alias

See AnimatedSprite::loops.


mirrorX : bool

This property holds whether the image should be horizontally mirrored.

Note: Mirroring on the horizontal axis is internally achieved by setting the Item::transform property. Thus if you set the transform property explicitly, you need to apply the y-scaling manually.

The default value is false.


mirrorY : bool

This property holds whether the image should be vertically mirrored.

Note: Mirroring on the verical axis is internally achieved by setting the Item::transform property. Thus if you set the transform property explicitly, you need to apply the y-scaling manually.

The default value is false.


paused : alias

See AnimatedSprite::paused.


reverse : alias

See AnimatedSprite::reverse.


running : alias

See AnimatedSprite::running.


source : alias

See AnimatedSprite::source.


startFrameColumn : int

An alternative to defining frameX, the left position of the first frame in the Sprite animation. If set, the frameX property is automatically calculated based on the column number by multiplying it with the frameWidth.

Note: The first colum (so the left-most frame) starts with column 1, not 0. The default value is 1.


startFrameRow : int

An alternative to defining frameY, the top position of the first frame in the Sprite animation. If set, the frameY property is automatically calculated based on the row number by multiplying it with the frameHeight.

Note: The first row (so the top-most frame) starts with row 1, not 0. The default value is 1.


Method Documentation

advance()

See AnimatedSprite::advance().


pause()

See AnimatedSprite::pause().


restart()

See AnimatedSprite::restart().


resume()

See AnimatedSprite::resume().


Qt_Technology_Partner_RGB_475 Qt_Service_Partner_RGB_475_padded