1/****************************************************************************
2**
3** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qabstractfunctor.h"
41
42QT_BEGIN_NAMESPACE
43
44namespace Qt3DRender {
45
46/*!
47 \class Qt3DRender::QAbstractFunctor
48 \inmodule Qt3DRender
49 \since 5.7
50 \brief QAbstractFunctor is an abstract base class for all functors.
51
52 The QAbstractFunctor is used as a base class for all functors and data
53 generators in Qt3DRender module.
54
55 When user defines a new functor or generator, they need to implement the
56 \l QAbstractFunctor::id() method, which should be done using the \c {QT3D_FUNCTOR}
57 macro in the class definition.
58 */
59/*!
60 \fn qintptr Qt3DRender::QAbstractFunctor::id() const
61
62 Returns a pointer to the id of the functor.
63 */
64/*!
65 \fn qintptr Qt3DRender::functorTypeId()
66
67 Returns a pointer to the type id of the functor.
68*/
69/*!
70 \macro QT3D_FUNCTOR(Class)
71 \relates Qt3DRender::QAbstractFunctor
72
73 This macro assigns functor id to the \a Class, which is used by QAbstractFunctor::functor_cast
74 to determine if the cast can be done.
75 */
76
77/*!
78 \fn template<class T> const T * Qt3DRender::QAbstractFunctor::functor_cast(const QAbstractFunctor *other) const
79
80 This method is used to cast functor \a other to type T if the other is of
81 type T (or of subclass); otherwise returns 0. This method works similarly
82 to \l [QtCore] {qobject_cast(const QObject *object)}{qobject_cast()},
83 except with functors derived from QAbstractFunctor.
84
85 \warning If T was not declared with \l QT3D_FUNCTOR macro, then the results are undefined.
86 */
87
88/*! Desctructor */
89QAbstractFunctor::~QAbstractFunctor()
90{
91
92}
93
94} // Qt3D
95
96QT_END_NAMESPACE
97
98

source code of qt3d/src/render/frontend/qabstractfunctor.cpp