aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/tutorials/qmladvancedtutorial/samegame1.rst
blob: f48c0672b1473ef3f870a9cf21c284496ed636e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
.. _samegame1:

QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks
*************************************************************

Creating the application screen
===============================

The first step is to create the basic QML items in your application.

To begin with, create a main screen like this:

.. figure:: declarative-adv-tutorial1.png
    :align: center

This is defined by the main application file, ``samegame.qml``, which looks like this:

.. pysideinclude:: samegame/samegame1/samegame.qml
    :snippet: 0

It gives a basic game window that includes the main canvas for the
blocks, a "New Game" button, and a score display.

One item you may not recognize here is the SystemPalette item. This provides
access to the Qt system palette and is used to give the button a more native
look-and-feel.

Notice the anchors for the ``Item``, ``Button``, and ``Text`` items are set using
group notation for readability.

Adding button and block components
==================================

The ``Button`` item in the code above is defined in a separate component file named ``Button.qml``.
To create a functional button, use the Text and MouseArea QML types inside a Rectangle.
Here is the ``Button.qml`` code:

.. pysideinclude:: samegame/samegame1/Button.qml
    :snippet: 0

This essentially defines a rectangle that contains text and can be clicked. The MouseArea
has an ``onClicked()`` handler that is implemented to emit the ``clicked()`` signal of the
``container`` when the area is clicked.

In Same Game, the screen is filled with small blocks when the game begins.
Each block is an item that contains an image. The block
is defined in the ``Block.qml`` file:

.. pysideinclude:: samegame/samegame1/Block.qml
    :snippet: 0

At the moment, the block doesn't do anything; it is just an image. As the
tutorial progresses, you will animate and give behaviors to the blocks.
You have not added any code yet to create the blocks; this
will be done in the next chapter.

You have set the image to be the size of its parent Item using ``anchors.fill: parent``.
This means that when you dynamically create and resize the block items
later on in the tutorial, the image will be scaled automatically to the
correct size.

Notice the relative path for the Image item's ``source`` property.
It is relative to the location of the file that contains the Image item.
Alternatively, you could set the Image source to an absolute file path or a URL
that contains an image.

You should be familiar with the code so far, as you have created some basic
items to get started. In the next chapter, you will populate the game canvas
with some blocks.

[Previous :ref:`qmladvancedtutorial`] [Next :ref:`samegame2`]