o3de/Gems/LyShine/Code/Editor/PropertiesWidget.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */
#include "EditorCommon.h"
#include <AzToolsFramework/ToolsComponents/ScriptEditorComponent.h>
#include "CanvasHelpers.h"

#include <QBoxLayout>
#include <QScrollBar>

#define UICANVASEDITOR_PROPERTIES_UPDATE_DELAY_IN_MILLISECONDS  (100)

PropertiesWidget::PropertiesWidget(EditorWindow* editorWindow,
    QWidget* parent)
    : QWidget(parent)
    , AzToolsFramework::IPropertyEditorNotify()
    , m_editorWindow(editorWindow)
    , m_refreshTimer(this)
    , m_preValueChanges()
    , m_propertiesContainer(new PropertiesContainer(this, m_editorWindow))
{
    // PropertiesContainer.
    {
        QVBoxLayout* vbLayout = new QVBoxLayout();
        setLayout(vbLayout);

        vbLayout->setContentsMargins(4, 4, 4, 4);
        vbLayout->setSpacing(4);

        vbLayout->addWidget(m_propertiesContainer);
    }

    // Refresh timer.
    {
        QObject::connect(&m_refreshTimer,
            &QTimer::timeout,
            this,
            [ this ]()
            {
                Refresh(m_refreshLevel, (!m_componentTypeToRefresh.IsNull() ? &m_componentTypeToRefresh : nullptr));
            });

        m_refreshTimer.setInterval(UICANVASEDITOR_PROPERTIES_UPDATE_DELAY_IN_MILLISECONDS);

        m_refreshTimer.setSingleShot(true);
    }

    setMinimumWidth(330);

    ToolsApplicationEvents::Bus::Handler::BusConnect();
}

PropertiesWidget::~PropertiesWidget()
{
    ToolsApplicationEvents::Bus::Handler::BusDisconnect();
}

void PropertiesWidget::UserSelectionChanged(HierarchyItemRawPtrList* items)
{
    // Tell the properties container that the selection has changed but don't actually update
    // it. The refresh will do that.
    m_propertiesContainer->SelectionChanged(items);

    TriggerRefresh();
}

void PropertiesWidget::TriggerRefresh(AzToolsFramework::PropertyModificationRefreshLevel refreshLevel, const AZ::Uuid* componentType)
{
    if (!m_refreshTimer.isActive())
    {
        m_componentTypeToRefresh = componentType ? *componentType : AZ::Uuid::CreateNull();
        m_refreshLevel = refreshLevel;

        m_refreshTimer.start();
    }
    else
    {
        // Set component type to null if there are multiple component types due to refresh
        if (!componentType || m_componentTypeToRefresh != *componentType)
        {
            m_componentTypeToRefresh = AZ::Uuid::CreateNull();
        }

        if ((int)refreshLevel > m_refreshLevel)
        {
            m_refreshLevel = refreshLevel;
        }
    }
}

void PropertiesWidget::TriggerImmediateRefresh(AzToolsFramework::PropertyModificationRefreshLevel refreshLevel, const AZ::Uuid* componentType)
{
    TriggerRefresh(refreshLevel, componentType);

    m_refreshTimer.stop();

    Refresh(m_refreshLevel, (!m_componentTypeToRefresh.IsNull() ? &m_componentTypeToRefresh : nullptr));
}

void PropertiesWidget::SelectedEntityPointersChanged()
{
    m_propertiesContainer->SelectedEntityPointersChanged();
}

void PropertiesWidget::SetSelectedEntityDisplayNameWidget(QLineEdit * selectedEntityDisplayNameWidget)
{
    m_propertiesContainer->SetSelectedEntityDisplayNameWidget(selectedEntityDisplayNameWidget);
}

void PropertiesWidget::SetEditorOnlyCheckbox(QCheckBox* editorOnlyCheckbox)
{
    m_propertiesContainer->SetEditorOnlyCheckbox(editorOnlyCheckbox);
}

float PropertiesWidget::GetScrollValue()
{
    return m_propertiesContainer->verticalScrollBar() ? m_propertiesContainer->verticalScrollBar()->value() : 0.0f;
}

void PropertiesWidget::SetScrollValue(float scrollValue)
{
    if (m_propertiesContainer->verticalScrollBar())
    {
        m_propertiesContainer->verticalScrollBar()->setValue(aznumeric_cast<int>(scrollValue));
    }
}

AZ::Entity::ComponentArrayType PropertiesWidget::GetSelectedComponents()
{
    return m_propertiesContainer->GetSelectedComponents();
}

void PropertiesWidget::Refresh(AzToolsFramework::PropertyModificationRefreshLevel refreshLevel, const AZ::Uuid* componentType)
{
    m_propertiesContainer->Refresh(refreshLevel, componentType);
}

void PropertiesWidget::BeforePropertyModified([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode)
{
    if (m_propertiesContainer->IsCanvasSelected())
    {
        m_canvasUndoXml = CanvasHelpers::BeginUndoableCanvasChange(m_editorWindow->GetCanvas());
    }
    else
    {
        HierarchyClipboard::BeginUndoableEntitiesChange(m_editorWindow, m_preValueChanges);
    }
}

void PropertiesWidget::AfterPropertyModified([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode)
{
    if (m_propertiesContainer->IsCanvasSelected())
    {
        CanvasHelpers::EndUndoableCanvasChange(m_editorWindow, "canvas properties change", m_canvasUndoXml);
    }
    else
    {
        HierarchyClipboard::EndUndoableEntitiesChange(m_editorWindow, "properties change", m_preValueChanges);
        m_preValueChanges.clear();
    }

    // trigger the viewport window to refresh (it may be a long delay if it waits for an editor idle message)
    m_editorWindow->GetViewport()->Refresh();
}

void PropertiesWidget::SetPropertyEditingActive([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode)
{
}

void PropertiesWidget::SetPropertyEditingComplete([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode)
{
}

void PropertiesWidget::SealUndoStack()
{
}

void PropertiesWidget::RequestPropertyContextMenu(AzToolsFramework::InstanceDataNode* node, const QPoint& globalPos)
{
    m_propertiesContainer->RequestPropertyContextMenu(node, globalPos);
}

void PropertiesWidget::InvalidatePropertyDisplay([[maybe_unused]] AzToolsFramework::PropertyModificationRefreshLevel level)
{
    // This event is sent when the main editor's properties pane should refresh. We only care about script changes triggering
    // this event. In this case we want the UI Editor's properties pane to refresh and display any new script properties
    TriggerRefresh(AzToolsFramework::PropertyModificationRefreshLevel::Refresh_EntireTree, &AZ::AzTypeInfo<AzToolsFramework::Components::ScriptEditorComponent>::Uuid());
}

#include <moc_PropertiesWidget.cpp>