TwoAxisController

Input controller with keyboard support for moving entities. More...

Import Statement: import VPlay 2.0

Properties

Signals

Methods

Detailed Description

This component can be used for moving entities. It has 2 important properties: xAxis and yAxis. xAxis specifies the normalized output between -1 and +1 on the horizontal axis of a virtual TwoAxisController, the same for the yAxis axis.

You can inject input to a TwoAxisController from keyboard presses by mapping the inputs property to output actions. E.g. a Qt.Key_Left should match the "up" action, which sets the yAxis value to true. Use Keys.forwardTo: twoAxisController to forward key presses of an item which has the focus to the controller. This item will usually be the Scene.

You can also connect the xAxis and yAxis properties with other components like MoveToPointHelper, JoystickControllerHUD, Accelerometer. See the Advanced Usage section for more details.

Example Usage

 GameWindow {
   Scene {
       focus: true
       Keys.forwardTo: controller

       EntityBase {
           id:player
           TwoAxisController {
               id: controller
           }
       }
   }
 }

If you have multiple players, the following is possible:

 GameWindow {
   Scene {
       focus: true
       Keys.forwardTo: [controller1, controller2]

       EntityBase {
           id:player1
           TwoAxisController {
               id: controller1
           }
       }

       EntityBase {
           id:player2
           TwoAxisController {
               id: controller2
               inputActionsToKeyCode: {
                   "up": Qt.Key_W,
                   "down": Qt.Key_S,
                   "left": Qt.Key_A,
                   "right": Qt.Key_D,
                   "fire": Qt.Key_Space
               }
           }
       }
   }
 }

This will use the Left, Right, Up, and Down keys to set the xAxis and yAxis value for player 1, and WASD for player2. When the Enter or Space key is pressed, the inputActionPressed signal will be emitted in TwoAxisController, which can be handled with inputActionPressed.

You can then connect the xAxis and yAxis properties to movement components like MovementAnimation or the force and torque properties of BoxCollider.

This is an example of connecting the TwoAxisController with a BoxCollider:

 GameWindow {
   Scene {
     focus: true
     Keys.forwardTo: twoAxisController

     EntityBase {

       TwoAxisController {
           id: twoAxisController

           onInputActionPressed: {
             if(actionName == "fire") {
               // do something in here, e.g. create a new entity
             }
           }

       }

       BoxCollider {
           width: 60; height: 40

           force: Qt.point(twoAxisController.yAxis*8000, 0)
           torque: twoAxisController.xAxis*2000
       }
     }
   }
 }

Advanced Usage

The yAxis and xAxis property can also be set externally. This may be useful, when the same entity should be controlled by the AI. In that use-case, you can connect the xAxis and yAxis properites of TwoAxisController with MoveToPointHelper::outputXAxis and MoveToPointHelper::outputYAxis.

The TwoAxisController can also be connected to a JoystickControllerHUD. That has the advantage, that the game logic stays the same when playing on the desktop with a keyboard, as with a virtual thumbstick on mobile devices. This is an example of such a connection:

 GameWindow {

   JoystickControllerHUD {
     width: 50; height: 50

     source: "../assets/img/joystick_background.png"
     thumbSource: "../assets/img/joystick_thumb.png"

     // whenever the thumb position changes, update the twoAxisController
     onControllerXPositionChanged: twoAxisController.xAxis = controllerXPosition
     onControllerYPositionChanged: twoAxisController.yAxis = controllerYPosition
   }

   Scene {
     focus: true
     Keys.forwardTo: twoAxisController

     EntityBase {

       TwoAxisController {
           id: twoAxisController

           onInputActionPressed: {
             if(actionName == "fire") {
               // do something in here, e.g. create a new entity
             }
           }

       }

       BoxCollider {
           width: 60; height: 40

           force: Qt.point(twoAxisController.yAxis*8000, 0)
           torque: twoAxisController.xAxis*2000
       }
     }
   }
 }

Property Documentation

inputActionsToKeyCode : variant

This property contains the mapping between the pressed or released key code and the inputAction which should be emitted with inputActionPressed().

By default, it has the following value:

 {
   "up": Qt.Key_Up,
   "down": Qt.Key_Down,
   "left": Qt.Key_Left,
   "right": Qt.Key_Right,
   "fire": Qt.Key_Return
 }

Usually, you can just leave these default actions. If you want more input actions that can then be queried with your game logic, you can overwrite this variant map with something like the following:

 {
   "up": Qt.Key_Up,
   "down": Qt.Key_Down,
   "left": Qt.Key_Left,
   "right": Qt.Key_Right,
   "fire": Qt.Key_Return
   "changeToWeapon1": Qt.Key_1
   "changeToWeapon2": Qt.Key_2
   "reload": Qt.Key_R
   ...
 }

So this property allows you to set keyboard shortcuts for your game action. When you create a game for desktop and mobile, you will want to abstract your game actions in such a way, because the same game code should be called regardless if you press the fire button or press the fire key on the keyboard.


xAxis : real

This property holds the x axis value of a 2-axis controller which can be connected to a rotation input property of supported components. When it is 0, that is equal to no required rotation, similar to no key being pressed on the keyboard. When it is +1, a clockwise rotation should be performed similar to a right key press. When it is -1, a counterclockwise rotation should be performed similar to a left key press.

When this property is set from keyboard presses, outputXAxis will not take values in between -1 and 0 or 0 and +1 because there is no analog value in between - either the button is pressed or it is not.

This property should be connected with a movement component like BoxCollider, CircleCollider or MovementAnimation. This example shows how to connect the outputXAxis property with the rotation property of a MovementAnimation:

 GameWindow {
   Scene {
     focus: true
     Keys.forwardTo: twoAxisController

     EntityBase {

       TwoAxisController {
           id: twoAxisController
       }

       MovementAnimation {
         target: parent
         property: "rotation"

         // outputXAxis is +1 if target is to the right, -1 when to the left and 0 when aiming towards it
         velocity: 300*twoAxisController.xAxis
         // alternatively, also the acceleration could be set, depends on how you want the entity to behave

         // start rotating towards the target immediately, when xAxis is +1 or -1
         running: true

       }
     }
   }
 }

yAxis : real

This property holds the axis value of a 2-axis controller which can be connected to the velocity or force input property of supported components. When it is 0, that is equal to no required movement, similar to no key being pressed on the keyboard. When it is +1, a forward movement should be performed similar to an up key press. When it is -1, a backward movement should be performed similar to a down key press.

When this property is set from keyboard presses, outputYAxis will not take values in between -1 and 0 or 0 and +1 because there is no analog value in between - either the button is pressed or it is not.

This property should be connected with a movement component like BoxCollider, CircleCollider or MovementAnimation. This example shows how to connect the outputYAxis property with the force property of a BoxCollider:

 GameWindow {
   Scene {
     focus: true
     Keys.forwardTo: twoAxisController

     EntityBase {

       TwoAxisController {
           id: twoAxisController
       }

       BoxCollider {
         width: 30; height:20

         // move forwards and backwards, with a multiplication factor for the desired speed
         force: Qt.point(twoAxisController.outputYAxis*1000, 0)

         // rotate left and right, optional
         torque: twoAxisController.outputXAxis*300
       }

     }
   }
 }

Signal Documentation

inputActionPressed(string actionName)

This handler is called, when an input action is pressed. This happens either when a key with a matching key code from inputActionsToKeyCode occurs. Or when setInputActionPressedStatus() is called explicitly. The pressed action is available from the argument actionName.


inputActionReleased(string actionName)

This handler is called, when an input action is released. This happens either when a key with a matching key code from inputActionsToKeyCode occurs. Or when setInputActionPressedStatus() is called explicitly. The pressed action is available from the argument actionName.


Method Documentation

isPressed(actionName)

This function returns whether the actionName is currently pressed. This will return true, in between a setInputActionStatus(action, true) and a setInputActionStatus(action, false) call. The default pressed status for an action is false.


setInputActionPressedStatus(actionName, isPressed)

Call this function to manually set the pressed status to isPressed of an input action with actionName.


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