summaryrefslogtreecommitdiffstats
path: root/doc/src/03-studio/0-menu.qdoc
blob: f1359cf2671779938d68232fd343b1363210725d (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/****************************************************************************
**
** Copyright (C) 1993-2009 NVIDIA Corporation.
** Copyright (C) 2017 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: Menu
\page studio-menu.html
\ingroup qt3dstudio-studio

\section1 File

\list
\li
  \uicontrol{New} - Opens a dialog to create a new presentation or project
  \list
    \li
      \uicontrol{Project} - Creates a new project. A new directory with default
      folder structure will be created.
    \li
      \uicontrol{Presentation} - Creates a new presentation to use as i.e. a sub-presentation.
      Default location is the \e{presentations} folder in current project.
  \endlist
\li
  \uicontrol{Duplicate Presentation} - Saves a copy of the open presentation to
  the same folder and adds it to the project. The assets are not duplicated as they are
  available via the same relative paths already.
\li
  \uicontrol{Open} - Opens a \c{.uip} presentation file.
\li
  \uicontrol{Recent Presentations} - Provides quick access to the last 10
  presentations opened in Studio.
\li
  \uicontrol{Revert to Last Save} - With confirmation, abandons all in-memory
  changes to the presentation and re-opens it from disk.
  \note this resets the state of Studio (resetting all components to the first
  slide, playheads to time 0, etc.). This command is also a convenient
  way to re-open a presentation that may have changed on disk, for
  example via hand editing or source control updating.
\li
  \uicontrol{Close Project} - Closes the current project, resets the user interface, and
  shows the startup dialog window.
\li
  \uicontrol{Save Presentation} - Saves changes to the open presentation.
\li
  \uicontrol{Save Project As} - Saves the open project and all its assets to a new location.
\li
  \uicontrol{Import} - Opens the assets library folder to import assets to your project.
\li
  \uicontrol{Data Inputs} - Manage \l{Using Data Inputs}{data inputs}.
\li
  \uicontrol{Copy QML Code for Datainputs/Outputs} - Copies data input and data output QML
  declarations to the clipboard.
\li
  \uicontrol{Exit} - Quits Studio (prompting to save changes).
\endlist

\section1 Edit

\list
\li
  \uicontrol{Undo}/\uicontrol{Redo} - As expected.
\li
  \uicontrol{Cut}/\uicontrol{Copy}/\uicontrol{Paste} - As expected.
\li
  \uicontrol{Paste to Master Slide} - Pastes the copied element to master slide. The target
  has to be on master slide, i.e. name is green.
\li
  \uicontrol{Duplicate} - Creates a copy of the currently-selected
  object in the timeline on the current slide. If the selected object
  is on the master slide, but you are on a slide other than the master
  slide, the copy will be non-master. Duplicating a
  master object on the master slide does \e{not} preserve any
  master-unlinked properties.
\li
  \uicontrol{Delete} - Deletes the selected element.
\li
  \uicontrol{Group Objects} - Creates a group and moves selected objects into that group.
\li
  \uicontrol{Connect to Device} - Opens a dialog to connect to a remote device.
\li
  \uicontrol{Studio Preferences} - Opens the Studio Preferences dialog.
  \image ApplicationPreferences.png
  \list
  \li
    \uicontrol{General}
    \list
    \li
      \uicontrol{Default Interpolation} - Controls whether new animation
      keyframes are created with linear or smooth interpolation. This setting applies only to
      animations of \l{Ease In/Out} type.
    \li
      \uicontrol{Timeline Snapping Grid} - When using snapping in the
      timeline, controls which ticks to snap to.
    \li
      \uicontrol{Legacy Viewer} - Enables the legacy viewer preview button in the toolbar. Legacy
      viewer uses Runtime from Qt 3D Studio 1.1, whereas the default viewer uses Runtime from
      Qt 3D Studio 2.0. Requires a restart.
    \endlist
  \li
    \uicontrol{Editing View}
    \list
    \li
      \uicontrol{Preferred Startup View} - Sets default camera view
      when starting Studio.
    \li
      \uicontrol{Helper Grid} - Sets number of lines and space between the lines of the
      helper grid in edit camera views.
    \endlist
  \li
    \uicontrol{Manipulator Tool Handles} - Sets the size of the manipulator tool handles.
  \li
    \uicontrol{Autosave} - Enables auto saving.
    \list
    \li
      \b{Interval (seconds)} - Sets the delay between autosaves in seconds. Minimum interval is 30.
    \li
      \b{Clear Autosave Files} - Deletes all autosave files from the presentation folder.
    \endlist
  \li
    \b{Restore Defaults} - Restores all preferences for Studio to
    their default state. This does not restore palette layouts or positions.
  \li
    \b{Reset Layout} - Restores palette layouts and positions. Requires a restart.
  \endlist
\li
  \target project-settings
  \uicontrol{Presentation Settings} - Opens the Presentation Settings dialog.
  \image PresentationSettings.png
  \list
  \li
    \uicontrol{Presentation}
    \list
    \li
      \uicontrol{Presentation Id} - Changes the id of the currently open presentation.
    \li
      \uicontrol{Width x Height} - Sets the render size for the presentation.
      \note Setting a higher resolution for a sub-presentation than the final
      display size will result in anti-aliasing for the sub-presentation
      (albeit at a performance cost).
    \li
      \uicontrol{Constrain Proportions} - When checked, editing a width or
      height value will also update the other. (This setting has no effect
      at runtime.)
    \li
      \uicontrol{Portrait Format} - When editing a portrait style
      presentation (width is smaller than height) designed to be displayed
      on a rotated hardware device (for example a tablet), check this setting to
      have the presentation rotated correctly. This setting has no effect
      when previewing on your computer.
    \li
      \uicontrol{Use ktx textures if available} - Force runtime to check first if there are KTX
      compressed textures available when loading texture maps. This allows designers to use i.e.
      PNG or JPG textures while working in the editor, but to automatically use hardware optimized
      compressed textures on the target device.
      \note This should only be checked when KTX textures are present.
    \endlist
  \li
    \uicontrol{Project Info}
    \list
    \li
      \uicontrol{Author/Company} - Informational meta data stored in the \c{.uip} file.
      These settings have no effect at runtime.
    \endlist
  \endlist
\endlist

\section1 View

\list
\li
  \uicontrol{Reset layout} - Resets the layout of palettes. Requires a restart.
\li
  \uicontrol{Fit selected} - Fit the selected element to the screen. Works only in
  \l{studio-toolbar.html#edit-cameras}{edit camera} modes.
\li
  \uicontrol{Hide/unhide selected} - Hides/unhides the selected element.
\li
  \uicontrol{\e{Palettes}} - Toggles the display of palettes.
\li
  \uicontrol{Bounding Boxes} - Toggles the display of bounding boxes.
  \note Bounding boxes will only be visible on selected objects.
\li
  \uicontrol{Pivot Point} - Toggles the display of the pivot point.
  \note Pivot point will only be visible on selected objects.
  selected item.
\omit
\li
  \uicontrol{Wireframe} - Toggles the display of wireframes for the selected item.
  \note Works only for tessellated meshes.
\endomit
\li
  \uicontrol{Tooltips} - Toggles the display of tool tips when hovering over
  rows in the \l{studio-inspector-palette.html}{Inspector palette}.
\li
  \uicontrol{Rulers & Guides} - Toggles the display of rulers and guides in the scene view.
\li
  \uicontrol{Lock Guides} - Locks all guides in the scene view.
\li
  \uicontrol{Clear Guides} - Deletes all guides in the scene view.
\li
  \uicontrol{Disable Scene Lighting} - Disable lighting from scene lights in edit views,
\endlist

\section1 Timeline

\list
\li
  \uicontrol{Set Changed Keyframes} - When \e{Autoset Keyframes} is turned
  off, invoking this command will create keyframes at the current time
  for any properties of the object that:
  \list a
    \li Have their
    \l{studio-inspector-palette.html#animating-properties}{animation toggle}
    enabled.
    \li Have values different from the animated value at the current time.
  \endlist
\li
  \uicontrol{Delete Selected Keyframe(s)} - Deletes the selected keyframes.
  This command is also available from the context menu when
  right-clicking in the animation portion of the \e{timeline palette}. Additionally you can
  press the \c{Delete} key after selecting the keyframes to delete them.
\li
  \uicontrol{Set Interpolation} - Changes the in and out
  \l{Ease In/Out}{interpolation}
  setting for the selected keyframes. This command is
  also available from the context menu when right-clicking in the
  animation portion of the \e{timeline palette}.
\li
  \uicontrol{Change Time Bar Color} - Sets the display color of the
  time bar in the animation portion of the \e{timeline palette}. This does
  not affect the rendering of the presentation, it is only there to help
  you organize and keep track of your work.
\li
  \uicontrol{Toggle Autoset Keyframes} - Toggles the autoset keyframes
  functionality. When enabled, any change to a property whose
  \l{studio-inspector-palette.html#animating-properties}{animation toggle}
  is enabled will result in a keyframe being created or updated
  at the current time.
\endlist

\section1 Help

\list
\li
  \uicontrol{Reference Manual} - Opens the Qt 3D Studio user manual.
\li
  \uicontrol{Visit Qt 3D Studio Page} - Opens the Qt 3D Studio web site in your
  default web browser.
\li
  \uicontrol{About Qt 3D Studio} - Opens the about dialog.
\li
  \uicontrol{Open Tutorial} - Opens the getting started tutorial.
\endlist

*/