• Home
• Felgo
• GameAnimatedSprite

GameAnimatedSprite

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

• List of all members, including inherited members

Properties

• currentFrame : alias
• frameCount : alias
• frameDuration : alias
• frameHeight : int
• frameRate : alias
• frameSync : alias
• frameWidth : int
• frameX : int
• frameY : int
• interpolate : alias
• loops : alias
• mirrorX : bool
• mirrorY : bool
• paused : alias
• reverse : alias
• running : alias
• source : alias
• startFrameColumn : int
• startFrameRow : int

Methods

• advance()
• pause()
• restart()
• resume()

Detailed Description

GameAnimatedSprite 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 documentation see AnimatedSprite and the Sprite Animations overview. Note that the GameAnimatedSprite type does not use Sprite types to define multiple animations, but instead encapsulates a single animation itself.

Felgo Additions to AnimatedSprite

GameAnimatedSprite enhances the Qt 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 GameAnimatedSprite will be scaled to this size as it is done in GameAnimatedSprite. Thus existing Qt 5 GameAnimatedSprite code will work for GameAnimatedSprite, but the added convenience of GameAnimatedSprite cannot be applied back to normal GameAnimatedSprite 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

Method Documentation