TexturePackerAnimatedSpriteVPlay

The TexturePackerAnimatedSpriteVPlay component shows a single static sprite or an animated sprite like the AnimatedSpriteVPlay. It has an increased performance thanks to its support for sprite sheets created with TexturePacker. More...

Import Statement: import VPlay 2.0
Inherits:

Item

Inherited By:

TexturePackerSpriteVPlay

Properties

Methods

Detailed Description

The TexturePackerAnimatedSpriteVPlay component shows a sprite animation like the AnimatedSprite. It supports sprite sheets created with TexturePacker. The TexturePackerAnimatedSpriteVPlay can access single sprites in the sprite sheet through their names given in the JSON file. It also has an improved performance compared to the AnimatedSprite and AnimatedSpriteVPlay components.

Read the guide How to use TexturePacker with V-Play to know why sprite sheets reduce the memory consumption and improve the performance of your game.

Example Usage

The TexturePackerAnimatedSpriteVPlay components makes it trivial to load sprite sheets. You just need to provide the path (including the filename) of the JSON file and set the frame names. Note that the sprite sheet must be placed in the same directory as the json file. The following is an example for a sprite animation counting from 5 to 15 in steps of 5:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: ["5.png", "10.png", "15.png"]
         }
     }
 }

To show a single image of the sprite sheet just choose a single frame without the array definition:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: "10.png"
         }
     }
 }

This component supports content scaling to pick the best image quality for your screen density.

Property Documentation

currentFrame : int

When paused, the current frame can be changed manually by setting this property or calling advance().


fillMode : enumeration

Set this property to define what happens when the source image has a different size than the item. Currently, only the options Stretch (default) and PreserveAspectFit are supported. Stretch always stretches the content of the sprite to the given size. Therefore, the width to height ratio may change. PreserveAspectFit stretches the image to the maximal possible size while keeping the aspect ratio. See Image::fillMode for more details.

For example, if the frame is originally 200x100px and the sprite's width is set to 100px it shows the frame in 100x50px with fillMode set to PreserveAspectFit:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: ["5.png", "10.png", "15.png"]
             width: 100
             fillMode: Image.PreserveAspectFit
         }
     }
 }

frameNames : var

This is a list of strings containing the image names in the packed sprite sheet. Note there is no path needed here, because this property has no URLs. Instead, it has string keys, which are used to find the frame's information in the JSON file. By default this property is empty, so you need to set it.

Here is an example how to use it:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: ["5.png", "10.png", "15.png"]
         }
     }
 }

To show a single image of the sprite sheet just choose a single frame without the array definition:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: "10.png"
         }
     }
 }

If you show a single image, setting the animation properties like frameRate or loops has no effect.


frameRate : real

The number of frames shown per second. Values equal to 0 or below are invalid. The duration a frame is shown is 1 / frameRate.


interpolate : bool

If true, interpolation will occur between sprite frames to make the animation appear smoother. Note that there is a visual jump if you change reverse while interpolation is used.

Note: Interpolation currently does not work if you rotated the image in the TexturePacker file. Please send us a support request if you need this feature.

Default is false.


loops : int

The number of loops the animation should run. Zero stops the animation immediately. Set to TexturePackerSprite.Infinite to let the animation run forever.

Default is TexturePackerSprite.Infinite


mirror : bool

This property holds whether the image should be horizontally mirrored.

The default value is false.


mirrorY : bool

This property holds whether the image should be vertically mirrored.

Note: Mirroring on the vertical 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 : bool

When the animation is paused, you can advance the current frame manually either by setting currentFrame or calling advance().

Default is false.


reverse : bool

If this property is true, the animation will be played in reverse. Note that there is a visual jump if you change the reverse property while interpolate is enabled.

Default is false.


running : bool

Whether the sprite is animating or not. If it is not running the current frame does not change, not even if set directly.

Default is true.


smooth : bool

This property holds whether the image is smoothly filtered when scaled or transformed. Smooth filtering gives better visual quality, but it may be slower on some hardware. The low-level basis is texture filtering. False means that the sprite uses nearest neighbor filtering and true stands for linear interpolation.

Default is true.


source : url

This is the URL to the JSON file of the packed sprite sheet. Note that the sprite sheet image must be in the same directory as the JSON file. By default this property is empty, so you need to set it.

Here is an example how to use it:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
     Scene {
         TexturePackerAnimatedSpriteVPlay {
             source: "../assets/img/squaby.json"
             frameNames: ["5.png", "10.png", "15.png"]
         }
     }
 }

Method Documentation

void advance()

Advances the sprite animation by one frame if paused is true.


void pause()

Pauses the sprite animation. This does nothing if paused is true.


void restart()

Stops, then starts the sprite animation.


void resume()

Resumes the sprite animation if paused is true; otherwise, this does nothing.


Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support
Sign up for Free and start developing right away!
I want to make Games
I want to make Apps
Game Development
Cross-Platform, Any Resolution

Use one IDE to deploy to all supported platforms, including iOS and Android, from a single code base.

Support all screen resolutions, aspect ratios and sizes with auto-adapting UI elements, smart scene scaling and memory efficient asset selection.

Learn More

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Multiplayer

V-Play Multiplayer supports both real-time and turn-based gameplay, so you can use it to make many different types of cross-platform multiplayer games. It's perfect for making player-vs-player games like 'Words with Friends' or games for a large amount of players, such as 'Clash of Clans'.

Learn More Video

Highscores & Achievements

The V-Play Game Network is a cross-platform gaming service that allows players around the world to compare game highscores and achievements. Players can also challenge each other across multiple platforms and share their progress on Facebook.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code.

import QtQuick 2.0
import VPlay 2.0

GameWindow {
  Scene {
    
    SimpleButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Level Editor

The LevelEditor can be used during development to create and modify levels for your game, which you can then bundle in your final publishing build. Additionally, you can also integrate the in-game level editor to your published game and let your gamers create new levels.

Learn More Video

Card Game like UNO, Hearthstone or Poker

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/OneCard/OneCard.pro

Match-3 like Candy Crush Saga

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquash/JuicySquash.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquashAdvanced/JuicySquashAdvanced.pro

Puzzle like 2048 or Threes!

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/2048/2048.pro

Casino like Big Win Slots

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlaskOfRum/FlaskOfRum.pro

Side Scroller like Jetpack Joyride or Flappy Bird

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlappyBird/FlappyBird.pro

Tower Defense like Castle Defense or Bloons TD

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Squaby/Squaby.pro

Falldown & Jump like Doodle Jump or Mega Jump

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak/ChickenOutbreak.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak2/ChickenOutbreak2.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/DoodleJump/DoodleJump.pro

Platformer like Super Mario or Lep's World

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Platformer/Platformer.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Action like Angry Birds, Fruit Ninja, Cut the Rope

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/BalloonPop/BalloonPop.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/CarChallenge/CarChallenge.pro

Arcade like Arkanoid or Space Invaders

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ZombieBreak/ZombieBreak.pro

Community like Super Mario Maker or Minecraft

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/examples/Squaby/Squaby.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Any other Idea? let us know how we can help you

You are looking for another demo?

The V-Play SDK includes many open-source demos for different game genres. You can use their source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

If you do not find your game genre in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us

App Development
Better Apps, Less Effort

Develop feature-rich, cross-platform mobile apps from a single code base.

V-Play apps look, feel and perform exactly like native iOS, Android and Desktop apps. With less code & much faster development time.

Learn More Highlights Video

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Save Time, Code & Money

Save up to 90% source code with V-Play, compared to frameworks like Xamarin, Titanium, React Native and others.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code. QML also allows you to easily create smooth and complex animations.

import QtQuick 2.0
import VPlayApps 2.0

App {
  Page {
    
    AppButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Native Sensors & More

V-Play Apps harness the power of Qt, the leading cross-platform development framework used by over 1,000,000 developers.

This gives your access to native device features like sensors, camera, file system as well as multimedia, networking, localization and much more.

Learn More

Responsive Design

V-Play has built in responsive design capabilities, you can target phones and tablets with the same source code.

Learn More

Highly Extensible

You have existing JavaScript, C++ or native code? You want to add any 3rd party SDK that we do not offer already?

No worries, you can add any JS, C++, Java or Objective-C code to your project.

Learn More

Component Showcase App shows the most important V-Play features and components

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/showcase/Showcase.pro

Qt World Summit Conference App a full-featured conference management app made by V-Play

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/qtws2016/QtWS2016.pro

Twitter App how to build layouts like in the official Twitter app for iOS and Android

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/twitter/Twitter.pro

Maps App displays free bikes or boxes at bike stations for Vienna's bike sharing service Citybike Wien

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/maps/Maps.pro

Messaging App demonstrates how to create the UI of a Facebook Messenger like app

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/messaging/Messaging.pro

Weather App how to include powerful animations into your user interface

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/waether/Weather.pro

Any other Idea? let us know how we can help you

You are looking for another app demo?

The V-Play SDK includes many open-source demos for different app types. You can use their source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play..

If you do not find your app type in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us