summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Palettes/Timeline/ToggleControl.cpp
blob: 7abc00d4bf16f1190d34e9721604abe29ac543b2 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/

#include "stdafx.h"

#include "ToggleControl.h"
#include "Renderer.h"
#include "StateRow.h"
#include "BlankControl.h"
#include "HotKeys.h"
#include "Bindings/ITimelineItemBinding.h"

CToggleControl::CToggleControl(CStateRow *inStateRow, ITimelineItemBinding *inTimelineItemBinding)
    : CBlankToggleControl(inStateRow)
    , m_TimelineItemBinding(inTimelineItemBinding)
{
    m_StateRow = inStateRow;
    long theLeftOffset = 4;

    m_Shy = new CToggleButton();
    m_Shy->SetName("ShyToggle");
    m_Shy->SetUpImage("Toggle-Empty.png");
    m_Shy->SetDownImage("Toggle-Shy.png");
    m_Shy->SetPosition(CPt(theLeftOffset, 0));
    CPt theShySize = m_Shy->GetSize();

    m_Visible = new CToggleButton();
    m_Visible->SetName("VisibilityToggle");
    m_Visible->SetUpImage("Toggle-Empty.png");
    m_Visible->SetDownImage("Toggle-HideShow.png");
    m_Visible->SetUpDisabledImage("Toggle-Empty.png"); // show empty if disabled
    m_Visible->SetDisabledImage("Toggle-HideShow-disabled.png");
    m_Visible->SetPosition(CPt(theShySize.x + 7, 0));
    CPt theVisibleSize = m_Visible->GetSize();

    m_Locked = new CToggleButton();
    m_Locked->SetName("LockToggle");
    m_Locked->SetUpImage("Toggle-Empty.png");
    m_Locked->SetDownImage("Toggle-Lock.png");
    m_Locked->SetPosition(CPt(theVisibleSize.x + theShySize.x + 10, 0));
    CPt theLockedSize = m_Locked->GetSize();

    AddChild(m_Shy);
    AddChild(m_Visible);
    AddChild(m_Locked);

    SetAbsoluteSize(CPt(theShySize.x + theVisibleSize.x + theLockedSize.x + 1, theShySize.y));

    // Button down listeners
    m_Shy->SigToggle.connect(std::bind(&CToggleControl::OnShyClicked, this,
                                       std::placeholders::_1, std::placeholders::_2));
    m_Visible->SigToggle.connect(std::bind(&CToggleControl::OnVisibleClicked, this,
                                           std::placeholders::_1, std::placeholders::_2));
    m_Locked->SigToggle.connect(std::bind(&CToggleControl::OnLockClicked, this,
                                          std::placeholders::_1, std::placeholders::_2));

    ITimelineItem *theTimelineItem = m_TimelineItemBinding->GetTimelineItem();
    // Initial toggle state of the eye visibility button
    // Note GetViewToggleOff==FALSE means visible
    m_Visible->SetToggleState(theTimelineItem->IsVisible());

    // Initial toggle state of the button
    m_Locked->SetToggleState(theTimelineItem->IsLocked());

    // Initial toggle state of the button
    m_Shy->SetToggleState(theTimelineItem->IsShy());

    // sk - if anything, this should be checked in the data model level, not here.
    // The tri-state (on, off, dim) of visibility depends on two bools:
    // GetViewToggleOff and IsEnabled. Ensure that any bogus 4th permutation
    // is detected ASAP
    //	ASSERT( !inStateRow->GetState( )->GetViewToggleOff( ) ||
    //		    !inStateRow->GetState( )->IsEnabled( ) );
}

CToggleControl::~CToggleControl()
{
    delete m_Shy;
    delete m_Visible;
    delete m_Locked;
}

//==============================================================================
/**
 * Handles clicking on the Shy button.  Toggles the shy state on the asset.  Shy
 * objects can be filtered out of the timeline.
 */
void CToggleControl::OnShyClicked(CToggleButton *, CToggleButton::EButtonState inButtonState)
{
    m_TimelineItemBinding->GetTimelineItem()->SetShy(inButtonState
                                                     == CToggleButton::EBUTTONSTATE_DOWN);

    m_StateRow->Filter(*m_StateRow->GetFilter());
    CBaseStateRow *theParentRow = m_StateRow->GetParentRow();
    if (theParentRow != nullptr)
        theParentRow->OnChildVisibilityChanged();
}

//==============================================================================
/**
 * Handles clicking on the Visible button.  Toggles the Visible state on the asset.
 */
void CToggleControl::OnVisibleClicked(CToggleButton *inButton,
                                      CToggleButton::EButtonState inButtonState)
{
    Q_UNUSED(inButton);

    m_TimelineItemBinding->GetTimelineItem()->SetVisible(inButtonState
                                                         == CToggleButton::EBUTTONSTATE_DOWN);
    m_StateRow->Filter(*m_StateRow->GetFilter());
}

//==============================================================================
/**
 * Handles clicking on the Lock button.  Toggles the Lock state on the asset.
 */
void CToggleControl::OnLockClicked(CToggleButton *inButton,
                                   CToggleButton::EButtonState inButtonState)
{
    Q_UNUSED(inButton);

    m_TimelineItemBinding->GetTimelineItem()->SetLocked(inButtonState
                                                        == CToggleButton::EBUTTONSTATE_DOWN);
    m_StateRow->Filter(*m_StateRow->GetFilter());
}

//==============================================================================
/**
 * Refreshes the state of this control accd to the asset state
 */
void CToggleControl::Refresh()
{
    CBlankToggleControl::Refresh();

    ITimelineItem *theTimelineItem = m_TimelineItemBinding->GetTimelineItem();
    m_Shy->SetToggleState(theTimelineItem->IsShy());
    m_Locked->SetToggleState(theTimelineItem->IsLocked());

    bool theEnabled = m_TimelineItemBinding->IsVisibleEnabled();
    m_Visible->SetEnabled(theEnabled);
    if (theEnabled) // only valid to update this if the enabled flag is true.
        m_Visible->SetToggleState(theTimelineItem->IsVisible());

    this->Invalidate();
}