Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29 \qmltype FirstPersonCameraController
30 \inqmlmodule Qt3D.Extras
31 \brief The FirstPersonCameraController allows controlling the scene camera
32 from the first person perspective.
33 \since 5.7
34 \inherits Qt3D.Core::Entity
35
36 The FirstPersonCameraController allows controlling the scene camera from the first person
37 perspective.
38
39 The controls are:
40 \table
41 \header
42 \li Input
43 \li Action
44 \row
45 \li Left mouse button
46 \li While the left mouse button is pressed, mouse movement along x-axis pans the camera and
47 movement along y-axis tilts it.
48 \row
49 \li Shift key
50 \li Turns the fine motion control active while pressed. Makes mouse pan and tilt less
51 sensitive.
52 \row
53 \li Arrow keys
54 \li Move the camera horizontally relative to camera viewport.
55 \row
56 \li Page up and page down keys
57 \li Move the camera vertically relative to camera viewport.
58 \endtable
59*/
60/*!
61 \qmlproperty Camera FirstPersonCameraController::camera
62
63 Holds the currently controlled camera.
64*/
65/*!
66 \qmlproperty real FirstPersonCameraController::linearSpeed
67
68 Holds the current linear speed of the camera controller. Linear speed determines the
69 movement speed of the camera.
70*/
71/*!
72 \qmlproperty real FirstPersonCameraController::lookSpeed
73
74 Holds the current look speed of the camera controller. The look speed determines the turn rate
75 of the camera pan and tilt.
76*/
77/*!
78 \qmlproperty real FirstPersonCameraController::acceleration
79
80 Holds the current acceleration.
81 Specifies the rate at which the camera linear speed increases when a key is held.
82 If the acceleration is negative, the linear speed stays constant.
83 Defaults to -1.0.
84*/
85/*!
86 \qmlproperty real FirstPersonCameraController::deceleration
87
88 Specifies the rate at which the camera linear speed decreases when a key is released.
89 If the deceleration is negative, the linear speed stays constant.
90 Defaults to -1.0.
91*/
92
93/*!
94 \qmltype OrbitCameraController
95 \inqmlmodule Qt3D.Extras
96 \brief The OrbitCameraController class allows controlling the scene camera along orbital path.
97 \since 5.7
98 \inherits Qt3D.Core::Entity
99
100 The OrbitCameraController class allows controlling the scene camera along orbital path.
101
102 The controls are:
103 \table
104 \header
105 \li Input
106 \li Action
107 \row
108 \li Left mouse button
109 \li While the left mouse button is pressed, mouse movement along x-axis moves the camera
110 left and right and movement along y-axis moves it up and down.
111 \row
112 \li Right mouse button
113 \li While the right mouse button is pressed, mouse movement along x-axis pans the camera
114 around the camera view center and movement along y-axis tilts it around the camera
115 view center.
116 \row
117 \li Both left and right mouse button
118 \li While both the left and the right mouse button are pressed, mouse movement along y-axis
119 zooms the camera in and out without changing the view center.
120 \row
121 \li Arrow keys
122 \li Move the camera vertically and horizontally relative to camera viewport.
123 \row
124 \li Page up and page down keys
125 \li Move the camera forwards and backwards.
126 \row
127 \li Shift key
128 \li Changes the behavior of the up and down arrow keys to zoom the camera in and out
129 without changing the view center. The other movement keys are disabled.
130 \row
131 \li Alt key
132 \li Changes the behovior of the arrow keys to pan and tilt the camera around the view
133 center. Disables the page up and page down keys.
134 \endtable
135*/
136/*!
137 \qmlproperty Camera OrbitCameraController::camera
138
139 Holds the currently controlled camera.
140*/
141/*!
142 \qmlproperty real OrbitCameraController::linearSpeed
143
144 Holds the current linear speed of the camera controller. Linear speed determines the
145 movement speed of the camera.
146*/
147/*!
148 \qmlproperty real OrbitCameraController::lookSpeed
149
150 Holds the current look speed of the camera controller. The look speed determines the turn rate
151 of the camera pan and tilt.
152*/
153/*!
154 \qmlproperty real OrbitCameraController::zoomLimit
155
156 Holds the current zoom-in limit. The zoom-in limit determines how close to the view center
157 the camera can be zoomed.
158*/
159

Warning: That file was not part of the compilation database. It may have many parsing errors.