summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-11-28 10:38:30 +0200
committerMats Honkamaa <mats.honkamaa@qt.io>2018-11-29 09:40:45 +0000
commitf2962496f28c138b697e243a71e2056dded452d4 (patch)
tree1ea1d4431c56628ebffd679028079b31b859fc2a
parentbba58ab6edcb43c7b2359ee6b67902355c7e2ee1 (diff)
Add scene camera palette documentation
Added documentation about the scene camera palette. Task-number: QT3DS-2589 Change-Id: I019a4f3362b5fb04f1e3740e5f3096a9a7a000ba Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
-rw-r--r--doc/src/03-studio/9-keyboard-shortcuts.qdoc20
-rw-r--r--doc/src/03-studio/scene-camera-palette.qdoc66
-rw-r--r--doc/src/03-studio/studio-index.qdoc1
-rw-r--r--doc/src/images/scene-camera-palette.pngbin0 -> 9552 bytes
4 files changed, 87 insertions, 0 deletions
diff --git a/doc/src/03-studio/9-keyboard-shortcuts.qdoc b/doc/src/03-studio/9-keyboard-shortcuts.qdoc
index 1e46b988..bd7a0001 100644
--- a/doc/src/03-studio/9-keyboard-shortcuts.qdoc
+++ b/doc/src/03-studio/9-keyboard-shortcuts.qdoc
@@ -166,6 +166,10 @@
\li \c{Ctrl + Shift + T}
\li \c{Cmd + Shift + T}
\row
+ \li Show scene camera palette
+ \li \c{Ctrl + Shift + F}
+ \li \c{Cmd + Shift + F}
+ \row
\li Show/hide bounding boxes
\li \c{Ctrl + B}
\li \c{Cmd + B}
@@ -582,4 +586,20 @@ only in \e{Perspective View} and \e{Orthographic View}.
\li \c{Shift + A}
\endtable
+\section2 Scene Camera
+
+\table
+ \header
+ \li Function
+ \li Windows/Linux
+ \li macOS
+ \row
+ \li Pan
+ \li Left mouse drag
+ \li Left mouse drag
+ \row
+ \li Zoom
+ \li Right mouse drag up/down or mouse scroll wheel
+ \li Right mouse drag up/down or mouse scroll wheel
+\endtable
*/
diff --git a/doc/src/03-studio/scene-camera-palette.qdoc b/doc/src/03-studio/scene-camera-palette.qdoc
new file mode 100644
index 00000000..c4b9c7f9
--- /dev/null
+++ b/doc/src/03-studio/scene-camera-palette.qdoc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\title Studio: Scene Camera Palette
+\page studio-scene-camera-palette.html
+\ingroup qt3dstudio-studio
+
+\image scene-camera-palette.png
+
+The scene camera palette allows you to zoom in to pixel perfect level with the scene camera.
+
+\section1 Navigation
+
+\section2 Zooming
+
+To zoom the scene camera, do one of the following:
+
+\list
+ \li
+ Use the zoom slide bar in the bottom part of the scene camera palette.
+ \li
+ Use the mouse scroll wheel.
+ \li
+ Use right mouse click and mouse drag up/down.
+\endlist
+
+\note Using the mouse to zoom in will zoom in to the location of the mouse cursor. Using the zoom
+scroll bar will zoom in to the center of the presentation.
+
+\section2 Panning
+
+To move around in the scene camera view, do one of the following:
+
+\list
+ \li
+ Hold the left mouse button and move the mouse.
+ \li
+ Use the horizontal and vertical scroll bars to move around.
+\endlist
+
+*/
diff --git a/doc/src/03-studio/studio-index.qdoc b/doc/src/03-studio/studio-index.qdoc
index 27de39a6..ea485bde 100644
--- a/doc/src/03-studio/studio-index.qdoc
+++ b/doc/src/03-studio/studio-index.qdoc
@@ -58,6 +58,7 @@ Studio to place them in your presentation.
\li \l {Studio: Slide Palette}
\li \l {Studio: Inspector Palette}
\li \l {Studio: Action Palette}
+ \li \l {Studio: Scene Camera Palette}
\li \l {Studio: Keyboard Shortcuts}
\endlist
//! [toc]
diff --git a/doc/src/images/scene-camera-palette.png b/doc/src/images/scene-camera-palette.png
new file mode 100644
index 00000000..5eb4bdbf
--- /dev/null
+++ b/doc/src/images/scene-camera-palette.png
Binary files differ