summaryrefslogtreecommitdiffstats
path: root/src/Runtime/ogl-runtime/src/dm/systems/Qt3DSDMActionCore.h
blob: a9201462fdd56e5c9ed53ef0d61a8cb977e0f48d (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
/****************************************************************************
**
** 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:GPL-EXCEPT$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#pragma once
#ifndef QT3DSDM_ACTION_CORE_H
#define QT3DSDM_ACTION_CORE_H

#include "Qt3DSDMHandles.h"
#include "HandleSystemBase.h"
#include "Qt3DSDMActionInfo.h"

namespace qt3dsdm {
const long REFERENCED_AS_OWNER = 0x01;
const long REFERENCED_AS_TRIGGER = 0x02;
const long REFERENCED_AS_TARGET = 0x04;
class IStringTable;

/**
 *	ActionCore
 */
class IActionCore : public IHandleBase
{
public:
    virtual ~IActionCore() {}

    virtual TStringTablePtr GetStringTablePtr() const = 0;
    virtual IStringTable &GetStringTable() const = 0;
    // Action
    virtual Qt3DSDMActionHandle CreateAction(Qt3DSDMInstanceHandle inInstance,
                                            Qt3DSDMSlideHandle inSlide, Qt3DSDMInstanceHandle inOwner,
                                            SLong4 inTriggerTargetObjects) = 0;
    virtual void DeleteAction(Qt3DSDMActionHandle inAction, Qt3DSDMInstanceHandle &outInstance) = 0;
    virtual const SActionInfo &GetActionInfo(Qt3DSDMActionHandle inAction) const = 0;
    virtual void GetActions(Qt3DSDMSlideHandle inSlide, Qt3DSDMInstanceHandle inOwner,
                            TActionHandleList &outActions) const = 0;
    virtual void GetActions(Qt3DSDMSlideHandle inSlide, TActionHandleList &outActions) const = 0;
    virtual void GetActions(Qt3DSDMInstanceHandle inOwner, TActionHandleList &outActions) const = 0;
    virtual void GetActions(TActionHandleList &outActions) const = 0;

    // Return the instance that was allocated for this action.
    virtual Qt3DSDMInstanceHandle GetActionInstance(Qt3DSDMActionHandle inAction) const = 0;
    // Reverse lookup into the action system so you can match actions to instances.
    virtual Qt3DSDMActionHandle GetActionByInstance(Qt3DSDMInstanceHandle inActionInstance) const = 0;

    // Action Properties
    virtual void SetTriggerObject(Qt3DSDMActionHandle inAction,
                                  const SObjectRefType &inTriggerObject) = 0;
    virtual void SetTargetObject(Qt3DSDMActionHandle inAction,
                                 const SObjectRefType &inTargetObject) = 0;
    virtual void SetEvent(Qt3DSDMActionHandle inAction, const wstring &inEventName) = 0;
    virtual void SetHandler(Qt3DSDMActionHandle inAction, const wstring &inHandlerName) = 0;

    // Handler Argument
    virtual Qt3DSDMHandlerArgHandle AddHandlerArgument(Qt3DSDMActionHandle inAction,
                                                      const TCharStr &inName,
                                                      HandlerArgumentType::Value inArgType,
                                                      DataModelDataType::Value inValueType) = 0;
    virtual void RemoveHandlerArgument(Qt3DSDMHandlerArgHandle inHandlerArgument) = 0;
    virtual const SHandlerArgumentInfo &
    GetHandlerArgumentInfo(Qt3DSDMHandlerArgHandle inHandlerArgument) const = 0;
    virtual void GetHandlerArguments(Qt3DSDMActionHandle inAction,
                                     THandlerArgHandleList &outHandlerArguments) const = 0;

    // Handler Argument Properties
    virtual void GetHandlerArgumentValue(Qt3DSDMHandlerArgHandle inHandlerArgument,
                                         SValue &outValue) const = 0;
    virtual void SetHandlerArgumentValue(Qt3DSDMHandlerArgHandle inHandlerArgument,
                                         const SValue &inValue) = 0;
};

typedef std::shared_ptr<IActionCore> TActionCorePtr;
}

#endif