summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update project palette imagesMats Honkamaa2018-06-012-0/+0
| | | | | | Task-number: QT3DS-1784 Change-Id: I4985018f1cac712400550df2c86012419636e50e Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Document possible revision issue with old UIPsTomi Korpipaa2018-05-312-0/+17
| | | | | | | | Task-number: QT3DS-1835 Change-Id: I4a56e29383c0985549eae0b83f8f9cb48347a0ff Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Marianne Yrjänä <marianne.yrjana@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Clarify how custom materials can implement main functionMäättä Antti2018-05-291-0/+52
| | | | | | | Task-number: QT3DS-1701 Change-Id: Ie41cb000d99875f740f376b795cd95c568fd1e44 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Fix indent in best practices docsTomi Korpipaa2018-05-281-6/+8
| | | | | Change-Id: Ifaa2d15e64cc7b01a9d99784ec21dfce0c7bad64 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Update specular map documentationJere Tuliniemi2018-05-231-1/+1
| | | | | | | | | | | Update the docs to reflect that the color of the specular map is now used. Task-number: QT3DS-1707 Change-Id: I09b9e20124aadc7c57a30a8b073da8f96607580f Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Remove examples documentationMarianne Yrjänä2018-05-223-95/+0
| | | | | | | | | | All but presentation-only examples are now located under runtime2 so remove also corresponding documentation from studio. Task-number: QT3DS-1724 Change-Id: I20e80bd62d9b00bfb569b34d5f5dc7082ff9965b Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Update images in documentationMats Honkamaa2018-05-2113-0/+0
| | | | | | | | | Updated images in documentation. Task-number: QT3DS-1190 Change-Id: I920adcddd6a5e366aeb76dab1b40065faaef8837 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Document missing properties for standard materialMats Honkamaa2018-05-211-17/+30
| | | | | | | | | | | Added description of the properties for standard materials that was missing. Task-number: QT3DS-1682 Change-Id: I7b973951751be243ec231ac7ec06d860ca6cd337 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix documentation issuesTopi Reinio2018-05-184-6/+8
| | | | | | | | | | | | | Update online sidebar links to runtime and type documentation. Rename landing page to qt3dstudio-index.html. This forces qdoc to display sidebar also for the landing page. Add a url and a dependency to the runtime doc project, and fix related linking issues. Change-Id: Iad73551539238a69253386421596c3f7c036fa9f Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Fix Studio and Best Practices documentation bugsTomi Korpipaa2018-05-1729-336/+130
| | | | | | | | | Task-number: QT3DS-1678 Task-number: QT3DS-1679 Change-Id: I16e9bde48fc8c18223e8214a4d05156537fa8f7d Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Remove obsolete content from documentationMats Honkamaa2018-05-174-258/+0
| | | | | | | | Removed obsolete pages and images from documentation Task-number: QT3DS-1605 Change-Id: Ifc48fd9e71c9c8fc1ace27a26325a7841ae489da Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* docs: update Viewer sectionLaszlo Agocs2018-05-154-105/+51
| | | | | | Change-Id: I2f9b6576a52c539e16a9be6d33cf31e7e1ff03ba Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* Remove LUA reference from documentationMats Honkamaa2018-05-155-94/+1
| | | | | | | | Removed LUA references from documentation. Task-number: QT3DS-1464 Change-Id: Ia67a0564bf2466ea0482653fb9af596fc4077905 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* doc: Drop the runtime link from the main pageLaszlo Agocs2018-05-152-2/+1
| | | | | | | | It does not work so remove this for now. Change-Id: I0d4a7c6ed90eb374e2709824b904c6f2f8432694 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* doc: remove runtime pages and API refLaszlo Agocs2018-05-1428-4169/+2
| | | | | | | | Task-number: QT3DS-1003 Change-Id: I0bd0431598528a4cbc6ad585b83fd44f7a2881c6 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Antti Määttä <antti.maatta@qt.io>
* Update keyboard shortcut documentationMats Honkamaa2018-05-141-72/+341
| | | | | | | Task-number: QT3DS-1338 Change-Id: I19e0811cb20dc9367bfa36a00526ef5aeb412c7b Reviewed-by: Soili Väinämö <soili.vainamo@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add documentation on using QML streaming in editorMats Honkamaa2018-05-111-15/+25
| | | | | | | | | | | Added documentation on how to use QML streaming as sub-presentation on the editor side. Task-number: QT3DS-1271 Change-Id: I00eebb0deb803e489c1b6eb63744f3366588bd2b Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Janne Kangas <janne.kangas@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* doc: Remove unsupported effect and custom material featuresLaszlo Agocs2018-05-093-299/+26
| | | | | | | | Task-number: QT3DS-913 Task-number: QT3DS-914 Change-Id: I362c35231a31a620b991d190e1589e4ed49df90a Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* Update shy icon imageMats Honkamaa2018-05-091-0/+0
| | | | | | | | Updated the shy icon image to the correct one Task-number: Qt3DS-1268 Change-Id: I9a7134e98648c4fca185d9b63a76907a4bc03c58 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Update slide palette documentationMats Honkamaa2018-05-092-38/+35
| | | | | | | | | | Fixed formatting and minor errors. Added more clear description of actions on master slide. Task-number: QT3DS-844 Change-Id: I4afcd52ced2d0e5ffbaae8a542cb1cf6336447a9 Reviewed-by: Janne Kangas <janne.kangas@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Update restore default and reset layout docsTomi Korpipaa2018-04-261-1/+2
| | | | | | | | Task-number: QT3DS-1423 Change-Id: I9159ffd75a310183db695c0e0fb73779ae2ce61b Reviewed-by: Janne Kangas <janne.kangas@qt.io> Reviewed-by: Marianne Yrjänä <marianne.yrjana@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Add button for clearing autosave files to preferences dialogTomi Korpipaa2018-04-261-0/+6
| | | | | | | | Task-number: QT3DS-1365 Change-Id: I4f1553dcab477cfbf40281228fe98ccfbbaf2d28 Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Marianne Yrjänä <marianne.yrjana@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Add documentation on how to build examples using macOSMats Honkamaa2018-04-131-2/+11
| | | | | | | | Added the necessary steps for building examples using macOS. Task-number: QT3DS-1417 Change-Id: I94216f78dd02dafcd076b6d7d38b9284e986bae4 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Update Action Palette documentationMats Honkamaa2018-04-063-41/+61
| | | | | | | | | Updated the Action Palette documentation Task-number: Qt3DS-647 Change-Id: I76398ddf5a52e9860cf1506d1919313b5423b464 Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Document Alt-click camera toolsMats Honkamaa2018-04-043-28/+51
| | | | | | | | | Updated documentation with the new way to navigate in Edit Camera Modes. Task-number: QT3DS-1324 Change-Id: Idbe7cfefbe87527478ec777be75cf9689dcc367a Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Teemu Tamminen <teemu.tamminen@qt.io>
* Update sub-presentation documentationMats Honkamaa2018-03-221-7/+18
| | | | | | | | | Updated sub-presentation documentation with the new way to add/create sub-presentations. Additionally corrected minor errors. Task-number: QT3DS-1308 Change-Id: Id16c895917f39327efcf416596ee6c7d56f9f655 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Update Studio:Menu documentationMats Honkamaa2018-03-212-109/+127
| | | | | | | | | | | | Some updates to the Studio:Menu documentation: - Added missing information - Updated image - Restructured/reformated some parts Task-number: Qt3DS-1318 Change-Id: I3bb52f861ad2fa1a75544f7ba331d14fabf719fa Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add Remote Preview button to documentationMats Honkamaa2018-03-196-13/+18
| | | | | | | | | Updated documentation to included the Remote Preview button. Task-number: QT3DS-1288 Change-Id: I896e92d1fbd3d202c020a63220479fa582e3423d Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add documentation of editor side of behavior scriptsMats Honkamaa2018-03-196-0/+73
| | | | | | | | | Added documentation on how to use behavior scripts in the editor Task-number: QT3DS-1270 Change-Id: I42d53f8f83b293cf21abbfb2c8a4feba7a19263e Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Improve Windows' specific term "Explorer" in assets context menuTasuku Suzuki2018-03-151-1/+1
| | | | | | | Qt Creator uses "Show Containing Folder" for that. Change-Id: I2af0998232c319bc74bb8dbd9f48619040698f4c Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add documentation of macOS shortcut keysMats Honkamaa2018-03-082-15/+86
| | | | | | | | | | Added documentation of macOS shortcut keys for Qt 3D Studio editor and viewer. Task-number: QT3DS-696 Change-Id: Ief3d5afd3385140302231a33f0d1990f33de0959 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Move playback control documentation to correct placeMats Honkamaa2018-02-193-28/+27
| | | | | | | | | Moved playback control documentation from toolbar section to timeline section. Updated related image. Task-number: QT3DS-1085 Change-Id: I9414a2b48429596c326971f1cd306de841a99665 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Update old imagesMats Honkamaa2018-02-197-0/+0
| | | | | | | | Updated old images in documentation. Task-number: QT3DS-977 Change-Id: I47f4e7ede0adafb7940e6dfb656960c7dd1782df Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Document binary QML component and runtime setupMats Honkamaa2018-02-161-0/+34
| | | | | | | | | | Added documentation on how to setup the binary QML component and runtime. Task-number: QT3DS-470 Change-Id: Ief1e495bb657429781c05097fb4df6d9ff7b27c3 Reviewed-by: Marianne Yrjänä <marianne.yrjana@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Correct links to Presentation QML ElementMats Honkamaa2018-02-144-3/+6
| | | | | | | | | Corrected links to Presentation QML Element in Qt3D Studio QML documentation. Task-number: QT3DS-853 Change-Id: Ie6d2b0213583e229fbc6b42c16115f040f11b7f1 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Fix image file names in documentationMats Honkamaa2018-02-132-2/+2
| | | | | | | | Two image file names were wrong. Corrected them. Task-number: QT3DS-1029 Change-Id: Ifbfa11cf7db769b4ff31d755cb9bb7306f13cbe7 Reviewed-by: Antti Määttä <antti.maatta@qt.io>
* Correct shortcut keys for previewing in viewer in docsMats Honkamaa2018-02-062-2/+2
| | | | | | | | Corrected the shortcut key for remote viewing in the viewer from F12 to F5 in docs. Change-Id: Ifabd8db11804fafc3730cd18cca5c3dd99980cee Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Doc: Fix missing characters in 'optimizing images'Kai Koehne2018-02-061-2/+2
| | | | | | Change-Id: Ic03ac9dd1eddc7ee2cb28f6ab7fdf51eb4637ff1 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Remove nudging with arrow keys functionalityMiikka Heikkinen2018-02-062-82/+0
| | | | | | | | | | | According to UX people, the nudge functionality is not desirable, so remove it. Task-number: QT3DS-954 Change-Id: Ie73ecec098c9d9215d95c7913ed153a6aaed2aa6 Reviewed-by: Janne Koskinen <janne.p.koskinen@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add remote deployment documentationMats Honkamaa2018-02-064-4/+107
| | | | | | | | | Added remote deployment documentation. Additionally small restructure of command line usage documentation. Task-number: QT3DS-562 Change-Id: I9d5b9337883aca3657f5c189b52c9a7bb996a3a5 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Clarify the use of Buffer type in docsMäättä Antti2018-02-061-3/+7
| | | | | | | | | Add note to Buffer property documentation to clarify that it can only be used with SSBO's and textures use other property type. Change-Id: Ifcf8d5b3d04b41cfce68e9ecc3c2e086090ccb8d Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Add effect reference documentationMäättä Antti2018-02-021-0/+656
| | | | | | Task-number: QT3DS-393 Change-Id: I946af263121df0da60b4c8dca6ce29d348c0ed31 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Fix comment abould lighting flagMäättä Antti2018-02-021-1/+1
| | | | | | | | | The CG_LIGHTING flag is not on by default, but always when there are lights in the scene. Change-Id: I2eb1459c42299bc81b1bfb14e540996757e8f63b Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Document experimental opengl es 2 supportMäättä Antti2018-02-022-0/+83
| | | | | | Task-number: QT3DS-145 Change-Id: I3dbae59914d24225587743195707398698431806 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add documentation on .effect and .material filesMats Honkamaa2018-02-023-1/+309
| | | | | | | | | | | Added documentation on the file structure of .effect and .material files. Restructured the file formats section. Task-number: QT3DS-393 Change-Id: I72e2cb732abb7978aef0031e3a79a51756d88c8c Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add data input documentationMats Honkamaa2018-02-0216-0/+170
| | | | | | | | | | | Added documentation on data input. Updated UI screen shots related to data input. Task-number: QT3DS-876 Change-Id: I5dbb772bf925e1e435ded5df59a2258b04b0c5a6 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Treat all DataInput value sets as changesMiikka Heikkinen2018-02-022-2/+4
| | | | | | | | | | | Since the local value doesn't accurately reflect the actual value of the controlled value in the presentation, we treat all value sets on DataInputs as value changes and act accordingly. Change-Id: I96adc255263a5523fe951e0a4d67c51d6f0a7043 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Jere Tuliniemi <jere.tuliniemi@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Docs for writing custom materialsMäättä Antti2018-01-262-0/+531
| | | | | | | | Task-number: QT3DS-345 Change-Id: Id1c4fbf2ccc25761e8550a901dd330b588569582 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Antti Määttä <antti.maatta@qt.io>
* Add SetDataInputValue to IScriptBridgeMiikka Heikkinen2018-01-261-1/+7
| | | | | | | | | | | Data inputs and their linked attributes are collected into a map at presentation initialization time. Task-number: QT3DS-857 Change-Id: I6a22ddf16867e76b0fed1c1b5d7e6ab08153c024 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Jere Tuliniemi <jere.tuliniemi@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Add QML type and C++ class for data inputMiikka Heikkinen2018-01-266-2/+178
| | | | | | | | QML type is DataInput. C++ class is Q3DSDataInput. Task-number: QT3DS-387 Change-Id: I7f871ae3e1149adee7859fdb8f844e8f90837264 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>