×
Namespaces

Variants
Actions
(Difference between revisions)

Implementing custom orientation changes animation with QML

From Nokia Developer Wiki
Jump to: navigation, search
hamishwillee (Talk | contribs)
m (Hamishwillee - Addition to article of: Category:MeeGo Category:Symbian. (Add platform categories))
hamishwillee (Talk | contribs)
m (Hamishwillee - Bot update - Fix Article Metadata and other minor issues)
Line 11: Line 11:
 
This text was taken from Comment by [[User:Korva|Korva]] 13:02, 29 September 2011 (EEST)
 
This text was taken from Comment by [[User:Korva|Korva]] 13:02, 29 September 2011 (EEST)
 
}}
 
}}
{{ArticleMetaData
+
{{ArticleMetaData <!-- v1.2 -->
|id=
+
|sourcecode= [[Media:ImplementingOrientationChangeAnimationWithQMLSources.zip]]  
|platform=Maemo, Symbian
+
|devices=Nokia E7, Nokia N8, Nokia N900
+
|creationdate=17 November 2010
+
|keywords=QML, Orientation, Qt Mobility
+
|sourcecode= <!-- Link to example source code (e.g. [[Media:The Code Example ZIP.zip]]) -->
+
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
|sdk=<!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
+
|devices= Nokia E7, Nokia N8, Nokia N900
|devicecompatability=<!-- Compatible devices (e.g.: All* (must have GPS) ) -->
+
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
|signing=<!-- Empty or one of Self-Signed, DevCert, Manufacturer -->
+
|platform= Maemo, Symbian
|capabilities=<!-- Capabilities required (e.g. Location, NetworkServices.) -->
+
|devicecompatability= <!-- Compatible devices (e.g.: All* (must have GPS) ) -->
|author=[[User:Kratsan]]
+
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
 +
|signing= <!-- Empty or one of Self-Signed, DevCert, Manufacturer -->
 +
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 +
|keywords= QML, Orientation, Qt Mobility
 +
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 +
|translated-by= <!-- [[User:XXXX]] -->
 +
|translated-from-title= <!-- Title only -->
 +
|translated-from-id= <!-- Id of translated revision -->
 +
|review-by= <!-- After re-review: [[User:username]] -->
 +
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 +
|update-by= <!-- After significant update: [[User:username]]-->
 +
|update-timestamp= <!-- After significant update: YYYYMMDD -->
 +
|creationdate= 20101117
 +
|author= [[User:Kratsan]]
 
}}
 
}}
  
Line 85: Line 93:
  
 
==main.cpp==
 
==main.cpp==
The <tt>main.cpp</tt> creates the [http://doc.qt.nokia.com/qtmobility-1.2/qorientationsensor.html QOrientationSensor] and the self-implemented [http://doc.qt.nokia.com/qtmobility-1.2/qorientationfilter.html OrientationFilter]  which will signal the changes of the orientation. This signal is connected to the QML documents root elements function <tt>orientationChanged</tt>. The root element is retrieved by using code {{Icode|view.rootObject()}}.
+
The {{Icode|main.cpp}} creates the [http://doc.qt.nokia.com/qtmobility-1.2/qorientationsensor.html QOrientationSensor] and the self-implemented [http://doc.qt.nokia.com/qtmobility-1.2/qorientationfilter.html OrientationFilter]  which will signal the changes of the orientation. This signal is connected to the QML documents root elements function {{Icode|orientationChanged}}. The root element is retrieved by using code {{Icode|view.rootObject()}}.
  
 
The width and height of the root element are set to be resized to {{Icode|QDeclarativeViews}} sizes with the code {{Icode|view.setResizeMode(QDeclarativeView::SizeRootObjectToView).}}
 
The width and height of the root element are set to be resized to {{Icode|QDeclarativeViews}} sizes with the code {{Icode|view.setResizeMode(QDeclarativeView::SizeRootObjectToView).}}
Line 168: Line 176:
  
 
==Orientation.qml==
 
==Orientation.qml==
The UI holds six <tt>Text</tt> elements inside a <tt>Column</tt> representing orientations of the device. Current orientation text will be shown as bold and white color as the others are shown in black without bold. The view will be rotated to the current orientation by altering the <tt>rotation</tt> property of the <tt>view</tt>. Also the <tt>width</tt> and <tt>height</tt> of the <tt>view</tt> are updated to match the corresponding orientation.
+
The UI holds six {{Icode|Text}} elements inside a {{Icode|Column}} representing orientations of the device. Current orientation text will be shown as bold and white color as the others are shown in black without bold. The view will be rotated to the current orientation by altering the {{Icode|rotation}} property of the {{Icode|view}}. Also the {{Icode|width}} and {{Icode|height}} of the {{Icode|view}} are updated to match the corresponding orientation.
  
 
<code>
 
<code>

Revision as of 03:31, 23 February 2012

Tip.pngTip: This entry has been proposed as a candidate Knowledge Base Developer Contributed article.

Needs-update.pngThis article needs to be updated: If you found this article useful, please fix the problems below then delete the {{ArticleNeedsUpdate}} template from the article to remove this warning.

Reasons: hamishwillee (05 Oct 2011)
This article pre-dates Qt Quick Components and should be re-written. Note that some of the information in this topic may still be useful.

The right way to do this is to use the Window component from the new Qt Quick Components. If you use Window as the parent element, you can query the inPortrait property to get the orientation. It handles the E7 keyboard open -scenario correctly.

Documentation: http://doc.qt.nokia.com/qt-components-symbian-1.0/qml-window.html Taking Qt Quick components into use: http://doc.qt.nokia.com/qt-components-symbian-1.0/index.html

This text was taken from Comment by korva 13:02, 29 September 2011 (EEST)

Article Metadata
Code ExampleTested with
Devices(s): Nokia E7, Nokia N8, Nokia N900
Compatibility
Platform(s): Maemo, Symbian
Symbian
Article
Keywords: QML, Orientation, Qt Mobility
Created: kratsan (17 Nov 2010)
Last edited: hamishwillee (23 Feb 2012)

Contents

Overview

This snippet shows how to implement nice custom orientation change animation with QML.

There are two ways to detect the orientation of the device:

  • by observing the width and height of the main window and seeing which one is the greatest (works if the orientation is not locked) or
  • by using the device's sensors to detect the orientation

In this snippet we use the latter technique and utilize Qt Mobility QOrientationSensor to access the accelerometer data of the device.

To prevent devices built-in orientation change to occur we lock the orientation to portrait mode and simulate the orientation change in QML code. This concerns only Symbian devices as in Maemo the orientation is already locked to the landscape mode. The orientation data is provided to QML code via Qt Signals and Slots.

Pros and cons of this approach:

+ Nice animation to the orientation change
+ No black screen during the orientation change
- Custom implementation is required to switch to landscape orientation when HW-keyboard is used
- Additional (though user-grantable) capability ReadDeviceData is required to allow reading of sensors on Symbian
- Qt Mobility libraries are required to detect the orientation

Note.pngNote: This snippet is valid for Symbian^3 and Symbian Anna. In Symbian Belle there will be a nice orientation change animation working out-of-the-box.

Note.pngNote: This snippet is likely to be deprecated when the Qt Mobility 1.1 will be available in Nokia Qt SDK. The orientation information can then be accessed directly via appropriate QML elements and the Qt code in this snippet will not be required, although it should still be valid code.

Download the sources of this snippet here.

Preconditions

  • Qt 4.7 or higher is installed on your platform
  • QtMobility 1.0.2 or higher is installed on your platform

orientation.pro

The declarative module is used, as well as the Qt Mobility sensors. QML code will be placed inside Qt resource system for easier deployment to the devices.

QT          += core gui declarative
 
TARGET = orientation
TEMPLATE = app
 
SOURCES += main.cpp
HEADERS += orientationfilter.h
OTHER_FILES += Orientation.qml
RESOURCES = resources.qrc
 
CONFIG += mobility
MOBILITY += sensors
 
symbian {
# To lock the application to landscape orientation
LIBS += -lcone -leikcore -lavkon
}
 
unix:!symbian {
maemo5 {
target.path = /opt/usr/bin
} else {
target.path = /usr/local/bin
}
INSTALLS += target
}

main.cpp

The main.cpp creates the QOrientationSensor and the self-implemented OrientationFilter which will signal the changes of the orientation. This signal is connected to the QML documents root elements function orientationChanged. The root element is retrieved by using code view.rootObject().

The width and height of the root element are set to be resized to QDeclarativeViews sizes with the code view.setResizeMode(QDeclarativeView::SizeRootObjectToView).

#include <QApplication>
#include <QDeclarativeView>
#include <QGraphicsObject>
#include <QDesktopWidget>
#include <QOrientationSensor>
#include "orientationfilter.h"
 
QTM_USE_NAMESPACE
 
#ifdef Q_OS_SYMBIAN
// Lock orientation in Symbian
#include <eikenv.h>
#include <eikappui.h>
#include <aknenv.h>
#include <aknappui.h>
#endif
 
int main(int argc, char *argv[])
{
QApplication app(argc, argv);
 
#ifdef Q_OS_SYMBIAN
// Lock orientation in Symbian
CAknAppUi* appUi = dynamic_cast<CAknAppUi*> (CEikonEnv::Static()->AppUi());
TRAP_IGNORE( if(appUi) { appUi->SetOrientationL(CAknAppUi::EAppUiOrientationPortrait); } );
#endif
 
QDeclarativeView view;
view.setSource(QUrl("qrc:/Orientation.qml"));
view.setResizeMode(QDeclarativeView::SizeRootObjectToView);
 
QOrientationSensor sensor;
OrientationFilter filter;
sensor.addFilter(&filter);
 
// Connect the Qt signal to QML function
QObject::connect(&filter, SIGNAL(orientationChanged(const QVariant&)), view.rootObject(), SLOT(orientationChanged(const QVariant&)));
 
sensor.start();
 
// Show application in full screen on all platforms with corresponding device resolution
view.setGeometry(QApplication::desktop()->screenGeometry());
view.showFullScreen();
 
return app.exec();
}

orientationfilter.h

The self-implemented OrientationFilter] is derived from QObject to get the possibility to emit signals and from QOrientationFilter to read the values of the sensor. The sensor reading is placed to QVariant so that the value can be passed to JavaScript function in QML code.

#ifndef ORIENTATIONFILTER_H
#define ORIENTATIONFILTER_H
 
#include <QOrientationFilter>
 
QTM_USE_NAMESPACE
 
class OrientationFilter : public QObject, public QOrientationFilter
{
Q_OBJECT
public:
bool filter(QOrientationReading *reading) {
emit orientationChanged(reading->orientation());
 
// don't store the reading in the sensor
return false;
}
 
signals:
void orientationChanged(const QVariant &orientation);
};
 
#endif // ORIENTATIONFILTER_H

Orientation.qml

The UI holds six Text elements inside a Column representing orientations of the device. Current orientation text will be shown as bold and white color as the others are shown in black without bold. The view will be rotated to the current orientation by altering the rotation property of the view. Also the width and height of the view are updated to match the corresponding orientation.

import Qt 4.7
 
Item {
id: base
 
function orientationChanged(orientation) {
highlightindex(orientation)
 
if(orientation == 1) {
view.rotation = 0
view.width = base.width; view.height = base.height
}
else if(orientation == 2) {
view.rotation = 180
view.width = base.width; view.height = base.height
}
else if(orientation == 3) {
view.rotation = 270
view.width = base.height; view.height = base.width
}
else if(orientation == 4) {
view.rotation = 90
view.width = base.height; view.height = base.width
}
}
 
function highlightindex(orientation) {
var count = texts.children.length
 
for(var i=0; i<count; i++) {
if(i == (orientation - 1)) {
texts.children[i].color = "white"
texts.children[i].font.bold = true
}
else {
texts.children[i].color = "black"
texts.children[i].font.bold = false
}
}
}
 
Rectangle {
id: view
 
Behavior on rotation { RotationAnimation { direction: RotationAnimation.Shortest; duration: 500; easing.type: Easing.OutBounce } }
Behavior on width { NumberAnimation { duration: 500 } }
Behavior on height { NumberAnimation { duration: 500 } }
 
anchors.centerIn: parent
width: base.width; height: base.height
color: "blue"
 
Column {
id: texts
 
anchors.centerIn: parent
spacing: 10
 
Text { text: "Top up" }
Text { text: "Top Down" }
Text { text: "Left Up" }
Text { text: "Right Up" }
Text { text: "Face Up" }
Text { text: "Face Down" }
}
}
}

Postconditions

The snippet demonstrated the implementing of nice animation to orientation change with QML language. The orientation data was provided by Qt Mobilitys QRotationSensor class. The retrieved data was transferred via Qt Signals and Slots to QML code where the current orientation was nicely visualized.

329 page views in the last 30 days.
×