summaryrefslogtreecommitdiffstats
path: root/src/doc
diff options
context:
space:
mode:
authorMike Krus <mike.krus@kdab.com>2017-01-19 19:47:27 +0000
committerSean Harmer <sean.harmer@kdab.com>2017-01-23 21:45:24 +0000
commit45b5514ee1f816b24461f7523b779f65c6c93ea5 (patch)
tree53fd48ded880df657ee830ca61f64c69dde89847 /src/doc
parenta6c5261671379da7e8fb78b10508fc00d3e7b16a (diff)
LevelOfDetail (LOD) node
Component to control complexity of entities based on either distance to camera or size on screen. Given a specific camera, the LevelOfDetail computes the distance to the observer, or the screen size of the entity. The currentIndex property is updated to identify which of the entries in the provided array of distance or size ranges contains the current value. A disabled LevelOfDetail component will act as a simple (user controlled) switch. Updates are not done on disabled sub trees since their bounding boxes may not be valid. Change-Id: Ifa4c088de6b80b6a6ed203070411761574686cdb Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/src/levelofdetailloader.qdoc57
1 files changed, 57 insertions, 0 deletions
diff --git a/src/doc/src/levelofdetailloader.qdoc b/src/doc/src/levelofdetailloader.qdoc
new file mode 100644
index 000000000..65fda072a
--- /dev/null
+++ b/src/doc/src/levelofdetailloader.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \qmltype LevelOfDetailLoader
+ \inqmlmodule Qt3D.Render
+ \since 5.9
+ \brief An entity loader that changes depending on distance to camera or screen size
+
+ A LevelOfDetailLoader will load the entity matching the \l LevelOfDetail::currentIndex.
+ The source is selected from the \l sources property.
+ The range is specified using the \l {minimum} and the \l{maximum} values.
+
+ \sa LevelOfDetail
+*/
+
+/*!
+ \qmlproperty list<string> LevelOfDetailLoader::sources
+
+ The list of sources (array of strings) to load from.
+*/