summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-05-15 10:30:36 +0300
committerMats Honkamaa <mats.honkamaa@qt.io>2018-05-15 08:37:13 +0000
commitc7f6256b62c6425dbc8cdc45e3b70d2781bb3a82 (patch)
tree4663e60f0a6bb738d432153c7779efadf80e2814 /doc
parentfc849a0265bf2331a7e5baf45e7767e4d634cc88 (diff)
Remove LUA reference from documentation
Removed LUA references from documentation. Task-number: QT3DS-1464 Change-Id: Ia67a0564bf2466ea0482653fb9af596fc4077905 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/03-studio/4-basic-objects-palette.qdoc2
-rw-r--r--doc/src/08-integrating/0-lua-modules.qdoc84
-rw-r--r--doc/src/08-integrating/integrating-index.qdoc1
-rw-r--r--doc/src/10-best-practices/20-creating-optimized-presentations.qdoc8
-rw-r--r--doc/src/images/Workflow-Solid.pngbin184395 -> 0 bytes
5 files changed, 1 insertions, 94 deletions
diff --git a/doc/src/03-studio/4-basic-objects-palette.qdoc b/doc/src/03-studio/4-basic-objects-palette.qdoc
index 8083d6c7..582f3c8f 100644
--- a/doc/src/03-studio/4-basic-objects-palette.qdoc
+++ b/doc/src/03-studio/4-basic-objects-palette.qdoc
@@ -164,7 +164,7 @@ Aliases are only active during authoring time. At runtime they become a
full copy of the referenced object and all its descendants. This allows
you to, for example, create a single template component and with 10
aliases of it controlled by script. While each alias will look identical
-in Studio during creation, Lua script or state machines can customize
+in Studio during creation, scripts or state machines can customize
each instance based on data or application state.
*/
diff --git a/doc/src/08-integrating/0-lua-modules.qdoc b/doc/src/08-integrating/0-lua-modules.qdoc
deleted file mode 100644
index 4a35cc8b..00000000
--- a/doc/src/08-integrating/0-lua-modules.qdoc
+++ /dev/null
@@ -1,84 +0,0 @@
-/****************************************************************************
-**
-** 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 Lua Modules
-\page integrating-lua-modules.html
-\ingroup qt3dstudio-integrating
-
-\section1 Extending Qt 3D Studio
-
-The Qt 3D Studio Runtime can easily be integrated with existing
-hardware and software by means of modules. Modules are a standard
-feature of the Lua language that allow new C bindings to be added with a
-DLL or shared library.
-
-\image Workflow-Solid.png
-
-The diagram above shows multiple Lua Modules extending the capabilities
-of the Runtime scripting to allow access to low level calls controlling
-hardware such as music, navigation, and general CAN Bus communication.
-
-\section1 Binding Code to Lua
-
-Lua Bindings are a well-documented topic online. A nice reference for
-implementation can be found
-\l{http://lua-users.org/wiki/BindingCodeToLua}{on the Lua wiki}.
-Additionally, a simple sample of a CAN module that works with
-CarConnection behavior is provided with your installation of Qt 3D Studio
-at \c{INSTALL_DIRECTORY/Runtime/Plugins/Bindings/CAN/...}.
-
-To call functions in your module, place the \c{.dll} (Windows) or
-\c{.so} (Linux/Android) directly next to the Qt 3D Studio
-Viewer executable. At the top of a script where you would like to call
-your custom bindings, use the Lua \c{require} function.
-
-\badcode
--- Load the CAN module and output any errors in the process
-require("CAN")
-\endcode
-
-The use of \c{require()} will produce helpful error strings if the
-module cannot be found. Once the system is in place, however it is often
-preferable to control the resulting errors. For this, you can use the
-built-in Lua function \c{pcall()}:
-
-\badcode
--- Instead, one can use pcall to hide errors and control the program flow
-if not pcall( require, "CAN" ) then
- output( "Could not locate CAN module." )
-end
-
--- Call a function in our Lua binding
-if CAN then
- self.catalog = CAN.getCatalog()
-end
-\endcode
-
-*/
diff --git a/doc/src/08-integrating/integrating-index.qdoc b/doc/src/08-integrating/integrating-index.qdoc
index 65060756..0b6d4426 100644
--- a/doc/src/08-integrating/integrating-index.qdoc
+++ b/doc/src/08-integrating/integrating-index.qdoc
@@ -36,7 +36,6 @@
\section1 Contents
//! [toc]
\list
- \li \l {Lua Modules}
\li \l {Render Plugins}
\endlist
//! [toc]
diff --git a/doc/src/10-best-practices/20-creating-optimized-presentations.qdoc b/doc/src/10-best-practices/20-creating-optimized-presentations.qdoc
index 2349e193..47a9851b 100644
--- a/doc/src/10-best-practices/20-creating-optimized-presentations.qdoc
+++ b/doc/src/10-best-practices/20-creating-optimized-presentations.qdoc
@@ -116,14 +116,6 @@ in mind while writing scripts.
\li
Caching values can improve performance.
\li
- Reading values from a Lua table is going to be faster than getting
- them by calling \c{getAttribute()} to pull the value from the
- element.
-\li
- If you're going to be using a value often (an attribute value, element
- reference, etc), consider storing it in a Lua table rather than
- calling a function to look it up over and over again.
-\li
Use \c{onUpdate} judiciously.
\li
A behavior's \c{onUpdate} handler, which can be used to execute
diff --git a/doc/src/images/Workflow-Solid.png b/doc/src/images/Workflow-Solid.png
deleted file mode 100644
index d8a6f1ab..00000000
--- a/doc/src/images/Workflow-Solid.png
+++ /dev/null
Binary files differ